VASSAL.build.module.DoActionButton

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, RecursionLimiter.Loopable

public class DoActionButton
extends AbstractConfigurable
implements RecursionLimiter.Loopable

This component places a button into the controls window toolbar. Pressing the button displays a message, plays a sound and/or sends hotkeys

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DoActionButton.HotkeyConfig`
`static class`	`DoActionButton.IconConfig`
`static class`	`DoActionButton.LoopConfig`
`static class`	`DoActionButton.LoopCountConfig`
`static class`	`DoActionButton.LoopTypeConfig`
`static class`	`DoActionButton.NamedHotkeyListConfigurer`
`static class`	`DoActionButton.ReportFormatConfig`
`static class`	`DoActionButton.SoundConfig`

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`	`DO_HOTKEY`
`static String`	`DO_LOOP`
`static String`	`DO_REPORT`
`static String`	`DO_SOUND`
`protected boolean`	`doHotkey`
`protected boolean`	`doLoop`
`protected boolean`	`doReport`
`protected boolean`	`doSound`
`protected boolean`	`hasIndex`
`static String`	`HOTKEY`
`protected List<NamedKeyStroke>`	`hotkeys`
`static String`	`HOTKEYS`
`static String`	`ICON`
`static String`	`INDEX`
`static String`	`INDEX_PROPERTY`
`static String`	`INDEX_START`
`static String`	`INDEX_STEP`
`protected String`	`indexProperty`
`protected int`	`indexStart`
`protected int`	`indexStep`
`protected int`	`indexValue`
`protected LaunchButton`	`launch`
`static String`	`LOOP_COUNT`
`static String`	`LOOP_TYPE`
`protected FormattedString`	`loopCount`
`protected MutableProperty.Impl`	`loopIndexProperty`
`protected boolean`	`loopPropertyRegistered`
`protected String`	`loopType`
`static String`	`NAME`
`static String`	`POST_LOOP_HOTKEY`
`protected NamedKeyStroke`	`postLoopKey`
`static String`	`PRE_LOOP_HOTKEY`
`protected NamedKeyStroke`	`preLoopKey`
`static String`	`REPORT_FORMAT`
`protected FormattedString`	`reportFormat`
`static String`	`SOUND_CLIP`
`protected String`	`soundClip`
`static String`	`TOOLTIP`
`static String`	`UNTIL_EXPRESSION`
`protected PropertyExpression`	`untilExpression`
`static String`	`WHILE_EXPRESSION`
`protected PropertyExpression`	`whileExpression`

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

DoActionButton()

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable parent)`	Adds this component to its parent.
`protected List<NamedKeyStroke>`	`decodeHotkeys(String s)`
`protected void`	`doActions()`
`protected void`	`doHotKey(Command c, NamedKeyStroke key)`
`protected String`	`encodeHotkeys()`
`protected void`	`executeActions(Command command)`	Execute the set of actions that make up this button and return the set of Commands generated.
`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.
`VisibilityCondition`	`getAttributeVisibility(String name)`	By default, all attributes are visible
`protected Component`	`getComponent()`	The component to be added to the control window toolbar
`String`	`getComponentName()`
`String`	`getComponentTypeName()`
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`List<String>`	`getPropertyNames()`	Implement PropertyNameSource - Expose loop index property if looping turned on
`void`	`removeFrom(Buildable b)`	Remove this component from its parent
`void`	`setAttribute(String key, Object o)`	Sets an attribute value for this component.
`protected void`	`setIndexPropertyValue()`
`protected void`	`updateLoopPropertyRegistration()`	Register/Deregister the Global Property exposing the index property.

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, 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
- BUTTON_TEXT
  
  public static final String BUTTON_TEXT
  
  See Also:
  
  Constant Field Values
- TOOLTIP
  
  public static final String TOOLTIP
  
  See Also:
  
  Constant Field Values
- NAME
  
  public static final String NAME
  
  See Also:
  
  Constant Field Values
- HOTKEY
  
  public static final String HOTKEY
  
  See Also:
  
  Constant Field Values
- ICON
  
  public static final String ICON
  
  See Also:
  
  Constant Field Values
- DO_REPORT
  
  public static final String DO_REPORT
  
  See Also:
  
  Constant Field Values
- REPORT_FORMAT
  
  public static final String REPORT_FORMAT
  
  See Also:
  
  Constant Field Values
- DO_SOUND
  
  public static final String DO_SOUND
  
  See Also:
  
  Constant Field Values
- SOUND_CLIP
  
  public static final String SOUND_CLIP
  
  See Also:
  
  Constant Field Values
