Class PropertyChangerConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.build.module.properties.PropertyChangerConfigurer

public class PropertyChangerConfigurer
extends Configurer

Configurer instance that allows a module editor to specify a PropertyChanger, i.e. the way in which a dynamic property will be updated by a player during a game

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PropertyChangerConfigurer.Constraints

Nested classes/interfaces inherited from class Configurer

Configurer.ContextLevel

Modifier and Type	Class	Description
static enum	Configurer.ContextLevel	The ContextLevel of a Configurer defines the level that it is defined at.

Field Summary

Fields

Modifier and Type	Field	Description
protected JPanel	changerControls
protected JPanel	changerLabelControls
protected PropertyChangerConfigurer.Constraints	constraints
protected JPanel	controls
protected static final Map<String, Character>	descriptionToCode
protected static final char	ENUM_CODE
protected static final char	INCR_CODE
protected FormattedExpressionConfigurer	incrConfig
protected static final String	INCREMENT_TYPE
protected JLabel	incrLabel
protected static final char	PLAIN_CODE
protected static final String	PLAIN_TYPE
protected static final char	PROMPT_CODE
protected static final String	PROMPT_TYPE
protected StringConfigurer	promptConfig
protected JLabel	promptLabel
protected static final String	SELECT_TYPE
protected TranslatingStringEnumConfigurer	typeConfig
protected JLabel	typeLabel
protected static final Map<Class<? extends PropertyChanger>, Character>	typeToCode
protected static final Map<Class<? extends PropertyChanger>, String>	typeToDescription
protected StringArrayConfigurer	validValuesConfig
protected FormattedExpressionConfigurer	valueConfig
protected JLabel	valueLabel

Fields inherited from class Configurer

changeSupport, context, contextLevel, frozen, hint, key, LIST_ENTRY_HIGHLIGHT_COLOR, name, NAME_PROPERTY, noUpdate, value

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected AbstractBuildable	context
protected Configurer.ContextLevel	contextLevel
protected boolean	frozen	When frozen is true, setting the value programmatically will not result in a PropertyChangeEvent being fired
protected String	hint	A Hint to be displayed in an empty field
protected String	key	A String the uniquely identifies this property
static final Color	LIST_ENTRY_HIGHLIGHT_COLOR	Default Highlight Color for Configurable Lists
protected String	name	A String that provides a short description of the property to the user
static final 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
PropertyChangerConfigurer(String key, String name, PropertyChangerConfigurer.Constraints constraints)

Method Summary

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
Component	getChangerControls()
Component	getChangerLabel()
Component	getControls()	GUI interface for setting the option in an editing window
PropertyChanger	getPropertyChanger()
Component	getTypeControls()
Component	getTypeLabel()
Component	getValuesControls()
String	getValueString()
boolean	isEnumType()
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
void	setContext(AbstractBuildable context)	Set the Context for this Configurer to the first ancestor that is of type GameModule or Map NOTE: The ContextLevel may already have been preset by the ConfigureFactory when the Configurer was created.
void	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
void	setValue(String s)	Set the Object value from a String
protected void	updateControls()
protected void	updateValue()

Methods inherited from class Configurer

addPropertyChangeListener, fireUpdate, getContext, getContextLevel, getHint, getKey, getName, getScreenSize, getValue, initCustomControls, isFrozen, isHighlighted, isPieceContext, removePropertyChangeListener, repack, repack, requestFocus, setContext, setContext, setContextLevel, setEnabled, setFrozen, setHint, setHintKey, setLabelVisibile, setLabelVisible, setName, setValue

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
AbstractBuildable	getContext()	Get the Context for this Configurer
Configurer.ContextLevel	getContextLevel()
String	getHint()	Return the current hint String
String	getKey()	Unique identifier
String	getName()	Plain English description of the Object
protected Dimension	getScreenSize()	Return the current screen size for use by List type configurers to allow them to take up maximum screen real estate if needed.
Object	getValue()	The Object value May be null if the Object has not been initialized
void	initCustomControls(JDialog d, Configurable target)	Initialize any custom controls / keystrokes
boolean	isFrozen()
boolean	isHighlighted()	Return the current highlighted status
boolean	isPieceContext()
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	repack()	Repack the current configurer
protected void	repack(Component controls)	Repack a dialog or window
void	requestFocus()	Move the cursor to the first input field of this Configurer
void	setContext(Buildable context)
void	setContext(Configurable context)
void	setContextLevel(Configurer.ContextLevel contextLevel)
void	setEnabled(boolean enabled)	Enable or Disable the action of this configurer/
void	setFrozen(boolean val)	If true, then don't fire PropertyChangeEvents when the value is reset
void	setHint(String hint)	Set the Hint String
void	setHintKey(String hintKey)	Set the Hint String via a I18n key
void	setLabelVisibile(boolean visible)	Deprecated, for removal: This API element is subject to removal in a future version. Use Configurer.setLabelVisible(boolean) instead.
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setName(String s)
void	setValue(Object o)	Set the Object value

