Class KeyCodeCombination

java.lang.Object

javafx.scene.input.KeyCombination

javafx.scene.input.KeyCodeCombination

public final class KeyCodeCombination
extends KeyCombination

This class represents a key combination in which the main key is specified by its KeyCode. This is the recommended way to specify a shortcut that does not involve a symbol or punctuation (for such a shortcut a KeyCharacterCombination is preferred).

Since:

JavaFX 2.0

Nested Class Summary

Nested classes/interfaces declared in class KeyCombination

KeyCombination.Modifier, KeyCombination.ModifierValue

Modifier and Type	Class	Description
static final class	KeyCombination.Modifier	This class represents a pair of modifier key and its value.
static enum	KeyCombination.ModifierValue	ModifierValue specifies state of modifier keys.

Field Summary

Fields declared in class KeyCombination

ALT_ANY, ALT_DOWN, CONTROL_ANY, CONTROL_DOWN, META_ANY, META_DOWN, NO_MATCH, SHIFT_ANY, SHIFT_DOWN, SHORTCUT_ANY, SHORTCUT_DOWN

Modifier and Type	Field	Description
static final KeyCombination.Modifier	ALT_ANY	Modifier which specifies that the alt key can be either up or down.
static final KeyCombination.Modifier	ALT_DOWN	Modifier which specifies that the alt key must be down.
static final KeyCombination.Modifier	CONTROL_ANY	Modifier which specifies that the control key can be either up or down.
static final KeyCombination.Modifier	CONTROL_DOWN	Modifier which specifies that the control key must be down.
static final KeyCombination.Modifier	META_ANY	Modifier which specifies that the meta key can be either up or down.
static final KeyCombination.Modifier	META_DOWN	Modifier which specifies that the meta key must be down.
static final KeyCombination	NO_MATCH	A KeyCombination that will match with no events.
static final KeyCombination.Modifier	SHIFT_ANY	Modifier which specifies that the shift key can be either up or down.
static final KeyCombination.Modifier	SHIFT_DOWN	Modifier which specifies that the shift key must be down.
static final KeyCombination.Modifier	SHORTCUT_ANY	Modifier which specifies that the shortcut key can be either up or down.
static final KeyCombination.Modifier	SHORTCUT_DOWN	Modifier which specifies that the shortcut key must be down.

Constructor Summary

Constructors

Constructor	Description
KeyCodeCombination(KeyCode code, KeyCombination.Modifier... modifiers)	Constructs a KeyCodeCombination for the specified main key and with the specified list of modifiers.
KeyCodeCombination(KeyCode code, KeyCombination.ModifierValue shift, KeyCombination.ModifierValue control, KeyCombination.ModifierValue alt, KeyCombination.ModifierValue meta, KeyCombination.ModifierValue shortcut)	Constructs a KeyCodeCombination for the specified main key and with an explicit specification of all modifier keys.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests whether this KeyCodeCombination equals to the specified object.
final KeyCode	getCode()	Gets the key code associated with this key combination.
String	getName()	Returns a string representation of this KeyCodeCombination.
int	hashCode()	Returns a hash code value for this KeyCodeCombination.
boolean	match(KeyEvent event)	Tests whether this key combination matches the key combination in the given KeyEvent.

Methods declared in class KeyCombination

getAlt, getControl, getDisplayText, getMeta, getShift, getShortcut, keyCombination, toString, valueOf

Modifier and Type	Method	Description
final KeyCombination.ModifierValue	getAlt()	The state of the alt key in this key combination.
final KeyCombination.ModifierValue	getControl()	The state of the control key in this key combination.
String	getDisplayText()	Returns a string representation of this KeyCombination that is suitable for display in a user interface (for example, beside a menu item).
final KeyCombination.ModifierValue	getMeta()	The state of the meta key in this key combination.
final KeyCombination.ModifierValue	getShift()	The state of the shift key in this key combination.
final KeyCombination.ModifierValue	getShortcut()	The state of the shortcut key in this key combination.
static KeyCombination	keyCombination(String name)	Constructs a new KeyCombination from the specified string.
String	toString()	Returns a string representation of this object.
static KeyCombination	valueOf(String value)	Constructs a new KeyCombination from the specified string.

Methods declared in class Object

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

Constructor Details

KeyCodeCombination

public KeyCodeCombination(KeyCode code,
 KeyCombination.ModifierValue shift,
 KeyCombination.ModifierValue control,
 KeyCombination.ModifierValue alt,
 KeyCombination.ModifierValue meta,
 KeyCombination.ModifierValue shortcut)

Constructs a KeyCodeCombination for the specified main key and with an explicit specification of all modifier keys. Each modifier key can be set to PRESSED, RELEASED or IGNORED.

Parameters:

code - the key code of the main key

shift - the value of the shift modifier key

control - the value of the control modifier key

alt - the value of the alt modifier key

meta - the value of the meta modifier key

shortcut - the value of the shortcut modifier key

KeyCodeCombination

public KeyCodeCombination(KeyCode code,
 KeyCombination.Modifier... modifiers)

Constructs a KeyCodeCombination for the specified main key and with the specified list of modifiers. All modifier keys which are not explicitly listed are set to the default RELEASED value.

All possible modifiers which change the default modifier value are defined as constants in the KeyCombination class.

Parameters:

code - the key code of the main key

modifiers - the list of modifier keys and their corresponding values

Method Details

getCode

public final KeyCode getCode()

Gets the key code associated with this key combination.

Returns:

The key code associated with this key combination

match

public boolean match(KeyEvent event)

Tests whether this key combination matches the key combination in the given KeyEvent. It uses only the key code and the state of the modifier keys from the KeyEvent in the test. This means that the method can return true only for KEY_PRESSED and KEY_RELEASED events, but not for KEY_TYPED events, which don't have valid key codes.

Overrides:

match in class KeyCombination

Parameters:

event - the key event

Returns:

true if the key combinations match, false otherwise

getName

public String getName()

Returns a string representation of this KeyCodeCombination.

The string representation consists of sections separated by plus characters. Each section specifies either a modifier key or the main key.

A modifier key section contains the KeyCode name of a modifier key. It can be prefixed with the Ignored keyword. A non-prefixed modifier key implies its PRESSED value while the prefixed version implies the IGNORED value. If some modifier key is not specified in the string at all, it means it has the default RELEASED value.

The main key section contains the key code name of the main key and is the last section in the returned string.

Overrides:

getName in class KeyCombination

Returns:

the string representation of this KeyCodeCombination

equals

public boolean equals(Object obj)

Tests whether this KeyCodeCombination equals to the specified object.

Overrides:

equals in class KeyCombination

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise

hashCode

public int hashCode()

Returns a hash code value for this KeyCodeCombination.

Overrides:

hashCode in class KeyCombination

Returns:

the hash code value