Class TurnGlobalHotkey

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.turn.TurnGlobalHotkey

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class TurnGlobalHotkey
extends AbstractConfigurable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TurnGlobalHotkey.ReportFormatConfig

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected BasicPiece	checkPiece
protected FormattedString	format
protected NamedKeyStroke	hotkey
static final String	HOTKEY
protected PropertyExpression	match
static final String	MATCH
static final String	NAME
protected TurnTracker	parent
static final String	REPORT_FORMAT

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

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
void	apply()
Class<?>[]	getAllowableConfigureComponents()
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 attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(Document) method to write the attributes into an XML element
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
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.

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, 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.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
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()
List<String>	getMenuTextList()	SearchTarget
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

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
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 Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

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?

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

HOTKEY

public static final String HOTKEY

See Also:

• Constant Field Values

MATCH

public static final String MATCH

See Also:

• Constant Field Values

REPORT_FORMAT

public static final String REPORT_FORMAT

See Also:

• Constant Field Values

match

protected PropertyExpression match

hotkey

protected NamedKeyStroke hotkey

format

protected FormattedString format

checkPiece

protected BasicPiece checkPiece

parent

protected TurnTracker parent

Constructor Details

TurnGlobalHotkey

public TurnGlobalHotkey()

Method Details

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

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

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

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

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(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 XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(String, Object). It is also frequently used for checking the current value of an attribute.

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

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

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.

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

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 responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Parameters:

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

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

apply

public void apply()

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class AbstractConfigurable

Returns:

a list of the Configurables string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractConfigurable

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractConfigurable

Returns:

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