Package VASSAL.build.module.properties

Class GlobalProperty

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.properties.GlobalProperty

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, MutableProperty, PropertyNameSource, PropertySource, CommandEncoder, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget, ToolBarComponent

Direct Known Subclasses:

ZoneProperty

public class GlobalProperty
extends AbstractConfigurable
implements ToolBarComponent, GameComponent, CommandEncoder, PropertySource, MutableProperty

Adds a global property to a Map or Module

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlobalProperty.SetGlobalProperty	Command to pass a new Global property value to other players or into the logfile.

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

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutableProperty

MutableProperty.Impl, MutableProperty.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	COMMAND_PREFIX
protected String	description
static String	DESCRIPTION
protected FormattedString	format
static String	INITIAL_VALUE
protected String	initialValue
static String	MAX_VALUE
protected String	maxValue
static String	MIN_VALUE
protected String	minValue
static String	NAME
protected boolean	numeric
static String	NUMERIC
protected VisibilityCondition	numericVisibility
protected MutablePropertiesContainer	parentContainer
protected MutableProperty.Impl	property
protected PropertySource	propertySource
protected TemporaryToolBar	tempToolbar
protected boolean	wrap
static String	WRAP

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

Method Summary

Modifier and Type	Method	Description
void	addMutablePropertyChangeListener(PropertyChangeListener l)
void	addTo(Buildable parent)	Adds this component to its parent.
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
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(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()
protected String	getContainerId()
String	getDescription()
List<String>	getExpressionList()	SearchTarget
HelpFile	getHelpFile()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
int	getMaxValue()
List<String>	getMenuTextList()	SearchTarget
int	getMinValue()
MutablePropertiesContainer	getParent()
Object	getProperty(Object key)	When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.
protected String	getPropertyId()	A String that identifies this property in an encoded Command
List<String>	getPropertyList()	SearchTarget
String	getPropertyValue()
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
JToolBar	getToolBar()
boolean	isNumeric()
boolean	isWrap()
void	removeFrom(Buildable parent)	Remove this component from its parent
void	removeMutablePropertyChangeListener(PropertyChangeListener l)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setPropertyName(String name)
Command	setPropertyValue(String newValue)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

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

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

INITIAL_VALUE

public static final String INITIAL_VALUE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

NUMERIC

public static final String NUMERIC

See Also:

Constant Field Values

MIN_VALUE

public static final String MIN_VALUE

See Also:

Constant Field Values

MAX_VALUE

public static final String MAX_VALUE

See Also:

Constant Field Values

WRAP

public static final String WRAP

See Also:

Constant Field Values

COMMAND_PREFIX

protected static final String COMMAND_PREFIX

See Also:

Constant Field Values

tempToolbar

protected TemporaryToolBar tempToolbar

description

protected String description

initialValue

protected String initialValue

numeric

protected boolean numeric

minValue

protected String minValue

maxValue

protected String maxValue

wrap

protected boolean wrap

numericVisibility

protected VisibilityCondition numericVisibility

format

protected FormattedString format

propertySource

protected PropertySource propertySource

property

protected MutableProperty.Impl property

parentContainer

protected MutablePropertiesContainer parentContainer

Constructor Details

GlobalProperty

public GlobalProperty()

GlobalProperty

public GlobalProperty(GlobalProperty p)

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

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

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

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.

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

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.

Specified by:

addTo in interface Buildable

Parameters:

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

getToolBar

public JToolBar getToolBar()

Specified by:

getToolBar in interface ToolBarComponent

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

Parameters:

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

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

decode

public Command decode(String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

getPropertyId

protected String getPropertyId()

A String that identifies this property in an encoded Command

Returns:

propertyId

getContainerId

protected String getContainerId()

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

getMaxValue

public int getMaxValue()

getMinValue

public int getMinValue()

isNumeric

public boolean isNumeric()

isWrap

public boolean isWrap()

getDescription

public String getDescription()

getProperty

public Object getProperty(Object key)

Description copied from interface: PropertySource

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

Specified by:

getProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from interface: PropertySource

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version.

Specified by:

getLocalizedProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value

getConfigureTypeName

public static String getConfigureTypeName()

addMutablePropertyChangeListener

public void addMutablePropertyChangeListener(PropertyChangeListener l)

Specified by:

addMutablePropertyChangeListener in interface MutableProperty

removeMutablePropertyChangeListener

public void removeMutablePropertyChangeListener(PropertyChangeListener l)

Specified by:

removeMutablePropertyChangeListener in interface MutableProperty

setPropertyName

public void setPropertyName(String name)

setPropertyValue

public Command setPropertyValue(String newValue)

Specified by:

setPropertyValue in interface MutableProperty

getPropertyValue

public String getPropertyValue()

Specified by:

getPropertyValue in interface MutableProperty

getParent

public MutablePropertiesContainer getParent()

Specified by:

getParent in interface MutableProperty

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)

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)

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class AbstractConfigurable

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the Configurable, if any (for search)