Package VASSAL.build.module.properties

Class GlobalProperties

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.properties.GlobalProperties

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, MutablePropertiesContainer, PropertyNameSource, PropertySource, ValidityChecker, Translatable, ToolBarComponent

public class GlobalProperties
extends AbstractConfigurable
implements MutablePropertiesContainer, ToolBarComponent, PropertySource

Dummy component that acts as a simple container for GlobalProperty components

Author:

rkinney

Nested Class Summary

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

AutoConfigurable.Util

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

MutablePropertiesContainer.Impl

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	addMutableProperty(String key, MutableProperty p)	Add a property under the given key
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
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
HelpFile	getHelpFile()
String	getI18nPrefix()
Object	getLocalizedProperty(Object key)
String	getMutablePropertiesContainerId()	Use the identity of the owning container (i.e.
GlobalProperty	getMutableProperty(String name)	Find a GlobalProperty object with the given name
MutablePropertiesContainer	getParent()
Object	getProperty(Object key)
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
JToolBar	getToolBar()
void	removeFrom(Buildable parent)	Remove this component from its parent
MutableProperty	removeMutableProperty(String key)	Remove the property with the given key
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, 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

Constructor Details

GlobalProperties

public GlobalProperties()

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

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component

getConfigureTypeName

public static String getConfigureTypeName()

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 attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

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 HelpFilte describing how to use and configure this component

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

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

addMutableProperty

public void addMutableProperty(String key,
MutableProperty p)

Description copied from interface: MutablePropertiesContainer

Add a property under the given key

Specified by:

addMutableProperty in interface MutablePropertiesContainer

removeMutableProperty

public MutableProperty removeMutableProperty(String key)

Description copied from interface: MutablePropertiesContainer

Remove the property with the given key

Specified by:

removeMutableProperty in interface MutablePropertiesContainer

getToolBar

public JToolBar getToolBar()

Specified by:

getToolBar in interface ToolBarComponent

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface PropertySource

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

getMutableProperty

public GlobalProperty getMutableProperty(String name)

Description copied from interface: MutablePropertiesContainer

Find a GlobalProperty object with the given name

Specified by:

getMutableProperty in interface MutablePropertiesContainer

getI18nPrefix

public String getI18nPrefix()

Overrides:

getI18nPrefix in class AbstractConfigurable

Returns:

Generate a standard prefix for i18n keys for attributes of this component - Classname.attributeName

getParent

public MutablePropertiesContainer getParent()

getMutablePropertiesContainerId

public String getMutablePropertiesContainerId()

Use the identity of the owning container (i.e. Module, map or zone)

Specified by:

getMutablePropertiesContainerId in interface MutablePropertiesContainer

getPropertyNames

public List<String> getPropertyNames()

Description copied from class: AbstractBuildable

Override this method to provide a list of properties to be exposed for use by expressions in the module.

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class AbstractBuildable

Returns:

Default implementation of PropertyNameSource - No properties exposed