VASSAL.build.module.turn.TurnLevel

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

Direct Known Subclasses:: CounterTurnLevel, ListTurnLevel

public abstract class TurnLevel
extends TurnComponent

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class TurnLevel.TurnFormatConfig

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

Field Summary

Fields
Modifier and Type	Field	Description
`protected Component`	`childSetControls`
`protected int`	`current`
`protected int`	`currentSubLevel`
`protected static String`	`LEVEL_VALUE`
`protected JPanel`	`levelSetControls`
`protected MutableProperty.Impl`	`myValue`
`protected static String`	`NAME`
`protected TurnComponent`	`parent`
`protected static String`	`PROP`
`protected String`	`propertyName`
`protected boolean`	`rolledOver`
`protected JDialog`	`setDialog`
`protected int`	`start`
`protected boolean`	`subLevelRolledOver`
`protected TurnTracker`	`turn`
`protected static String`	`TURN_FORMAT`
`protected FormattedString`	`turnFormat`

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

TurnLevel()

Method Summary

Modifier and Type	Method	Description
`protected void`	`addChildControls()`
`void`	`addTo(Buildable parent)`	Adds this component to its parent.
`protected void`	`advance()`
`protected void`	`buildConfigMenu(JMenu menu)`
`void`	`findMaximumStrings(List<String> levels, int currentLevel)`
`List<TurnLevel>`	`getActiveChildLevels()`
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String key)`	Return a String representation of the attribute with the given name.
`protected JMenu`	`getConfigMenu()`
`ComponentI18nData`	`getI18nData()`	Return the i18n data for this component
`protected String`	`getLongestFormattedValue()`
`protected abstract String`	`getLongestValueName()`
`List<String>`	`getPropertyNames()`	Implement PropertyNameSource - Expose the name of this level property
`protected abstract Component`	`getSetControl()`
`protected Component`	`getSetControls(JDialog dialog, TurnTracker turn)`
`protected abstract String`	`getState()`
`protected TurnTracker`	`getTurn()`
`String`	`getTurnString()`
`protected abstract String`	`getValueString()`
`protected boolean`	`hasRolledOver()`
`protected boolean`	`hasSubLevelRolledOver()`
`protected boolean`	`isActive()`
`boolean`	`isConfigurable()`
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`protected void`	`reset()`
`protected void`	`retreat()`
`void`	`setAttribute(String key, Object value)`	Sets an attribute value for this component.
`protected void`	`setHigh()`
`protected void`	`setLow()`
`protected void`	`setRolledOver(boolean b)`
`protected abstract void`	`setState(String code)`

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

addLevel, getHelpFile, getTurnLevel, getTurnLevelCount, getTurnLevels, removeLevel

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

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

Field Details
- NAME
  
  protected static final String NAME
  
  See Also:
  
  Constant Field Values
- PROP
  
  protected static final String PROP
  
  See Also:
  
  Constant Field Values
- TURN_FORMAT
  
  protected static final String TURN_FORMAT
  
  See Also:
  
  Constant Field Values
- LEVEL_VALUE
  
  protected static final String LEVEL_VALUE
  
  See Also:
  
  Constant Field Values
- turn
  
  protected TurnTracker turn
- setDialog
  
  protected JDialog setDialog
- levelSetControls
  
  protected JPanel levelSetControls
- childSetControls
  
  protected Component childSetControls
- parent
  
  protected TurnComponent parent
- propertyName
  
  protected String propertyName
- start
  
  protected int start
- current
  
  protected int current
- currentSubLevel
  
  protected int currentSubLevel
- subLevelRolledOver
  
  protected boolean subLevelRolledOver
- rolledOver
  
  protected boolean rolledOver
- myValue
  
  protected MutableProperty.Impl myValue
- turnFormat
  
  protected FormattedString turnFormat
Constructor Details
- TurnLevel
  
  public TurnLevel()
Method Details
- getState
  
  protected abstract String getState()
- setState
  
  protected abstract void setState(String code)
- getValueString
  
  protected abstract String getValueString()
- getLongestValueName
  
  protected abstract String getLongestValueName()
- getSetControl
  
  protected abstract Component getSetControl()
- findMaximumStrings
  
  public void findMaximumStrings(List<String> levels, int currentLevel)
- getLongestFormattedValue
  
  protected String getLongestFormattedValue()
- hasSubLevelRolledOver
  
  protected boolean hasSubLevelRolledOver()
- isActive
  
  protected boolean isActive()
- reset
  
  protected void reset()
- advance
  
  protected void advance()
- retreat
  
  protected void retreat()
- getTurnString
  
  public String getTurnString()
- getActiveChildLevels
  
  public List<TurnLevel> getActiveChildLevels()
- buildConfigMenu
  
  protected void buildConfigMenu(JMenu menu)
- getConfigMenu
  
  protected JMenu getConfigMenu()
- isConfigurable
  
  public boolean isConfigurable()
- getSetControls
  
  protected Component getSetControls(JDialog dialog, TurnTracker turn)
- addChildControls
  
  protected void addChildControls()
- getTurn
  
  protected TurnTracker getTurn()
- setRolledOver
  
  protected void setRolledOver(boolean b)
- hasRolledOver
  
  protected boolean hasRolledOver()
- setLow
  
  protected void setLow()
- setHigh
  
  protected void setHigh()
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from class: AbstractConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Overrides:
  
  getAttributeDescriptions in class TurnComponent
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Overrides:
  
  getAttributeTypes in class TurnComponent
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Overrides:
  
  getAttributeNames in class TurnComponent
  
  Returns:
  
  a list of all attribute names for this component
- setAttribute
  
  public void setAttribute(String key, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets an 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()
- getAttributeValueString
  
  public String getAttributeValueString(String key)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  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()
- addTo
  
  public void addTo(Buildable parent)
  
  Description copied from interface: Buildable
  
  Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible 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
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
  
  Overrides:
  
  removeFrom in class TurnComponent
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return 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 Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
  
  Overrides:
  
  getAllowableConfigureComponents in class TurnComponent
- getI18nData
  
  public ComponentI18nData getI18nData()
  
  Description copied from class: AbstractConfigurable
  
  Return the i18n data for this component
  
  Specified by:
  
  getI18nData in interface Translatable
  
  Overrides:
  
  getI18nData in class AbstractConfigurable
- getPropertyNames
  
  public List<String> getPropertyNames()
  
  Implement PropertyNameSource - Expose the name of this level property
  
  Specified by:
  
  getPropertyNames in interface PropertyNameSource
  
  Overrides:
  
  getPropertyNames in class AbstractBuildable

Class TurnLevel

Nested Class Summary

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