Package VASSAL.build.module.map

Class LayerControl

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.LayerControl

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class LayerControl
extends AbstractConfigurable

Adds a button to the toolbar to manipulate Game Piece Layers

Author:

Brent Easton

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LayerControl.CommandConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUTTON_HOTKEY
static String	BUTTON_ICON
static String	BUTTON_TEXT
static String	CMD_DISABLE
static String	CMD_ENABLE
static String	CMD_RESET
static String	CMD_ROTATE_DN
static String	CMD_ROTATE_UP
static String	CMD_TOGGLE
protected String	command
static String	COMMAND
protected static String[]	COMMANDS
protected LaunchButton	launch
protected String[]	layers
static String	LAYERS
static String	NAME
protected CompoundPieceCollection	pieceCollection
protected LayeredPieceCollection	pieceLayers
protected boolean	skip
static String	SKIP
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
LayerControl()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
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
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
static String	getConfigureTypeName()
HelpFile	getHelpFile()
LaunchButton	getLaunchButton()
Map	getMap()
void	launch()
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 VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, 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

NAME

public static final String NAME

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

BUTTON_ICON

public static final String BUTTON_ICON

See Also:

Constant Field Values

BUTTON_HOTKEY

public static final String BUTTON_HOTKEY

See Also:

Constant Field Values

COMMAND

public static final String COMMAND

See Also:

Constant Field Values

SKIP

public static final String SKIP

See Also:

Constant Field Values

LAYERS

public static final String LAYERS

See Also:

Constant Field Values

CMD_ROTATE_UP

public static final String CMD_ROTATE_UP

See Also:

Constant Field Values

CMD_ROTATE_DN

public static final String CMD_ROTATE_DN

See Also:

Constant Field Values

CMD_ENABLE

public static final String CMD_ENABLE

See Also:

Constant Field Values

CMD_DISABLE

public static final String CMD_DISABLE

See Also:

Constant Field Values

CMD_TOGGLE

public static final String CMD_TOGGLE

See Also:

Constant Field Values

CMD_RESET

public static final String CMD_RESET

See Also:

Constant Field Values

launch

protected LaunchButton launch

COMMANDS

protected static final String[] COMMANDS

command

protected String command

skip

protected boolean skip

layers

protected String[] layers

pieceLayers

protected LayeredPieceCollection pieceLayers

pieceCollection

protected CompoundPieceCollection pieceCollection

Constructor Details

LayerControl

public LayerControl()

Method Details

launch

public void launch()

getLaunchButton

public LaunchButton getLaunchButton()

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

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

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

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 AbstractConfigurable

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.

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.

getMap

public Map getMap()

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.

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFilte describing how to use and configure this component

getConfigureTypeName

public static String getConfigureTypeName()

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent