Class DynamicKeyCommandConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.DynamicKeyCommandConfigurer

public class DynamicKeyCommandConfigurer
extends Configurer

Nested Class Summary

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 StringConfigurer	commandConfig
protected JPanel	controls
protected final NamedHotKeyConfigurer	keyConfig
protected PropertyChangerConfigurer	propChangeConfig
protected DynamicProperty	target

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
DynamicKeyCommandConfigurer(DynamicProperty target)

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	getChangerControls()
Component	getCommandControls()
Component	getControls()	GUI interface for setting the option in an editing window
DynamicProperty.DynamicKeyCommand	getKeyCommand()
Component	getKeyControls()
DynamicProperty	getTarget()
Component	getTypeControls()
Component	getValuesControls()
String	getValueString()
boolean	isEnumType()
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	setTarget(DynamicProperty target)
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 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

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	setContext(Buildable context)
void	setContext(Configurable context)
void	setEnabled(boolean enabled)	Enable or Disable the action of this configurer/
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)

Methods inherited from class Object

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

Field Details

keyConfig

protected final NamedHotKeyConfigurer keyConfig

propChangeConfig

protected PropertyChangerConfigurer propChangeConfig

commandConfig

protected StringConfigurer commandConfig

controls

protected JPanel controls

target

protected DynamicProperty target

Constructor Details

DynamicKeyCommandConfigurer

public DynamicKeyCommandConfigurer(DynamicProperty target)

Method Details

getTarget

public DynamicProperty getTarget()

setTarget

public void setTarget(DynamicProperty target)

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

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

getCommandControls

public Component getCommandControls()

getKeyControls

public Component getKeyControls()

getTypeControls

public Component getTypeControls()

getChangerControls

public Component getChangerControls()

getValuesControls

public Component getValuesControls()

isEnumType

public boolean isEnumType()

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