Package VASSAL.build.module.turn

Class TurnTracker

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.turn.TurnComponent

VASSAL.build.module.turn.TurnTracker

All Implemented Interfaces:

ActionListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, CommandEncoder, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable, UniqueIdManager.Identifyable

public class TurnTracker
extends TurnComponent
implements CommandEncoder, GameComponent, ActionListener, UniqueIdManager.Identifyable, RecursionLimiter.Loopable

Generic Turn Counter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TurnTracker.IconConfig
static class	TurnTracker.LengthStyleConfig
static class	TurnTracker.ReportFormatConfig
protected class	TurnTracker.SetDialog
static class	TurnTracker.SetTurn
static class	TurnTracker.TurnFormatConfig
protected class	TurnTracker.TurnWidget
protected class	TurnTracker.TurnWindow

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUTTON_TEXT
static String	BUTTON_TOOLTIP
protected static String	COMMAND_PREFIX
protected int	currentLevel
protected static String	DOCK_COMMAND
protected static String	DOCKED
protected static String	FONT_BOLD
protected static String	FONT_SIZE
static String	HOT_KEY
static String	ICON
protected String	id
protected static UniqueIdManager	idMgr
protected MutableProperty.Impl	lastCommand
protected MutableProperty.Impl	lastTurn
protected LaunchButton	launch
protected JPanel	launchWidget
static String	LENGTH
protected static String	LENGTH_FIXED
protected static String	LENGTH_MAXIMUM
static String	LENGTH_STYLE
protected static String	LENGTH_VARIABLE
protected String	lengthStyle
protected static String	LEVEL
static String	NAME
protected static String	NEW_TURN
protected static String	NEXT
static String	NEXT_HOT_KEY
protected NamedKeyStrokeListener	nextListener
protected static String	OLD_TURN	Variable name for reporting format
protected JPopupMenu	popup
protected static String	PREV
static String	PREV_HOT_KEY
protected NamedKeyStrokeListener	prevListener
protected static String	PROP_COMMAND
protected static String	PROP_VALUE
static String	REPORT_FORMAT
protected FormattedString	reportFormat
protected String	savedSetState
protected String	savedState
protected String	savedTurn
protected static String	SET
protected static String	SET_COMMAND
protected TurnTracker.SetDialog	setDialog
static String	TOOLTIP
protected static String	TURN_FONT
static String	TURN_FORMAT
protected FormattedString	turnFormat
protected TurnTracker.TurnWidget	turnWidget
protected TurnTracker.TurnWindow	turnWindow
protected static String	UNDOCK_COMMAND
protected int	width

Fields inherited from class VASSAL.build.module.turn.TurnComponent

levels

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TurnTracker()

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
protected void	addItem(JMenu menu, String command)
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
void	addTo(Buildable b)	Adds this component to its parent.
protected void	buildPopup()
protected void	cancelSet()
protected void	captureState()
protected void	clearGlobalProperties()
Command	decode(String command)	Translate a String into a Command
protected void	doGlobalkeys()
String	encode(Command c)	Translate a Command into a String
protected List<TurnLevel>	getActiveChildLevels()	A list of all active TurnLevels within the TurnTracker
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
String	getComponentName()
String	getComponentTypeName()
static String	getConfigureTypeName()
protected Font	getDisplayFont()
protected int	getFontSize()
protected int	getFontStyle()
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
String	getId()
protected int	getLevelCount()
protected String	getMaximumTurnString()	Calculate the maximum sized turn string that can be generated by any turn combination.
protected int	getMaximumWidth()	Calculate the maximum width for the turnWidget to display any item.
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
String	getState()
protected String	getTurnString()	Build the turn string to be displayed from the currently active Child TurnLevel's
protected boolean	isDocked()
protected void	next()
protected void	prev()
void	removeFrom(Buildable b)	Remove this component from its parent
void	replace(StringBuffer s, String from, String to)	Deprecated, for removal: This API element is subject to removal in a future version. Use replace(StringBuilder,String,String) instead.
void	replace(StringBuilder s, String from, String to)
protected void	reset()
protected void	save()
protected void	saveSet()
protected void	set()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
protected void	setDisplayFont()
protected void	setDocked(boolean dock)
protected void	setFontSize()
void	setId(String id)
protected void	setLaunchToolTip()
void	setState(String newState)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
protected void	setWidgetWidth()
String	updateString(String str, String[] from, String[] to)
protected void	updateTurnDisplay(String command)

Methods inherited from class VASSAL.build.module.turn.TurnComponent

addLevel, getTurnLevel, getTurnLevelCount, getTurnLevels, removeLevel

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getPropertyList, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details

idMgr

protected static final UniqueIdManager idMgr

COMMAND_PREFIX

protected static final String COMMAND_PREFIX

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

HOT_KEY

public static final String HOT_KEY

See Also:

Constant Field Values

NEXT_HOT_KEY

public static final String NEXT_HOT_KEY

See Also:

Constant Field Values

PREV_HOT_KEY

public static final String PREV_HOT_KEY

See Also:

Constant Field Values

ICON

public static final String ICON

See Also:

Constant Field Values

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

Constant Field Values

BUTTON_TOOLTIP

public static final String BUTTON_TOOLTIP

See Also:

Constant Field Values

TURN_FORMAT

public static final String TURN_FORMAT

See Also:

Constant Field Values

REPORT_FORMAT

public static final String REPORT_FORMAT

See Also:

Constant Field Values

TOOLTIP

public static final String TOOLTIP

See Also:

Constant Field Values

LENGTH

