Class NamedHotKeyConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.NamedHotKeyConfigurer

All Implemented Interfaces:

FocusListener, EventListener

public class NamedHotKeyConfigurer
extends Configurer
implements FocusListener

A configurer for Configuring Key Strokes. It allows the entry of either a standard keystroke, or a Named command. It contains two separate Text fields, one for the Name and one for the keystroke. A user can fill in one or the other. Filling in one, clears the other. This Configurer has a limited undo function. Whenever one of the two fields gains focus, the current state of the Configurer is saved and the Undo button enabled. The undo button will return to the state when that field gained focus. This provides a one-step undo if a user accidentally types in one of the fields and wipes out data in the other field.

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 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
NamedHotKeyConfigurer()
NamedHotKeyConfigurer(String key, String name)
NamedHotKeyConfigurer(String key, String name, NamedKeyStroke val)
NamedHotKeyConfigurer(String key, String name, NamedKeyStroke val, int defaultFieldLength)
NamedHotKeyConfigurer(NamedKeyStroke val)
NamedHotKeyConfigurer(NamedKeyStroke val, int defaultFieldLength)

Method Summary

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
static NamedKeyStroke	decode(String s)	Decode a String into a NamedKeyStroke
static String	encode(NamedKeyStroke stroke)	Encode a NamedKeyStroke into a String
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
Component	getControls()	GUI interface for setting the option in an editing window
static String	getFancyString(NamedKeyStroke k)
static String	getString(KeyStroke k)	Return a string representation of a KeyStroke
static String	getString(NamedKeyStroke k)	Return a String representation of a NamedKeyStroke
NamedKeyStroke	getValueNamedKeyStroke()
String	getValueString()
boolean	isNamed()
protected boolean	isPrintableAscii(char c)
protected boolean	isPrintableAscii(int i)
String	keyToString()
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	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String
protected void	updateVisibility()

Methods inherited from class Configurer

addPropertyChangeListener, fireUpdate, getContext, getContextLevel, getHint, getKey, getName, getScreenSize, getValue, initCustomControls, isFrozen, isHighlighted, isPieceContext, removePropertyChangeListener, repack, repack, setContext, setContext, setContext, setContextLevel, setEnabled, setFrozen, 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(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	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)

Methods inherited from class Object

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

Constructor Details

NamedHotKeyConfigurer

public NamedHotKeyConfigurer(String key,
 String name,
 NamedKeyStroke val,
 int defaultFieldLength)

NamedHotKeyConfigurer

public NamedHotKeyConfigurer(String key,
 String name,
 NamedKeyStroke val)

NamedHotKeyConfigurer

public NamedHotKeyConfigurer(String key,
 String name)

NamedHotKeyConfigurer

public NamedHotKeyConfigurer(NamedKeyStroke val,
 int defaultFieldLength)

NamedHotKeyConfigurer

public NamedHotKeyConfigurer(NamedKeyStroke val)

NamedHotKeyConfigurer

public NamedHotKeyConfigurer()

Method Details

getFancyString

public static String getFancyString(NamedKeyStroke k)

getString

public static String getString(NamedKeyStroke k)

Return a String representation of a NamedKeyStroke

Parameters:

k - NamedKeyStroke

Returns:

String representation

getString

public static String getString(KeyStroke k)

Return a string representation of a KeyStroke

Parameters:

k - KeyStroke

Returns:

String representation

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

getValueNamedKeyStroke

public NamedKeyStroke getValueNamedKeyStroke()

isNamed

public boolean isNamed()

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

setValue

public void setValue(Object o)

Description copied from class: Configurer

Set the Object value

Overrides:

setValue in class Configurer

updateVisibility

protected void updateVisibility()

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

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

keyToString

public String keyToString()

isPrintableAscii

protected boolean isPrintableAscii(char c)

isPrintableAscii

protected boolean isPrintableAscii(int i)

decode

public static NamedKeyStroke decode(String s)

Decode a String into a NamedKeyStroke

encode

public static String encode(NamedKeyStroke stroke)

Encode a NamedKeyStroke into a String

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