Class GlobalKeyCommand

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.map.MassKeyCommand

VASSAL.build.module.GlobalKeyCommand

All Implemented Interfaces:

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

Direct Known Subclasses:

StartupGlobalKeyCommand

public class GlobalKeyCommand
extends MassKeyCommand

This version of MassKeyCommand is added directly to a GameModule and applies to all maps. 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/interfaces inherited from class MassKeyCommand

MassKeyCommand.DeckPolicyConfig, MassKeyCommand.IconConfig, MassKeyCommand.ParameterListConfig, MassKeyCommand.Prompt, MassKeyCommand.ReportFormatConfig

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 AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

Modifier and Type	Class	Description
static class	AbstractToolbarItem.FormattedStringConfig

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields inherited from class MassKeyCommand

AFFECTED_PIECE_NAMES, BUTTON_TEXT, CHECK_PROPERTY, CHECK_VALUE, checkProperty, checkValue, condition, CONDITION, DECK_COUNT, DEPRECATED_NAME, filter, globalCommand, HOTKEY, ICON, KEY_COMMAND, launch, map, NAME, names, parameters, PARAMETERS, PROPERTIES_FILTER, propertiesFilter, propertySource, REPORT_FORMAT, REPORT_SINGLE, reportFormat, SINGLE_MAP, singleMap, stroke, SUPPRESS_SOUNDS, target, TARGET, TOOLTIP

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 AbstractToolbarItem

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

Modifier and Type	Field	Description
static final String	CAN_DISABLE
protected boolean	canDisable
static final String	DISABLED_ICON
protected IconConfigurer	disabledIconConfig
static final String	HIDE_WHEN_DISABLED
protected boolean	hideWhenDisabled
protected MutableProperty.Impl	property
static final String	PROPERTY_GATE
protected String	propertyGate
protected boolean	showDisabledOptions

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
GlobalKeyCommand()
GlobalKeyCommand(MassKeyCommand gkc)

Method Summary

Modifier and Type	Method	Description
void	apply()	This version of Global Key Commands searches every map in the module
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
GlobalCommandTarget.GKCtype	getGKCtype()

Methods inherited from class MassKeyCommand

addTo, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getComponentName, getComponentTypeName, getConfigureTypeName, getExpressionList, getFilter, getFilter, getFormattedStringList, getHelpFile, getNamedKeyStrokeList, getPropertyList, getTarget, removeFrom, setAttribute, setPropertySource

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Default behavior adds the button to the parent component
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.
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
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 AbstractToolbarItem

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

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractBuildable should override this method in order to add the names of any image files they use to the collection.
protected void	addPropertyGateListener()
protected void	addPropertyGateListener(boolean dontCheck)	If we have a disable-this-button property, set a listener on it
void	checkDisabled()	Check our disable-this-button property and enable/disable our button as appropriate based on its value
void	disableIfTrue(boolean disable)
protected Component	getComponent()	The component to be added to the control window toolbar
LaunchButton	getLaunchButton()
List<String>	getMenuTextList()	SearchTarget
protected String	getNameKey()
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
boolean	isShowDisabledOptions()
protected LaunchButton	makeLaunchButton(String tooltip, String button_text, String iconFile, ActionListener action)	Create a standard toolbar launcher button for this item
void	propertyChange(PropertyChangeEvent evt)	Listens to our disable-this-button property; enables/disables our button as appropriate when it changes
protected void	removePropertyGateListener()	Remove any existing disable-this-button property
protected void	setButtonTextKey(String buttonTextKey)
protected void	setHotKeyKey(String hotKeyKey)
protected void	setIconKey(String iconKey)
protected void	setLaunchButton(LaunchButton launch)	Sets launch button for this toolbar item
protected void	setNameKey(String nameKey)
protected void	setNamePrompt(String namePrompt)
protected void	setShowDisabledOptions(boolean show)
protected void	setTooltipKey(String tooltipKey)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class AbstractConfigurable

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

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Constructor Details

GlobalKeyCommand

public GlobalKeyCommand()

GlobalKeyCommand

public GlobalKeyCommand(MassKeyCommand gkc)

Method Details

getGKCtype

public GlobalCommandTarget.GKCtype getGKCtype()

Overrides:

getGKCtype in class MassKeyCommand

Returns:

Our type of Global Key Command (overrides the one from Mass Key Command). Affects what configurer options are shown.

apply

public void apply()

This version of Global Key Commands searches every map in the module

Overrides:

apply in class MassKeyCommand

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 MassKeyCommand

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.