public static final String LENGTH

See Also:

Constant Field Values

LENGTH_STYLE

public static final String LENGTH_STYLE

See Also:

Constant Field Values

FONT_SIZE

protected static final String FONT_SIZE

See Also:

Constant Field Values

FONT_BOLD

protected static final String FONT_BOLD

See Also:

Constant Field Values

DOCKED

protected static final String DOCKED

See Also:

Constant Field Values

OLD_TURN

protected static final String OLD_TURN

Variable name for reporting format

See Also:

Constant Field Values

NEW_TURN

protected static final String NEW_TURN

See Also:

Constant Field Values

LEVEL

protected static final String LEVEL

See Also:

Constant Field Values

TURN_FONT

protected static final String TURN_FONT

See Also:

Constant Field Values

SET_COMMAND

protected static String SET_COMMAND

DOCK_COMMAND

protected static String DOCK_COMMAND

UNDOCK_COMMAND

protected static String UNDOCK_COMMAND

NEXT

protected static final String NEXT

See Also:

Constant Field Values

PREV

protected static final String PREV

See Also:

Constant Field Values

SET

protected static final String SET

See Also:

Constant Field Values

PROP_VALUE

protected static final String PROP_VALUE

See Also:

Constant Field Values

PROP_COMMAND

protected static final String PROP_COMMAND

See Also:

Constant Field Values

LENGTH_VARIABLE

protected static final String LENGTH_VARIABLE

See Also:

Constant Field Values

LENGTH_MAXIMUM

protected static final String LENGTH_MAXIMUM

See Also:

Constant Field Values

LENGTH_FIXED

protected static final String LENGTH_FIXED

See Also:

Constant Field Values

turnFormat

protected FormattedString turnFormat

reportFormat

protected FormattedString reportFormat

turnWindow

protected TurnTracker.TurnWindow turnWindow

turnWidget

protected TurnTracker.TurnWidget turnWidget

launchWidget

protected JPanel launchWidget

setDialog

protected TurnTracker.SetDialog setDialog

launch

protected LaunchButton launch

nextListener

protected NamedKeyStrokeListener nextListener

prevListener

protected NamedKeyStrokeListener prevListener

savedState

protected String savedState

savedSetState

protected String savedSetState

savedTurn

protected String savedTurn

popup

protected JPopupMenu popup

currentLevel

protected int currentLevel

id

protected String id

width

protected int width

lengthStyle

protected String lengthStyle

lastCommand

protected MutableProperty.Impl lastCommand

lastTurn

protected MutableProperty.Impl lastTurn

Constructor Details

TurnTracker

public TurnTracker()

Method Details

getState

public String getState()

setState

public void setState(String newState)

setLaunchToolTip

protected void setLaunchToolTip()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Overrides:

getAttributeNames in class TurnComponent

Returns:

a list of all buildFile (XML) attribute names for this component

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Overrides:

setAttribute in class TurnComponent

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

setWidgetWidth

protected void setWidgetWidth()

getMaximumWidth

protected int getMaximumWidth()

Calculate the maximum width for the turnWidget to display any item. First calculate the maximum string that can be displayed, then convert this to a width based on the display font.

Returns:

Maximum Width

setDisplayFont

protected void setDisplayFont()

getDisplayFont

protected Font getDisplayFont()

setFontSize

protected void setFontSize()

getFontSize

protected int getFontSize()

getFontStyle

protected int getFontStyle()

isDocked

protected boolean isDocked()

setDocked

protected void setDocked(boolean dock)

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class TurnComponent

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class TurnComponent

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class TurnComponent

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Overrides:

getAllowableConfigureComponents in class TurnComponent

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getConfigureTypeName

public static String getConfigureTypeName()

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Overrides:

addTo in class TurnComponent

Parameters:

b - parent Buildable to add this component to as a subcomponent.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class TurnComponent

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class TurnComponent

Returns:

a HelpFile describing how to use and configure * this component

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

captureState

protected void captureState()

save

protected void save()

getMaximumTurnString

protected String getMaximumTurnString()

Calculate the maximum sized turn string that can be generated by any turn combination.

Returns:

maximum turn string

getTurnString

protected String getTurnString()

Build the turn string to be displayed from the currently active Child TurnLevel's

Returns:

Turn String

getActiveChildLevels

protected List<TurnLevel> getActiveChildLevels()

A list of all active TurnLevels within the TurnTracker

Returns:

List of Turn levels

getLevelCount

protected int getLevelCount()

next

protected void next()

prev

protected void prev()

doGlobalkeys

protected void doGlobalkeys()

getComponentTypeName

public String getComponentTypeName()

Specified by:

getComponentTypeName in interface RecursionLimiter.Loopable

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface RecursionLimiter.Loopable

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

set

protected void set()

updateTurnDisplay

protected void updateTurnDisplay(String command)

clearGlobalProperties

protected void clearGlobalProperties()

decode

public Command decode(String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

reset

protected void reset()

updateString

public String updateString(String str,
 String[] from,
 String[] to)

replace

public void replace(StringBuilder s,
 String from,
 String to)

replace

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void replace(StringBuffer s,
 String from,
 String to)

Deprecated, for removal: This API element is subject to removal in a future version.

Use replace(StringBuilder,String,String) instead.

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

buildPopup

protected void buildPopup()

addItem

protected void addItem(JMenu menu,
 String command)

cancelSet

protected void cancelSet()

saveSet

protected void saveSet()

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class AbstractConfigurable

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the Configurable, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractConfigurable

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

Description copied from class: AbstractImageFinder

Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to