Package VASSAL.build.module

Class DoActionButton

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.DoActionButton

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable

public class DoActionButton
extends AbstractToolbarItem
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	Deprecated, for removal: This API element is subject to removal in a future version.
static class	DoActionButton.LoopConfig
static class	DoActionButton.LoopCountConfig
static class	DoActionButton.LoopTypeConfig
static class	DoActionButton.NamedHotkeyListConfigurer	Deprecated, for removal: This API element is subject to removal in a future version. not replaced
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	Deprecated, for removal: This API element is subject to removal in a future version.
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	Deprecated, for removal: This API element is subject to removal in a future version.
protected List<NamedKeyStroke>	hotkeys
static String	HOTKEYS
static String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
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	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
static String	LOOP_COUNT
static String	LOOP_TYPE
protected FormattedString	loopCount
protected MutableProperty.Impl	loopIndexProperty
protected boolean	loopPropertyRegistered
protected String	loopType
static String	NAME	Deprecated, for removal: This API element is subject to removal in a future version.
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	Deprecated, for removal: This API element is subject to removal in a future version.
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	addLocalImageNames(Collection<String> s)	In case reports use HTML and refer to any image files
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()
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
String	getComponentName()
String	getComponentTypeName()
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
List<String>	getPropertyNames()	Implement PropertyNameSource - Expose loop index property if looping turned on
void	setAttribute(String key, Object o)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
protected void	setIndexPropertyValue()
protected void	updateLoopPropertyRegistration()	Register/Deregister the Global Property exposing the index property.

Methods inherited from class VASSAL.build.AbstractToolbarItem

addTo, getComponent, getLaunchButton, getMenuTextList, makeLaunchButton, removeFrom, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setTooltipKey

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

addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, 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

Field Details

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

BUTTON_TEXT

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_TEXT

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

See Also:

Constant Field Values

TOOLTIP

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String TOOLTIP

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

See Also:

Constant Field Values

NAME

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String NAME

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

See Also:

Constant Field Values

HOTKEY

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String HOTKEY

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

See Also:

Constant Field Values

ICON

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String ICON

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

See Also:

Constant Field Values

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

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

Description copied from class: AbstractToolbarItem

This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeNames(), key1, ..., keyN), or supply their own order from scratch.

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 AbstractToolbarItem

Returns:

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

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from class: AbstractToolbarItem

This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeDescriptions(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class AbstractToolbarItem

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 class: AbstractToolbarItem

This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeTypes(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class AbstractToolbarItem

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

setAttribute

public void setAttribute(String key,
 Object o)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button. Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractToolbarItem.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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 AbstractToolbarItem

Parameters:

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

o - If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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 class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class AbstractToolbarItem

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractToolbarItem.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 AbstractToolbarItem.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

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.

encodeHotkeys

protected String encodeHotkeys()

decodeHotkeys

protected List<NamedKeyStroke> decodeHotkeys(String s)

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile 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 - command to execute

Throws:

RecursionLimitException - recursion protection

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

Returns:

Default implementation of PropertyNameSource - No properties exposed

getExpressionList

public List<String> getExpressionList()

Description copied from class: AbstractConfigurable

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class AbstractConfigurable

Returns:

a list of the Configurables string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

Description copied from class: AbstractConfigurable

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)

getPropertyList

public List<String> getPropertyList()

Description copied from class: AbstractConfigurable

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractConfigurable

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

Description copied from class: AbstractConfigurable

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractToolbarItem

Returns:

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

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

In case reports use HTML and refer to any image files

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractToolbarItem

Parameters:

s - Collection to add image names to