Methods inherited from class Object

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

Field Details

PLAIN_TYPE

protected static final String PLAIN_TYPE

See Also:

• Constant Field Values

INCREMENT_TYPE

protected static final String INCREMENT_TYPE

See Also:

• Constant Field Values

PROMPT_TYPE

protected static final String PROMPT_TYPE

See Also:

• Constant Field Values

SELECT_TYPE

protected static final String SELECT_TYPE

See Also:

• Constant Field Values

PLAIN_CODE

protected static final char PLAIN_CODE

See Also:

• Constant Field Values

PROMPT_CODE

protected static final char PROMPT_CODE

See Also:

• Constant Field Values

ENUM_CODE

protected static final char ENUM_CODE

See Also:

• Constant Field Values

INCR_CODE

protected static final char INCR_CODE

See Also:

• Constant Field Values

typeToCode

protected static final Map<Class<? extends PropertyChanger>, Character> typeToCode

typeToDescription

protected static final Map<Class<? extends PropertyChanger>, String> typeToDescription

descriptionToCode

protected static final Map<String, Character> descriptionToCode

constraints

protected PropertyChangerConfigurer.Constraints constraints

controls

protected JPanel controls

typeLabel

protected JLabel typeLabel

typeConfig

protected TranslatingStringEnumConfigurer typeConfig

valueLabel

protected JLabel valueLabel

valueConfig

protected FormattedExpressionConfigurer valueConfig

promptLabel

protected JLabel promptLabel

promptConfig

protected StringConfigurer promptConfig

incrLabel

protected JLabel incrLabel

incrConfig

protected FormattedExpressionConfigurer incrConfig

validValuesConfig

protected StringArrayConfigurer validValuesConfig

changerLabelControls

protected JPanel changerLabelControls

changerControls

protected JPanel changerControls

Constructor Details

PropertyChangerConfigurer

public PropertyChangerConfigurer(String key,
 String name,
 PropertyChangerConfigurer.Constraints constraints)

Method Details

getControls

public Component getControls()

Description copied from class: Configurer

GUI interface for setting the option in an editing window

Specified by:

getControls in class Configurer

getTypeLabel

public Component getTypeLabel()

getTypeControls

public Component getTypeControls()

getChangerLabel

public Component getChangerLabel()

getChangerControls

public Component getChangerControls()

getValuesControls

public Component getValuesControls()

updateControls

protected void updateControls()

updateValue

protected void updateValue()

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

isEnumType

public boolean isEnumType()

getPropertyChanger

public PropertyChanger getPropertyChanger()

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

setHighlighted

public void setHighlighted(boolean highlighted)

Description copied from class: Configurer

Set the highlighted status of this configurer. It is up to individual Configurers to override this method and implement a suitable visual highlighting scheme Note: Cannot make this abstract as it will break custom code.

Overrides:

setHighlighted in class Configurer

Parameters:

highlighted - New Highlighted status

addFocusListener

public void addFocusListener(FocusListener listener)

Description copied from class: Configurer

Add a FocusListener to the Swing Components that make up this Configurer.

Overrides:

addFocusListener in class Configurer

Parameters:

listener - Focus Listener

removeFocusListener

public void removeFocusListener(FocusListener listener)

Description copied from class: Configurer

Remove a FocusListener from the Swing Components that make up this Configurer.

Overrides:

removeFocusListener in class Configurer

Parameters:

listener - Focus Listener

setContext

public void setContext(AbstractBuildable context)

Description copied from class: Configurer

Set the Context for this Configurer to the first ancestor that is of type GameModule or Map NOTE: The ContextLevel may already have been preset by the ConfigureFactory when the Configurer was created. Don't let the AutoConfigurer over-write this

Overrides:

setContext in class Configurer

Parameters:

context - Owning Configurable