Class HotKeyConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.HotKeyConfigurer

All Implemented Interfaces:

KeyListener, EventListener

public class HotKeyConfigurer
extends Configurer
implements KeyListener

A Configurer for KeyStroke values

Nested Class Summary

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

Configurer.ContextLevel

Field Summary

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
HotKeyConfigurer(String key, String name)
HotKeyConfigurer(String key, String name, KeyStroke val)

Method Summary

Modifier and Type	Method	Description
static KeyStroke	decode(String s)	Decode a String into a KeyStroke
static String	encode(KeyStroke stroke)	Encode a KeyStroke into a String
Component	getControls()	GUI interface for setting the option in an editing window
static String	getString(KeyStroke k)	A plain text representation of a KeyStroke.
String	getValueString()
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
String	keyToString()
void	keyTyped(KeyEvent e)
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String

Methods inherited from class VASSAL.configure.Configurer

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

Methods inherited from class java.lang.Object

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

Constructor Details

HotKeyConfigurer

public HotKeyConfigurer(String key,
 String name)

HotKeyConfigurer

public HotKeyConfigurer(String key,
 String name,
 KeyStroke val)

Method Details

setValue

public void setValue(Object o)

Description copied from class: Configurer

Set the Object value

Overrides:

setValue in class Configurer

keyToString

public String keyToString()

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

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

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

getString

public static String getString(KeyStroke k)

A plain text representation of a KeyStroke. Doesn't differ much from KeyEvent.getKeyText(int)

decode

public static KeyStroke decode(String s)

Decode a String into a KeyStroke

encode

public static String encode(KeyStroke stroke)

Encode a KeyStroke into a String