Package VASSAL.configure

Class Configurer

java.lang.Object

VASSAL.configure.Configurer

Direct Known Subclasses:

AddressBookServerConfigurer, AutoConfigurer, BooleanConfigurer, ColorConfigurer, ColorSwatchConfigurer, DynamicProperty.DynamicKeyCommandConfigurer, FileConfigurer, FontConfigurer, FontConfigurer, FontStyleConfigurer, HotKeyConfigurer, IconConfigurer, InstanceConfigurer, JavaNameConfigurer, KeyModifiersConfigurer, KeyStrokeArrayConfigurer, LayoutConfigurer, ListConfigurer, LocaleConfigurer, MassKeyCommand.DeckPolicyConfig, NamedHotKeyConfigurer, NamedKeyStrokeArrayConfigurer, NewColorConfigurer, PieceAccessConfigurer, PositionOption, PropertyChangerConfigurer, PrototypeDefinition.Config, ServerConfigurer, SimpleConfigurer, SoundConfigurer, StringArrayConfigurer, StringConfigurer, StringEnumConfigurer, StringEnumConfigurer, TableConfigurer, TextConfigurer, Zone.Editor, ZoneHighlight.PercentageConfigurer, Zoomer.LevelConfigurer

public abstract class Configurer
extends Object

A property editor class. Wraps an Object value and provides methods for saving and restoring the Object from a String. Also includes a Component that can be placed into a property editing window, allowing the user to change the value interactively.

Field Summary

Fields

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected boolean	frozen	When frozen is true, setting the value programmatically will not result in a PropertyChangeEvent being fired
protected String	key	A String the uniquely identifies this property
protected String	name	A String that provides a short description of the property to the user
static String	NAME_PROPERTY
protected boolean	noUpdate	When noUpdate is true, setting the value programmatically will not result in an update of the GUI Component
protected Object	value	The value

Constructor Summary

Constructors

Constructor	Description
Configurer(String key, String name)
Configurer(String key, String name, Object val)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)	Add a listener to be notified when the Object state changes
void	fireUpdate()	Fire a PropertyChangeEvent as if the value had been set from null
abstract Component	getControls()	GUI interface for setting the option in an editing window
String	getKey()	Unique identifier
String	getName()	Plain English description of the Object
Object	getValue()	The Object value May be null if the Object has not been initialized
abstract String	getValueString()
boolean	isFrozen()
void	removePropertyChangeListener(PropertyChangeListener l)
void	setFrozen(boolean val)	If true, then don't fire PropertyChangeEvents when the value is reset
void	setName(String s)
void	setValue(Object o)	Set the Object value
abstract void	setValue(String s)	Set the Object value from a String

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME_PROPERTY

public static final String NAME_PROPERTY

See Also:

Constant Field Values

key

protected String key

A String the uniquely identifies this property

name

protected String name

A String that provides a short description of the property to the user

value

protected Object value

The value

changeSupport

protected PropertyChangeSupport changeSupport

noUpdate

protected boolean noUpdate

When noUpdate is true, setting the value programmatically will not result in an update of the GUI Component

frozen

protected boolean frozen

When frozen is true, setting the value programmatically will not result in a PropertyChangeEvent being fired

Constructor Details

Configurer

public Configurer(String key, String name)

Configurer

public Configurer(String key, String name, Object val)

Method Details

getKey

public String getKey()

Unique identifier

getName

public String getName()

Plain English description of the Object

setName

public void setName(String s)

getValue

public Object getValue()

The Object value May be null if the Object has not been initialized

getValueString

public abstract String getValueString()

Returns:

a String representation of the Object value

setValue

public void setValue(Object o)

Set the Object value

setFrozen

public void setFrozen(boolean val)

If true, then don't fire PropertyChangeEvents when the value is reset

isFrozen

public boolean isFrozen()

fireUpdate

public void fireUpdate()

Fire a PropertyChangeEvent as if the value had been set from null

setValue

public abstract void setValue(String s)

Set the Object value from a String

getControls

public abstract Component getControls()

GUI interface for setting the option in an editing window

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Add a listener to be notified when the Object state changes

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)