Package VASSAL.configure

Class ParameterConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.ParameterConfigurer

public class ParameterConfigurer
extends Configurer

A Configurer for the Parameter class The value stored as the value in the Configurer is a Parameter Object

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.configure.Configurer

Configurer.ContextLevel

Field Summary

Fields

Modifier and Type	Field	Description
protected JPanel	controls
protected StringConfigurer	propertyNameConfig
protected FormattedExpressionConfigurer	valueConfig

Fields inherited from class VASSAL.configure.Configurer

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

Constructor Summary

Constructors

Constructor	Description
ParameterConfigurer()
ParameterConfigurer(Parameter parameter)

Method Summary

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
protected void	buildControls()
Component	getControls()	GUI interface for setting the option in an editing window
DynamicProperty.DynamicKeyCommand	getKeyCommand()
Parameter	getParameterValue()
Component	getPropertyNameControls()
Component	getValueControls()
String	getValueString()
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
void	requestFocus()	Move the cursor to the first input field of 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	setContextLevel(Configurer.ContextLevel contextLevel)
void	setFrozen(boolean val)	Freeze the Configurer from issuing PropertyChange Events.
void	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
void	setValue(Object value)	Set the Object value
void	setValue(String s)	Set the Object value from a String
void	updateValue()

Methods inherited from class VASSAL.configure.Configurer

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

Methods inherited from class java.lang.Object

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

Field Details

propertyNameConfig

protected StringConfigurer propertyNameConfig

valueConfig

protected FormattedExpressionConfigurer valueConfig

controls

protected JPanel controls

Constructor Details

ParameterConfigurer

public ParameterConfigurer()

ParameterConfigurer

public ParameterConfigurer(Parameter parameter)

Method Details

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

getParameterValue

public Parameter getParameterValue()

setFrozen

public void setFrozen(boolean val)

Freeze the Configurer from issuing PropertyChange Events. Ensure the subsidiary Configurers are quiet also.

Overrides:

setFrozen in class Configurer

Parameters:

val - true to freeze

setValue

public void setValue(Object value)

Description copied from class: Configurer

Set the Object value

Overrides:

setValue in class Configurer

getKeyCommand

public DynamicProperty.DynamicKeyCommand getKeyCommand()

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

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

updateValue

public void updateValue()

buildControls

protected void buildControls()

getPropertyNameControls

public Component getPropertyNameControls()

getValueControls

public Component getValueControls()

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

requestFocus

public void requestFocus()

Description copied from class: Configurer

Move the cursor to the first input field of this Configurer

Overrides:

requestFocus in class Configurer

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

setContextLevel

public void setContextLevel(Configurer.ContextLevel contextLevel)

Overrides:

setContextLevel in class Configurer