Package VASSAL.build.module.turn

Class CounterTurnLevel

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.turn.TurnComponent

VASSAL.build.module.turn.TurnLevel

VASSAL.build.module.turn.CounterTurnLevel

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class CounterTurnLevel
extends TurnLevel

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.module.turn.TurnLevel

TurnLevel.TurnFormatConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected int	incr
protected static final String	INCR
protected boolean	loop
protected static final String	LOOP
protected static final String	LOOP_LIMIT
protected int	loopLimit
protected static final String	START

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

childSetControls, current, currentSubLevel, LEVEL_VALUE, levelSetControls, myValue, NAME, parent, PROP, propertyName, rolledOver, setDialog, start, subLevelRolledOver, turn, TURN_FORMAT, turnFormat

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

description, DESCRIPTION, 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
CounterTurnLevel()

Method Summary

Modifier and Type	Method	Description
protected void	advance()
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
static String	getConfigureTypeName()
HelpFile	getHelpFile()
protected String	getLongestValueName()
protected Component	getSetControl()
protected String	getState()
protected String	getValueString()
protected void	reset()
protected void	retreat()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
protected void	setHigh()
protected void	setLow()
protected void	setState(String code)

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

addChildControls, addTo, buildConfigMenu, findMaximumStrings, getActiveChildLevels, getAllowableConfigureComponents, getConfigMenu, getFormattedStringList, getI18nData, getLongestFormattedValue, getPropertyList, getPropertyNames, getSetControls, getTurn, getTurnString, hasRolledOver, hasSubLevelRolledOver, isActive, isConfigurable, removeFrom, setRolledOver

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

addLevel, getDescription, getTurnLevel, getTurnLevelCount, getTurnLevels, removeLevel

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, 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.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

START

protected static final String START

See Also:

• Constant Field Values

INCR

protected static final String INCR

See Also:

• Constant Field Values

LOOP

protected static final String LOOP

See Also:

• Constant Field Values

LOOP_LIMIT

protected static final String LOOP_LIMIT

See Also:

• Constant Field Values

incr

protected int incr

loop

protected boolean loop

loopLimit

protected int loopLimit

Constructor Details

CounterTurnLevel

public CounterTurnLevel()

Method Details

reset

protected void reset()

Overrides:

reset in class TurnLevel

setLow

protected void setLow()

Overrides:

setLow in class TurnLevel

setHigh

protected void setHigh()

Overrides:

setHigh in class TurnLevel

getState

protected String getState()

Specified by:

getState in class TurnLevel

setState

protected void setState(String code)

Specified by:

setState in class TurnLevel

getValueString

protected String getValueString()

Specified by:

getValueString in class TurnLevel

getLongestValueName

protected String getLongestValueName()

Specified by:

getLongestValueName in class TurnLevel

advance

protected void advance()

Overrides:

advance in class TurnLevel

retreat

protected void retreat()

Overrides:

retreat in class TurnLevel

getSetControl

protected Component getSetControl()

Specified by:

getSetControl in class TurnLevel

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 TurnLevel

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 TurnLevel

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()

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 TurnLevel

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 TurnLevel

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()

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 TurnLevel

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.

getConfigureTypeName

public static String getConfigureTypeName()

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

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.