Package VASSAL.configure
Class ParameterConfigurer
java.lang.Object
VASSAL.configure.Configurer
VASSAL.configure.ParameterConfigurer
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
FieldsModifier and TypeFieldDescriptionprotected JPanelprotected StringConfigurerprotected FormattedExpressionConfigurerFields inherited from class VASSAL.configure.Configurer
changeSupport, context, contextLevel, frozen, hint, key, LIST_ENTRY_HIGHLIGHT_COLOR, name, NAME_PROPERTY, noUpdate, value -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFocusListener(FocusListener listener) Add a FocusListener to the Swing Components that make up this Configurer.protected voidGUI interface for setting the option in an editing windowvoidremoveFocusListener(FocusListener listener) Remove a FocusListener from the Swing Components that make up this Configurer.voidMove the cursor to the first input field of this ConfigurervoidsetContext(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.voidsetContextLevel(Configurer.ContextLevel contextLevel) voidsetFrozen(boolean val) Freeze the Configurer from issuing PropertyChange Events.voidsetHighlighted(boolean highlighted) Set the highlighted status of this configurer.voidSet the Object valuevoidSet the Object value from a StringvoidMethods 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
-
Field Details
-
propertyNameConfig
-
valueConfig
-
controls
-
-
Constructor Details
-
ParameterConfigurer
public ParameterConfigurer() -
ParameterConfigurer
-
-
Method Details
-
getValueString
- Specified by:
getValueStringin classConfigurer- Returns:
- a String representation of the Object value
-
getParameterValue
-
setFrozen
public void setFrozen(boolean val) Freeze the Configurer from issuing PropertyChange Events. Ensure the subsidiary Configurers are quiet also.- Overrides:
setFrozenin classConfigurer- Parameters:
val- true to freeze
-
setValue
Description copied from class:ConfigurerSet the Object value- Overrides:
setValuein classConfigurer
-
getKeyCommand
-
setValue
Description copied from class:ConfigurerSet the Object value from a String- Specified by:
setValuein classConfigurer
-
getControls
Description copied from class:ConfigurerGUI interface for setting the option in an editing window- Specified by:
getControlsin classConfigurer
-
updateValue
public void updateValue() -
buildControls
protected void buildControls() -
getPropertyNameControls
-
getValueControls
-
setHighlighted
public void setHighlighted(boolean highlighted) Description copied from class:ConfigurerSet 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:
setHighlightedin classConfigurer- Parameters:
highlighted- New Highlighted status
-
addFocusListener
Description copied from class:ConfigurerAdd a FocusListener to the Swing Components that make up this Configurer.- Overrides:
addFocusListenerin classConfigurer- Parameters:
listener- Focus Listener
-
removeFocusListener
Description copied from class:ConfigurerRemove a FocusListener from the Swing Components that make up this Configurer.- Overrides:
removeFocusListenerin classConfigurer- Parameters:
listener- Focus Listener
-
requestFocus
public void requestFocus()Description copied from class:ConfigurerMove the cursor to the first input field of this Configurer- Overrides:
requestFocusin classConfigurer
-
setContext
Description copied from class:ConfigurerSet 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:
setContextin classConfigurer- Parameters:
context- Owning Configurable
-
setContextLevel
- Overrides:
setContextLevelin classConfigurer
-