Package VASSAL.tools

Class NamedKeyStroke

java.lang.Object

VASSAL.tools.NamedKeyStroke

public class NamedKeyStroke
extends Object

A NamedKeyStroke is a KeyStroke with a name given by the module developer. An actual KeyStroke is allocated from a pool of KeyStrokes at run-time and associated with the name. KeyStrokes have been replaced by NamedKeyStrokes within Vassal wherever the Stroke is saved. A standard KeyStroke is represented as a NamedKeyStroke with a null or zero-length name. NamedKeyStroke variables should never be null, use NULL_KEYSTROKE to represent a NamedKeyStroke with no value.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name
static final NamedKeyStroke	NULL_KEYSTROKE
protected final KeyStroke	stroke

Constructor Summary

Constructors

Constructor	Description
NamedKeyStroke()
NamedKeyStroke(int code, int modifiers)
NamedKeyStroke(int code, int modifiers, String s)
NamedKeyStroke(String s)
NamedKeyStroke(KeyStroke k)
NamedKeyStroke(KeyStroke k, String s)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDesc()
KeyStroke	getKeyStroke()	Return the allocated KeyStroke associated with this KeyStroke
static NamedKeyStroke	getKeyStrokeForEvent(KeyEvent e)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getName()
static NamedKeyStroke	getNamedKeyStroke(char c)	Deprecated, for removal: This API element is subject to removal in a future version.
static NamedKeyStroke	getNamedKeyStroke(char c, int mod)	Deprecated, for removal: This API element is subject to removal in a future version.
static NamedKeyStroke	getNamedKeyStroke(int c, int mod)	Deprecated, for removal: This API element is subject to removal in a future version.
KeyStroke	getStroke()	Return the raw KeyStroke stored in this NamedKeyStroke
int	hashCode()
boolean	isNamed()	Is there a name associated with this KeyStroke?
boolean	isNull()
static NamedKeyStroke	of(char c)
static NamedKeyStroke	of(char c, int modifiers)
static NamedKeyStroke	of(int code, int modifiers)
static NamedKeyStroke	of(int code, int modifiers, String s)
static NamedKeyStroke	of(KeyEvent e)
static NamedKeyStroke	of(String s)
static NamedKeyStroke	of(KeyStroke k)
static NamedKeyStroke	of(KeyStroke k, String s)

Methods inherited from class java.lang.Object

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

Field Details

NULL_KEYSTROKE

public static final NamedKeyStroke NULL_KEYSTROKE

stroke

protected final KeyStroke stroke

name

protected final String name

Constructor Details

NamedKeyStroke

public NamedKeyStroke(int code,
 int modifiers)

NamedKeyStroke

public NamedKeyStroke(int code,
 int modifiers,
 String s)

NamedKeyStroke

public NamedKeyStroke(KeyStroke k)

NamedKeyStroke

public NamedKeyStroke(String s)

NamedKeyStroke

public NamedKeyStroke()

NamedKeyStroke

public NamedKeyStroke(KeyStroke k,
 String s)

Method Details

isNamed

public boolean isNamed()

Is there a name associated with this KeyStroke? No name means it is a standard KeyStroke.

Returns:

True if a name associated with this Keystroke

getName

public String getName()

isNull

public boolean isNull()

getStroke

public KeyStroke getStroke()

Return the raw KeyStroke stored in this NamedKeyStroke

Returns:

KeyStroke

getDesc

public String getDesc()

Returns:

If a Named keystroke, returns the name string; otherwise if a "real" keystroke returns a string naming the keystroke (e.g. "Ctrl+C")

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getKeyStroke

public KeyStroke getKeyStroke()

Return the allocated KeyStroke associated with this KeyStroke

getNamedKeyStroke

@Deprecated(since="2021-12-01",
            forRemoval=true)
public static NamedKeyStroke getNamedKeyStroke(char c)

Deprecated, for removal: This API element is subject to removal in a future version.

getNamedKeyStroke

@Deprecated(since="2021-12-01",
            forRemoval=true)
public static NamedKeyStroke getNamedKeyStroke(char c,
 int mod)

Deprecated, for removal: This API element is subject to removal in a future version.

getNamedKeyStroke

@Deprecated(since="2021-12-01",
            forRemoval=true)
public static NamedKeyStroke getNamedKeyStroke(int c,
 int mod)

Deprecated, for removal: This API element is subject to removal in a future version.

getKeyStrokeForEvent

@Deprecated(since="2021-12-01",
            forRemoval=true)
public static NamedKeyStroke getKeyStrokeForEvent(KeyEvent e)

Deprecated, for removal: This API element is subject to removal in a future version.

of

public static NamedKeyStroke of(char c)

of

public static NamedKeyStroke of(KeyEvent e)

of

public static NamedKeyStroke of(char c,
 int modifiers)

of

public static NamedKeyStroke of(int code,
 int modifiers)

of

public static NamedKeyStroke of(int code,
 int modifiers,
 String s)

of

public static NamedKeyStroke of(KeyStroke k)

of

public static NamedKeyStroke of(String s)

of

public static NamedKeyStroke of(KeyStroke k,
 String s)