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:
AutoConfigurable
,Buildable
,Configurable
,PropertyNameSource
,ValidityChecker
,Translatable
,ImageSearchTarget
,SearchTarget
,RecursionLimiter.Loopable
- Direct Known Subclasses:
DeckGlobalKeyCommand
,GlobalKeyCommand
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
Modifier and TypeClassDescriptionstatic class
static class
Deprecated, for removal: This API element is subject to removal in a future version.static class
static class
Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable
AutoConfigurable.Util
-
Field Summary
Modifier and TypeFieldDescriptionstatic String
static String
static String
static String
protected String
protected String
protected String
static String
static String
static String
protected PieceFilter
protected GlobalCommand
static String
static String
Deprecated, for removal: This API element is subject to removal in a future version.static String
protected LaunchButton
Deprecated, for removal: This API element is subject to removal in a future version.use launch from the superclassprotected Map
static String
Deprecated, for removal: This API element is subject to removal in a future version.protected String[]
static String
protected PropertyExpression
protected PropertySource
static String
static String
protected FormattedString
static String
protected boolean
protected NamedKeyStroke
protected GlobalCommandTarget
static String
static String
Deprecated, for removal: This API element is subject to removal in a future version.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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Default behavior adds the button to the module toolbar.void
apply()
Class<?>[]
String[]
This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.String[]
This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.Class<?>[]
This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.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.getAttributeVisibility(String key)
By default, all attributes are visiblestatic String
void
removeFrom(Buildable parent)
Default behavior assumes we are removing this from the module toolbarvoid
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, getComponent, getLaunchButton, getMenuTextList, makeLaunchButton, 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, getPropertyNames, 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
-
DEPRECATED_NAME
- See Also:
- Constant Field Values
-
BUTTON_TEXT
- See Also:
- Constant Field Values
-
HOTKEY
- See Also:
- Constant Field Values
-
KEY_COMMAND
- See Also:
- Constant Field Values
-
AFFECTED_PIECE_NAMES
- See Also:
- Constant Field Values
-
PROPERTIES_FILTER
- See Also:
- Constant Field Values
-
REPORT_SINGLE
- See Also:
- Constant Field Values
-
REPORT_FORMAT
- See Also:
- Constant Field Values
-
CONDITION
- See Also:
- Constant Field Values
-
DECK_COUNT
- See Also:
- Constant Field Values
-
CHECK_PROPERTY
- See Also:
- Constant Field Values
-
CHECK_VALUE
- See Also:
- Constant Field Values
-
SINGLE_MAP
- See Also:
- Constant Field Values
-
NAME
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
ICON
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
TOOLTIP
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
launch
Deprecated, for removal: This API element is subject to removal in a future version.use launch from the superclass -
stroke
-
names
-
condition
-
checkProperty
-
checkValue
-
propertiesFilter
-
propertySource
-
filter
-
map
-
globalCommand
-
reportFormat
-
singleMap
protected boolean singleMap -
TARGET
- See Also:
- Constant Field Values
-
target
-
-
Constructor Details
-
MassKeyCommand
public MassKeyCommand()
-
-
Method Details
-
getGKCtype
- Returns:
- Our GKC type -- this method is overridden by
GlobalKeyCommand
for module-level GKC's and byDeckGlobalKeyCommand
for Deck GKC's. This value affects what configurer options are shown.
-
addTo
Description copied from class:AbstractToolbarItem
Default behavior adds the button to the module toolbar.- Specified by:
addTo
in interfaceBuildable
- Overrides:
addTo
in classAbstractToolbarItem
- Parameters:
parent
- parent Buildable to add this component to as a subcomponent.
-
apply
public void apply() -
setPropertySource
-
getAllowableConfigureComponents
- Specified by:
getAllowableConfigureComponents
in interfaceConfigurable
- 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
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 interfaceAutoConfigurable
- Overrides:
getAttributeDescriptions
in classAbstractToolbarItem
- 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
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 forAbstractConfigurable.getAttributeDescriptions()
andAbstractConfigurable.getAttributeTypes()
.- Specified by:
getAttributeNames
in interfaceAutoConfigurable
- Overrides:
getAttributeNames
in classAbstractToolbarItem
- Returns:
- a list of all buildFile (XML) attribute names for this component
-
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 interfaceAutoConfigurable
- Overrides:
getAttributeTypes
in classAbstractToolbarItem
- 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
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 interfaceAutoConfigurable
- Specified by:
getAttributeValueString
in interfaceTranslatable
- Overrides:
getAttributeValueString
in classAbstractToolbarItem
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractToolbarItem.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
-
getConfigureTypeName
-
getHelpFile
- Specified by:
getHelpFile
in interfaceConfigurable
- Returns:
- a HelpFile describing how to use and configure * this component
-
removeFrom
Description copied from class:AbstractToolbarItem
Default behavior assumes we are removing this from the module toolbar- Specified by:
removeFrom
in interfaceConfigurable
- Overrides:
removeFrom
in classAbstractToolbarItem
- Parameters:
parent
- parent
-
getFilter
-
getAttributeVisibility
Description copied from class:AbstractConfigurable
By default, all attributes are visible- Specified by:
getAttributeVisibility
in interfaceAutoConfigurable
- Overrides:
getAttributeVisibility
in classAbstractConfigurable
- 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
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. Thekey
parameter will be one of those listed inAbstractToolbarItem.getAttributeNames()
. If thevalue
parameter is a String, it will be the value returned byAbstractToolbarItem.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
will be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
- Specified by:
setAttribute
in interfaceAutoConfigurable
- Specified by:
setAttribute
in interfaceTranslatable
- Overrides:
setAttribute
in classAbstractToolbarItem
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractToolbarItem.getAttributeNames()
value
- If thevalue
parameter is a String, it will be the value returned byAbstractToolbarItem.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
can also be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
-
getComponentName
- Specified by:
getComponentName
in interfaceRecursionLimiter.Loopable
-
getComponentTypeName
- Specified by:
getComponentTypeName
in interfaceRecursionLimiter.Loopable
-
getPropertyList
- Specified by:
getPropertyList
in interfaceSearchTarget
- Overrides:
getPropertyList
in classAbstractConfigurable
- Returns:
- a list of the Configurables property fields (for search)
-
getExpressionList
- Specified by:
getExpressionList
in interfaceSearchTarget
- Overrides:
getExpressionList
in classAbstractConfigurable
- Returns:
- a list of the Configurables string/expression fields if any (for search)
-
getFormattedStringList
- Specified by:
getFormattedStringList
in interfaceSearchTarget
- Overrides:
getFormattedStringList
in classAbstractConfigurable
- Returns:
- a list of any Message Format strings referenced in the Configurable, if any (for search)
-
getNamedKeyStrokeList
- Specified by:
getNamedKeyStrokeList
in interfaceSearchTarget
- Overrides:
getNamedKeyStrokeList
in classAbstractToolbarItem
- Returns:
- a list of any Named KeyStrokes referenced in the Configurable, if any (for search)
-