Package VASSAL.build.module

Class StartupGlobalKeyCommand

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.map.MassKeyCommand

VASSAL.build.module.GlobalKeyCommand

VASSAL.build.module.StartupGlobalKeyCommand

All Implemented Interfaces:

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

public class StartupGlobalKeyCommand
extends GlobalKeyCommand
implements GameComponent, CommandEncoder, UniqueIdManager.Identifyable

A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.

As of 3.6, multiple Startup Global Key Commands can be depended on to process in the correct order. As of 3.7, a global hotkey can be sent instead of a GKC

Author:

Pieter Geerkens, Brian Reynolds

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StartupGlobalKeyCommand.Prompt
static class	StartupGlobalKeyCommand.SendConfig

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

MassKeyCommand.DeckPolicyConfig, MassKeyCommand.IconConfig, MassKeyCommand.ParameterListConfig, 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	APPLY_EVERY_LAUNCH_OF_SESSION
static final String	APPLY_FIRST_LAUNCH_OF_SESSION
static final String	APPLY_START_GAME_OR_SIDE_CHANGE
static final String	APPLY_START_OF_GAME_ONLY
static final String	COMMAND_PREFIX
static final String	GLOBAL_HOTKEY
protected NamedKeyStroke	globalHotkey
static final String	HOTKEY_OR_KEY_COMMAND
protected String	hotkeyOrKeyCommand
protected String	id
protected static final UniqueIdManager	idMgr
static final String	SEND_HOTKEY
static final String	SEND_KEY_COMMAND
static final String[]	SEND_KEYS
static final String[]	SEND_OPTIONS
static final String	WHEN_TO_APPLY
String	whenToApply

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
StartupGlobalKeyCommand()
StartupGlobalKeyCommand(MassKeyCommand gkc)

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Default behavior adds the button to the parent component
void	apply()	This version of Global Key Commands searches every map in the module
boolean	applyIfNotApplied()	Apply the command, but only if it hasn't been marked as already-applied (by whatever its when-to-apply parameters are)
boolean	applyPlayerChange()	Apply the command, but only if it is eligible to be applied on Player Join / Change
Command	decode(String command)	Deserializes our command from a string version, if the command belongs to us.
String	encode(Command c)	Serializes our command into a string, if it belongs to us
void	freshGame()	When initializing a new game from a Predefined Setup that loads a saved game, mark that this is actually a fresh game rather than a load of an old one
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
static String	getConfigureTypeName()
HelpFile	getHelpFile()
String	getId()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
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
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	setId(String id)	Sets our unique ID (among Startup Global Key Commands), so that multiple SGKCs can sort their save/restore commands from each other
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.module.GlobalKeyCommand

getGKCtype

Methods inherited from class VASSAL.build.module.map.MassKeyCommand

getAllowableConfigureComponents, getComponentName, getComponentTypeName, getExpressionList, getFilter, getFilter, getFormattedStringList, getPropertyList, getTarget, setPropertySource

Methods inherited from class VASSAL.build.AbstractToolbarItem

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

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

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details

WHEN_TO_APPLY

public static final String WHEN_TO_APPLY

See Also:

• Constant Field Values

APPLY_FIRST_LAUNCH_OF_SESSION

public static final String APPLY_FIRST_LAUNCH_OF_SESSION

See Also:

• Constant Field Values

APPLY_EVERY_LAUNCH_OF_SESSION

public static final String APPLY_EVERY_LAUNCH_OF_SESSION

See Also:

• Constant Field Values

APPLY_START_OF_GAME_ONLY

public static final String APPLY_START_OF_GAME_ONLY

See Also:

• Constant Field Values

APPLY_START_GAME_OR_SIDE_CHANGE

public static final String APPLY_START_GAME_OR_SIDE_CHANGE

See Also:

• Constant Field Values

GLOBAL_HOTKEY

public static final String GLOBAL_HOTKEY

See Also:

• Constant Field Values

HOTKEY_OR_KEY_COMMAND

public static final String HOTKEY_OR_KEY_COMMAND

See Also:

• Constant Field Values

SEND_KEY_COMMAND

public static final String SEND_KEY_COMMAND

See Also:

• Constant Field Values

SEND_HOTKEY

public static final String SEND_HOTKEY

See Also:

• Constant Field Values

SEND_OPTIONS

public static final String[] SEND_OPTIONS

SEND_KEYS

public static final String[] SEND_KEYS

COMMAND_PREFIX

public static final String COMMAND_PREFIX

See Also:

• Constant Field Values

idMgr

protected static final UniqueIdManager idMgr

id

protected String id

hotkeyOrKeyCommand

protected String hotkeyOrKeyCommand

globalHotkey

protected NamedKeyStroke globalHotkey

whenToApply

public String whenToApply

Constructor Details

StartupGlobalKeyCommand

public StartupGlobalKeyCommand()

StartupGlobalKeyCommand

public StartupGlobalKeyCommand(MassKeyCommand gkc)

Method Details

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 MassKeyCommand

Parameters:

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

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 MassKeyCommand

Parameters:

parent - parent

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class MassKeyCommand

Returns:

a HelpFile describing how to use and configure * this component

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 GlobalKeyCommand

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.

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 MassKeyCommand

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 MassKeyCommand

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 MassKeyCommand

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: 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 MassKeyCommand

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

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 MassKeyCommand

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.

applyIfNotApplied

public boolean applyIfNotApplied()

Apply the command, but only if it hasn't been marked as already-applied (by whatever its when-to-apply parameters are)

Returns:

true if command was applied

applyPlayerChange

public boolean applyPlayerChange()

Apply the command, but only if it is eligible to be applied on Player Join / Change

Returns:

true if command was applied

apply

public void apply()

Description copied from class: GlobalKeyCommand

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

Overrides:

apply in class GlobalKeyCommand

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class MassKeyCommand

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Overrides:

setup in class AbstractToolbarItem

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

freshGame

public void freshGame()

When initializing a new game from a Predefined Setup that loads a saved game, mark that this is actually a fresh game rather than a load of an old one

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

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

Specified by:

getRestoreCommand in interface GameComponent

Overrides:

getRestoreCommand in class AbstractToolbarItem

setId

public void setId(String id)

Sets our unique ID (among Startup Global Key Commands), so that multiple SGKCs can sort their save/restore commands from each other

Specified by:

setId in interface UniqueIdManager.Identifyable

Parameters:

id - Sets our unique ID

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

Returns:

unique ID of this SGKC

decode

public Command decode(String command)

Deserializes our command from a string version, if the command belongs to us.

Specified by:

decode in interface CommandEncoder

Parameters:

command - Serialized string command

Returns:

An StartupGlobalKeyCommand.UpdateStartupGlobalKeyCommand

encode

public String encode(Command c)

Serializes our command into a string, if it belongs to us

Specified by:

encode in interface CommandEncoder

Parameters:

c - Command to serialize. Only serialized if it's an UpdateClockControlCommand.

Returns:

Serialized command, or null if command passed wasn't an UpdateClockControlCommand.