Package VASSAL.build.module.properties

Class ChangePropertyButton

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.properties.ChangePropertyButton

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, IncrementProperty.Constraints, PropertyChangerConfigurer.Constraints, PropertyNameSource, PropertyPrompt.Constraints, PropertyPrompt.DialogParent, PropertySource, ValidityChecker, Translatable

public class ChangePropertyButton
extends AbstractConfigurable
implements PropertyChangerConfigurer.Constraints

Adds a toolbar button that changes the value of a global property

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChangePropertyButton.PropChangerOptions
static class	ChangePropertyButton.ReportFormatConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUTTON_ICON
static String	BUTTON_TEXT
static String	BUTTON_TOOLTIP
static String	DESCRIPTION_FORMAT
protected FormattedString	format
static String	HOTKEY
protected LaunchButton	launch
static String	NEW_VALUE_FORMAT
static String	OLD_VALUE_FORMAT
protected PropertyChangerConfigurer	propChangeConfig
protected GlobalProperty	property
static String	PROPERTY_CHANGER
protected FormattedString	report
static String	REPORT_FORMAT

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

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
Component	getComponent()
static String	getConfigureTypeName()
HelpFile	getHelpFile()
Object	getLocalizedProperty(Object key)
int	getMaximumValue()
int	getMinimumValue()
protected String	getNewValue()
Object	getProperty(Object key)
PropertyChanger	getPropertyChanger()
PropertySource	getPropertySource()
boolean	isNumeric()
boolean	isWrap()
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, getAttributeVisibility, 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

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

Constant Field Values

BUTTON_TOOLTIP

public static final String BUTTON_TOOLTIP

See Also:

Constant Field Values

BUTTON_ICON

public static final String BUTTON_ICON

See Also:

Constant Field Values

HOTKEY

public static final String HOTKEY

See Also:

Constant Field Values

PROPERTY_CHANGER

public static final String PROPERTY_CHANGER

See Also:

Constant Field Values

REPORT_FORMAT

public static final String REPORT_FORMAT

See Also:

Constant Field Values

OLD_VALUE_FORMAT

public static final String OLD_VALUE_FORMAT

See Also:

Constant Field Values

NEW_VALUE_FORMAT

public static final String NEW_VALUE_FORMAT

See Also:

Constant Field Values

DESCRIPTION_FORMAT

public static final String DESCRIPTION_FORMAT

See Also:

Constant Field Values

launch

protected LaunchButton launch

report

protected FormattedString report

property

protected GlobalProperty property

propChangeConfig

protected PropertyChangerConfigurer propChangeConfig

format

protected FormattedString format

Constructor Details

ChangePropertyButton

public ChangePropertyButton()

Method Details

launch

public void launch()

getNewValue

protected String getNewValue()

getPropertyChanger

public PropertyChanger getPropertyChanger()

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

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

getConfigureTypeName

public static String getConfigureTypeName()

getComponent

public Component getComponent()

Specified by:

getComponent in interface PropertyPrompt.DialogParent

getMaximumValue

public int getMaximumValue()

Specified by:

getMaximumValue in interface IncrementProperty.Constraints

Specified by:

getMaximumValue in interface PropertyPrompt.Constraints

getMinimumValue

public int getMinimumValue()

Specified by:

getMinimumValue in interface IncrementProperty.Constraints

Specified by:

getMinimumValue in interface PropertyPrompt.Constraints

isNumeric

public boolean isNumeric()

Specified by:

isNumeric in interface PropertyPrompt.Constraints

isWrap

public boolean isWrap()

Specified by:

isWrap in interface IncrementProperty.Constraints

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface PropertySource

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

getPropertySource

public PropertySource getPropertySource()

Specified by:

getPropertySource in interface IncrementProperty.Constraints

Specified by:

getPropertySource in interface PropertyPrompt.Constraints