Package VASSAL.build.module.map

Class MassKeyCommand

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.map.MassKeyCommand

All Implemented Interfaces:

PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable

Direct Known Subclasses:

DeckGlobalKeyCommand, GlobalKeyCommand

public class MassKeyCommand
extends AbstractToolbarItem
implements RecursionLimiter.Loopable

Adds a button to a map window toolbar. Hitting the button applies a particular key command to all pieces on that map with a given name. The "Global Key Command" functionality, as the term is used in Vassal Modules, is spread out over several classes internally: GlobalCommand - primary functionality for sending commands to multiple pieces based on matching parameters GlobalKeyCommand - Global Key Commands from a Module window StartupGlobalKeyCommand - Global Key Commands from a Module "At Startup" MassKeyCommand - Global Key Commands from a specific Map window DeckGlobalKeyCommand - Global Key Commands from a Deck CounterGlobalKeyCommand - Global Key Commands from a Game Piece Other important classes: GlobalCommandTarget - "Fast Match" parameters GlobalCommandTargetConfigurer - configurer for "Fast Match" parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MassKeyCommand.DeckPolicyConfig
static class	MassKeyCommand.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractToolbarItem.IconConfig instead.
static class	MassKeyCommand.ParameterListConfig
static class	MassKeyCommand.Prompt
static class	MassKeyCommand.ReportFormatConfig

Nested classes/interfaces inherited from class VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AFFECTED_PIECE_NAMES
static final String	BUTTON_TEXT
static final String	CHECK_PROPERTY
static final String	CHECK_VALUE
protected String	checkProperty
protected String	checkValue
protected String	condition
static final String	CONDITION
static final String	DECK_COUNT
static final String	DEPRECATED_NAME
protected PieceFilter	filter
protected GlobalCommand	globalCommand
static final String	HOTKEY
static final String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	KEY_COMMAND
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
protected Map	map
static final String	NAME	Deprecated, for removal: This API element is subject to removal in a future version.
protected String[]	names
protected List<Parameter>	parameters
static final String	PARAMETERS
static final String	PROPERTIES_FILTER
protected PropertyExpression	propertiesFilter
protected PropertySource	propertySource
static final String	REPORT_FORMAT
static final String	REPORT_SINGLE
protected FormattedString	reportFormat
static final String	SINGLE_MAP
protected boolean	singleMap
protected NamedKeyStroke	stroke
static final String	SUPPRESS_SOUNDS
protected GlobalCommandTarget	target
static final String	TARGET
static final String	TOOLTIP	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class VASSAL.build.AbstractToolbarItem

CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, property, PROPERTY_GATE, propertyGate, showDisabledOptions

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
MassKeyCommand()
MassKeyCommand(MassKeyCommand gkc)	Copy an existing MassKeyCommand or subclass getAttributeNames will resolve to the subclass, so only attributes unique to the subclass will be copied CONDITION is a legacy field that must be null, not "" when not used

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Default behavior adds the button to the parent component
void	apply()
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 key)	By default, all attributes are visible
String	getComponentName()	Return the name of the trait or Component an Auditable is
String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
PieceFilter	getFilter()
PieceFilter	getFilter(AuditTrail trail)
List<String>	getFormattedStringList()	SearchTarget
GlobalCommandTarget.GKCtype	getGKCtype()
HelpFile	getHelpFile()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
GlobalCommandTarget	getTarget()
void	removeFrom(Buildable parent)	Remove from our parent
void	setAttribute(String key, Object value)	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.
void	setPropertySource(PropertySource source)

Methods inherited from class VASSAL.build.AbstractToolbarItem

addLocalImageNames, addPropertyGateListener, addPropertyGateListener, checkDisabled, disableIfTrue, getComponent, getLaunchButton, getMenuTextList, getNameKey, getRestoreCommand, isShowDisabledOptions, makeLaunchButton, propertyChange, removePropertyGateListener, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setNamePrompt, setShowDisabledOptions, setTooltipKey, setup

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, 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

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, isMandatory, isMovable, isUnique

