Package VASSAL.build.module

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 VASSAL.build.module.map.MassKeyCommand

MassKeyCommand.DeckPolicyConfig, MassKeyCommand.IconConfig, MassKeyCommand.ParameterListConfig, MassKeyCommand.Prompt, 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 inherited from class VASSAL.build.module.map.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

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
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 VASSAL.build.module.map.MassKeyCommand

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

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

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.