Package VASSAL.build.module
Class KeyNamer
java.lang.Object
VASSAL.build.module.KeyNamer
- All Implemented Interfaces:
Buildable
Translates key codes into human-readable strings (e.g. "Backspace").
Exists as a buildable (buildFile element) so that it can be overridden by custom classes
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a child component.void
Adds this component to its parent.void
Build the object from the XML representation of the BuildablegetBuildElement
(Document doc) static String
Implements VASSAL's plain text representation of a KeyStroke.boolean
Is this component a reqired component within its parent?boolean
isUnique()
Does this component need to be unique within it's parent?
-
Constructor Details
-
KeyNamer
public KeyNamer()
-
-
Method Details
-
build
Description copied from interface:Buildable
Build the object from the XML representation of the Buildable -
getBuildElement
- Specified by:
getBuildElement
in interfaceBuildable
- Parameters:
doc
- XML file- Returns:
- an XML element from which this component can be built
-
addTo
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. -
add
Description copied from interface:Buildable
Adds a child component. Both this method andBuildable.addTo(VASSAL.build.Buildable)
are invoked when adding a child to a parent -
getKeyString
Implements VASSAL's plain text representation of a KeyStroke.- Parameters:
k
- - a keystroke (e.g. VK_BACKSPACE) to be rendered as a string- Returns:
- - a human-readable name for the keystroke (e.g. "Backspace")
-
isMandatory
public boolean isMandatory()Description copied from interface:Buildable
Is this component a reqired component within its parent?- Specified by:
isMandatory
in interfaceBuildable
- Returns:
- true if component is mandatory
-
isUnique
public boolean isUnique()Description copied from interface:Buildable
Does this component need to be unique within it's parent?
-