- DO_HOTKEY
  
  public static final String DO_HOTKEY
  
  See Also:
  
  Constant Field Values
- HOTKEYS
  
  public static final String HOTKEYS
  
  See Also:
  
  Constant Field Values
- DO_LOOP
  
  public static final String DO_LOOP
  
  See Also:
  
  Constant Field Values
- LOOP_TYPE
  
  public static final String LOOP_TYPE
  
  See Also:
  
  Constant Field Values
- LOOP_COUNT
  
  public static final String LOOP_COUNT
  
  See Also:
  
  Constant Field Values
- WHILE_EXPRESSION
  
  public static final String WHILE_EXPRESSION
  
  See Also:
  
  Constant Field Values
- UNTIL_EXPRESSION
  
  public static final String UNTIL_EXPRESSION
  
  See Also:
  
  Constant Field Values
- PRE_LOOP_HOTKEY
  
  public static final String PRE_LOOP_HOTKEY
  
  See Also:
  
  Constant Field Values
- POST_LOOP_HOTKEY
  
  public static final String POST_LOOP_HOTKEY
  
  See Also:
  
  Constant Field Values
- INDEX
  
  public static final String INDEX
  
  See Also:
  
  Constant Field Values
- INDEX_PROPERTY
  
  public static final String INDEX_PROPERTY
  
  See Also:
  
  Constant Field Values
- INDEX_START
  
  public static final String INDEX_START
  
  See Also:
  
  Constant Field Values
- INDEX_STEP
  
  public static final String INDEX_STEP
  
  See Also:
  
  Constant Field Values
- launch
  
  protected LaunchButton launch
- doReport
  
  protected boolean doReport
- reportFormat
  
  protected FormattedString reportFormat
- doSound
  
  protected boolean doSound
- soundClip
  
  protected String soundClip
- doHotkey
  
  protected boolean doHotkey
- hotkeys
  
  protected List<NamedKeyStroke> hotkeys
- doLoop
  
  protected boolean doLoop
- loopType
  
  protected String loopType
- loopCount
  
  protected FormattedString loopCount
- whileExpression
  
  protected PropertyExpression whileExpression
- untilExpression
  
  protected PropertyExpression untilExpression
- preLoopKey
  
  protected NamedKeyStroke preLoopKey
- postLoopKey
  
  protected NamedKeyStroke postLoopKey
- hasIndex
  
  protected boolean hasIndex
- indexProperty
  
  protected String indexProperty
- indexStart
  
  protected int indexStart
- indexStep
  
  protected int indexStep
- indexValue
  
  protected int indexValue
- loopIndexProperty
  
  protected MutableProperty.Impl loopIndexProperty
- loopPropertyRegistered
  
  protected boolean loopPropertyRegistered
Constructor Details
- DoActionButton
  
  public DoActionButton()
Method Details
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- 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
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- 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
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- 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
- getComponent
  
  protected Component getComponent()
  
  The component to be added to the control window toolbar
- setAttribute
  
  public void setAttribute(String key, Object o)
  
  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
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  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
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed 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
  
  Returns:
  
  null if the attribute controls should always be visible;
- encodeHotkeys
  
  protected String encodeHotkeys()
- decodeHotkeys
  
  protected List<NamedKeyStroke> decodeHotkeys(String s)
- 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
- removeFrom
  
  public void removeFrom(Buildable b)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- updateLoopPropertyRegistration
  
  protected void updateLoopPropertyRegistration()
  
  Register/Deregister the Global Property exposing the index property. It is only visible if looping is turned on and an Index Property is specified
- setIndexPropertyValue
  
  protected void setIndexPropertyValue()
- doActions
  
  protected void doActions() throws RecursionLimitException
  
  Throws:
  
  RecursionLimitException
- executeActions
  
  protected void executeActions(Command command) throws RecursionLimitException
  
  Execute the set of actions that make up this button and return the set of Commands generated.
  
  Parameters:
  
  command -
  
  Throws:
  
  RecursionLimitException
- doHotKey
  
  protected void doHotKey(Command c, NamedKeyStroke key)
- getComponentTypeName
  
  public String getComponentTypeName()
  
  Specified by:
  
  getComponentTypeName in interface RecursionLimiter.Loopable
- getComponentName
  
  public String getComponentName()
  
  Specified by:
  
  getComponentName in interface RecursionLimiter.Loopable
- getPropertyNames
  
  public List<String> getPropertyNames()
  
  Implement PropertyNameSource - Expose loop index property if looping turned on
  
  Specified by:
  
  getPropertyNames in interface PropertyNameSource
  
  Overrides:
  
  getPropertyNames in class AbstractBuildable

Class DoActionButton