Package VASSAL.build.module.map.deck

Class DeckSendKeyCommand

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.deck.AbstractDeckKeyCommand

VASSAL.build.module.map.deck.DeckSendKeyCommand

All Implemented Interfaces:

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

public class DeckSendKeyCommand
extends AbstractDeckKeyCommand

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.module.map.deck.AbstractDeckKeyCommand

AbstractDeckKeyCommand.DeckReportFormatConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLY_ON_MOVE
static final String	DECK_EXPRESSION
static final String	LIMIT_EXPRESSION
static final String	LIMIT_TOTAL
static final String	MATCH_EXPRESSION
static final String	ORDER
static final String	SEND_MATCHING
static final String	SENT_COUNT
static final String	STOP
static final String	STOP_EXPRESSION
static final String	STOP_INCLUDE
static final String	TARGET_DECK
static final String	VARIABLE_DECK

Fields inherited from class VASSAL.build.module.map.deck.AbstractDeckKeyCommand

COMMAND_NAME, DECK_NAME, description, DESCRIPTION, HOTKEY, keyStroke, MENU_TEXT, REPORT_FORMAT, reportFormat

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

Method Summary

Modifier and Type	Method	Description
void	deregisterListeners()	Remove any Listener previously registered for this DeckKeyCommand
String[]	getAdditionalReportProperties()	Return an array of additional report parameters that can be used in the Report format message of a Deck Key Command
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()
FormattedString	getDeckExpression()
List<String>	getExpressionList()	SearchTarget
List<KeyCommand>	getKeyCommands(Deck deck)	Return a list of KeyCommands provided by this DeckKeyCommand
FormattedString	getLimitExpression()
FormattedString	getMatchExpression()
NamedKeyStrokeListener	getSendListener()
FormattedString	getStopExpresson()
String	getTargetDeck()
boolean	isApplyOnMove()
boolean	isLimitTotal()
boolean	isSendMatching()
boolean	isStop()
boolean	isStopInclude()
boolean	isVariableDeck()
void	registerListeners(Deck deck)	Register any Listeners for Keystroke provided by this DeckKeyCommand
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class VASSAL.build.module.map.deck.AbstractDeckKeyCommand

addTo, getAllowableConfigureComponents, getDescription, getFormattedStringList, getHelpFile, getKeyStroke, getMenuTextList, getNamedKeyStrokeList, getReportFormat, removeFrom

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, 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

TARGET_DECK

public static final String TARGET_DECK

See Also:

• Constant Field Values

VARIABLE_DECK

public static final String VARIABLE_DECK

See Also:

• Constant Field Values

DECK_EXPRESSION

public static final String DECK_EXPRESSION

See Also:

• Constant Field Values

SEND_MATCHING

public static final String SEND_MATCHING

See Also:

• Constant Field Values

MATCH_EXPRESSION

public static final String MATCH_EXPRESSION

See Also:

• Constant Field Values

LIMIT_TOTAL

public static final String LIMIT_TOTAL

See Also:

• Constant Field Values

LIMIT_EXPRESSION

public static final String LIMIT_EXPRESSION

See Also:

• Constant Field Values

STOP

public static final String STOP

See Also:

• Constant Field Values

STOP_EXPRESSION

public static final String STOP_EXPRESSION

See Also:

• Constant Field Values

STOP_INCLUDE

public static final String STOP_INCLUDE

See Also:

• Constant Field Values

ORDER

public static final String ORDER

See Also:

• Constant Field Values

SENT_COUNT

public static final String SENT_COUNT

See Also:

• Constant Field Values

APPLY_ON_MOVE

public static final String APPLY_ON_MOVE

See Also:

• Constant Field Values

Constructor Details

DeckSendKeyCommand

public DeckSendKeyCommand()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

getTargetDeck

public String getTargetDeck()

getSendListener

public NamedKeyStrokeListener getSendListener()

isVariableDeck

public boolean isVariableDeck()

getDeckExpression

public FormattedString getDeckExpression()

isSendMatching

public boolean isSendMatching()

getMatchExpression

public FormattedString getMatchExpression()

isLimitTotal

public boolean isLimitTotal()

getLimitExpression

public FormattedString getLimitExpression()

isStop

public boolean isStop()

getStopExpresson

public FormattedString getStopExpresson()

isStopInclude

public boolean isStopInclude()

isApplyOnMove

public boolean isApplyOnMove()

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 AbstractDeckKeyCommand

Returns:

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

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 AbstractDeckKeyCommand

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 AbstractDeckKeyCommand

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 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 AbstractDeckKeyCommand

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 AbstractDeckKeyCommand

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.

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.

getKeyCommands

public List<KeyCommand> getKeyCommands(Deck deck)

Description copied from interface: DeckKeyCommand

Return a list of KeyCommands provided by this DeckKeyCommand

Parameters:

deck - The Deck to perform the Commands on

Returns:

List of KeyCommands

registerListeners

public void registerListeners(Deck deck)

Description copied from interface: DeckKeyCommand

Register any Listeners for Keystroke provided by this DeckKeyCommand

Parameters:

deck - The Deck to perform the actions on if KeyStroke seem

deregisterListeners

public void deregisterListeners()

Description copied from interface: DeckKeyCommand

Remove any Listener previously registered for this DeckKeyCommand

getAdditionalReportProperties

public String[] getAdditionalReportProperties()

Description copied from interface: DeckKeyCommand

Return an array of additional report parameters that can be used in the Report format message of a Deck Key Command

Specified by:

getAdditionalReportProperties in interface DeckKeyCommand

Overrides:

getAdditionalReportProperties in class AbstractDeckKeyCommand

Returns:

Array of property names

getExpressionList

public List<String> getExpressionList()

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)