Field Details

DEPRECATED_NAME

public static final String DEPRECATED_NAME

See Also:

• Constant Field Values

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

• Constant Field Values

HOTKEY

public static final String HOTKEY

See Also:

• Constant Field Values

KEY_COMMAND

public static final String KEY_COMMAND

See Also:

• Constant Field Values

AFFECTED_PIECE_NAMES

public static final String AFFECTED_PIECE_NAMES

See Also:

• Constant Field Values

PROPERTIES_FILTER

public static final String PROPERTIES_FILTER

See Also:

• Constant Field Values

REPORT_SINGLE

public static final String REPORT_SINGLE

See Also:

• Constant Field Values

REPORT_FORMAT

public static final String REPORT_FORMAT

See Also:

• Constant Field Values

CONDITION

public static final String CONDITION

See Also:

• Constant Field Values

DECK_COUNT

public static final String DECK_COUNT

See Also:

• Constant Field Values

CHECK_PROPERTY

public static final String CHECK_PROPERTY

See Also:

• Constant Field Values

CHECK_VALUE

public static final String CHECK_VALUE

See Also:

• Constant Field Values

SINGLE_MAP

public static final String SINGLE_MAP

See Also:

• Constant Field Values

SUPPRESS_SOUNDS

public static final String SUPPRESS_SOUNDS

See Also:

• Constant Field Values

PARAMETERS

public static final String PARAMETERS

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

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

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

launch

@Deprecated(since="2020-10-21",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

stroke

protected NamedKeyStroke stroke

names

protected String[] names

condition

protected String condition

checkProperty

protected String checkProperty

checkValue

protected String checkValue

propertiesFilter

protected PropertyExpression propertiesFilter

propertySource

protected PropertySource propertySource

filter

protected PieceFilter filter

map

protected Map map

globalCommand

protected GlobalCommand globalCommand

reportFormat

protected FormattedString reportFormat

singleMap

protected boolean singleMap

parameters

protected List<Parameter> parameters

TARGET

public static final String TARGET

See Also:

• Constant Field Values

target

protected GlobalCommandTarget target

Constructor Details

MassKeyCommand

public MassKeyCommand()

MassKeyCommand

public MassKeyCommand(MassKeyCommand gkc)

Copy an existing MassKeyCommand or subclass getAttributeNames will resolve to the subclass, so only attributes unique to the subclass will be copied CONDITION is a legacy field that must be null, not "" when not used

Method Details

getGKCtype

public GlobalCommandTarget.GKCtype getGKCtype()

Returns:

Our GKC type -- this method is overridden by GlobalKeyCommand for module-level GKC's and by DeckGlobalKeyCommand for Deck GKC's. This value affects what configurer options are shown.

addTo

public void addTo(Buildable parent)

Description copied from class: AbstractToolbarItem

Default behavior adds the button to the parent component

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

apply

public void apply()

setPropertySource

public void setPropertySource(PropertySource source)

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.

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

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:

an array of all buildFile (XML) attribute names for this component

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

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.

getTarget

public GlobalCommandTarget getTarget()

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from class: AbstractToolbarItem

Remove from our parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

parent - parent

getFilter

public PieceFilter getFilter()

getFilter

public PieceFilter getFilter(AuditTrail trail)

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String key)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractToolbarItem

Parameters:

key - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

setAttribute

public void setAttribute(String key,
 Object value)

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

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

getComponentName

public String getComponentName()

Description copied from interface: Auditable

Return the name of the trait or Component an Auditable is

Specified by:

getComponentName in interface Auditable

Returns:

Component name

getComponentTypeName

public String getComponentTypeName()

Description copied from interface: Auditable

Return a description of the Type of trait or Component an Auditable is

Specified by:

getComponentTypeName in interface Auditable

Returns:

Component Type

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractToolbarItem

Returns:

a list of the Configurables property fields (for search)

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)

getFormattedStringList

public List<String> getFormattedStringList()

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)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

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)