Package VASSAL.build.module.map

Class MassKeyCommand

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.MassKeyCommand

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, RecursionLimiter.Loopable

Direct Known Subclasses:

DeckGlobalKeyCommand, GlobalKeyCommand

public class MassKeyCommand
extends AbstractConfigurable
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MassKeyCommand.DeckPolicyConfig
static class	MassKeyCommand.IconConfig
static class	MassKeyCommand.Prompt
static class	MassKeyCommand.ReportFormatConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	AFFECTED_PIECE_NAMES
static String	BUTTON_TEXT
static String	CHECK_PROPERTY
static String	CHECK_VALUE
protected String	checkProperty
protected String	checkValue
protected String	condition
static String	CONDITION
static String	DECK_COUNT
static String	DEPRECATED_NAME
protected PieceFilter	filter
protected GlobalCommand	globalCommand
static String	HOTKEY
static String	ICON
static String	KEY_COMMAND
protected LaunchButton	launch
protected Map	map
static String	NAME
protected String[]	names
static String	PROPERTIES_FILTER
protected PropertyExpression	propertiesFilter
protected PropertySource	propertySource
static String	REPORT_FORMAT
static String	REPORT_SINGLE
protected FormattedString	reportFormat
static String	SINGLE_MAP
protected boolean	singleMap
protected NamedKeyStroke	stroke
static String	TOOLTIP

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

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
void	apply()
Class<?>[]	getAllowableConfigureComponents()	Return a list of valid sub-component Classes.
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the buildFile (XML) attributes of this component.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
String	getComponentName()
String	getComponentTypeName()
static String	getConfigureTypeName()
PieceFilter	getFilter()
HelpFile	getHelpFile()
protected LaunchButton	getLaunchButton()
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
protected void	setLaunchButton(LaunchButton launch)
void	setPropertySource(PropertySource source)

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

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

public static final String DEPRECATED_NAME

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

ICON

public static final String ICON

See Also:

Constant Field Values

TOOLTIP

public static final String TOOLTIP

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

launch

protected LaunchButton launch

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

Constructor Details

MassKeyCommand

public MassKeyCommand()

Method Details

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

apply

public void apply()

setPropertySource

public void setPropertySource(PropertySource source)

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Description copied from interface: Configurable

Return 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 Configuration Window.

Specified by:

getAllowableConfigureComponents in interface Configurable

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

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

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

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from class: AbstractConfigurable

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

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

getConfigureTypeName

public static String getConfigureTypeName()

getLaunchButton

protected LaunchButton getLaunchButton()

setLaunchButton

protected void setLaunchButton(LaunchButton launch)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFilte describing how to use and configure this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getFilter

public PieceFilter getFilter()

setAttribute

public void setAttribute(String key,
Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.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

Specified by:

setAttribute in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.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()

Specified by:

getComponentName in interface RecursionLimiter.Loopable

getComponentTypeName

public String getComponentTypeName()

Specified by:

getComponentTypeName in interface RecursionLimiter.Loopable