VASSAL.build.module.turn.ListTurnLevel

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

public class ListTurnLevel
extends TurnLevel
implements ActionListener

Nested Class Summary

Nested Classes

Modifier and Type Class Description

protected class ListTurnLevel.ConfigDialog

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 boolean[]`	`active`
`protected static String`	`CONFIG_FIRST`
`protected static String`	`CONFIG_LIST`
`protected JDialog`	`configDialog`
`protected boolean`	`configFirst`
`protected boolean`	`configList`
`protected int`	`first`
`protected String[]`	`list`
`protected static String`	`LIST`
`protected String`	`prompt`
`protected static String`	`PROMPT`
`protected Component`	`setControls`

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

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

ListTurnLevel()

Method Summary

Modifier and Type	Method	Description
`void`	`actionPerformed(ActionEvent arg0)`
`protected void`	`advance()`
`protected void`	`buildConfigMenu(JMenu configMenu)`
`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.
`VisibilityCondition`	`getAttributeVisibility(String name)`	By default, all attributes are visible
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`ComponentI18nData`	`getI18nData()`	Return the i18n data for this component
`protected String`	`getLongestValueName()`
`protected Component`	`getSetControl()`
`protected String`	`getState()`
`protected String`	`getValueString()`
`protected boolean`	`isActive()`
`boolean`	`isConfigurable()`
`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`	`setState(String code)`

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

addChildControls, addTo, findMaximumStrings, getActiveChildLevels, getAllowableConfigureComponents, getConfigMenu, getLongestFormattedValue, getPropertyNames, getSetControls, getTurn, getTurnString, hasRolledOver, hasSubLevelRolledOver, removeFrom, setRolledOver

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, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, 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
- LIST
  
  protected static final String LIST
  
  See Also:
  
  Constant Field Values
- CONFIG_LIST
  
  protected static final String CONFIG_LIST
  
  See Also:
  
  Constant Field Values
- CONFIG_FIRST
  
  protected static final String CONFIG_FIRST
  
  See Also:
  
  Constant Field Values
- PROMPT
  
  protected static final String PROMPT
  
  See Also:
  
  Constant Field Values
- first
  
  protected int first
- list
  
  protected String[] list
- active
  
  protected boolean[] active
- configList
  
  protected boolean configList
- configFirst
  
  protected boolean configFirst
- prompt
  
  protected String prompt
- configDialog
  
  protected JDialog configDialog
- setControls
  
  protected Component setControls
Constructor Details
- ListTurnLevel
  
  public ListTurnLevel()
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
- isActive
  
  protected boolean isActive()
  
  Overrides:
  
  isActive in class TurnLevel
- buildConfigMenu
  
  protected void buildConfigMenu(JMenu configMenu)
  
  Overrides:
  
  buildConfigMenu in class TurnLevel
- actionPerformed
  
  public void actionPerformed(ActionEvent arg0)
  
  Specified by:
  
  actionPerformed in interface ActionListener
- getSetControl
  
  protected Component getSetControl()
  
  Specified by:
  
  getSetControl in class TurnLevel
- 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 TurnLevel
- 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 TurnLevel
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Overrides:
  
  getAttributeNames in class TurnLevel
  
  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 TurnLevel
  
  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 TurnLevel
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Overrides:
  
  getHelpFile in class TurnComponent
  
  Returns:
  
  a HelpFilte 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
  
  Returns:
  
  null if the attribute controls should always be visible;
- isConfigurable
  
  public boolean isConfigurable()
  
  Overrides:
  
  isConfigurable in class TurnLevel
- 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 TurnLevel

Class ListTurnLevel

Nested Class Summary

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

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