com.sun.javafx.scene.control.behavior

Class TextBinding.MnemonicKeyCombination

java.lang.Object

javafx.scene.input.KeyCombination

com.sun.javafx.scene.control.behavior.TextBinding.MnemonicKeyCombination

Enclosing class:

TextBinding

public static class TextBinding.MnemonicKeyCombination
extends KeyCombination

A modified version of KeyCharacterCombination, which matches on the text property of a KeyEvent instead of on the KeyCode.

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.input.KeyCombination

KeyCombination.Modifier, KeyCombination.ModifierValue

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	character

Fields inherited from class javafx.scene.input.KeyCombination

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

Constructor Summary

Constructors

Constructor and Description
MnemonicKeyCombination(java.lang.String character) Constructs a MnemonicKeyCombination for the specified main key character.

Method Summary

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

Methods inherited from class javafx.scene.input.KeyCombination

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

Methods inherited from class java.lang.Object

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

Field Detail

character

private java.lang.String character

Constructor Detail

MnemonicKeyCombination

public MnemonicKeyCombination(java.lang.String character)

Constructs a MnemonicKeyCombination for the specified main key character.

Parameters:

character - the main key character

Method Detail

getCharacter

public final java.lang.String getCharacter()

Gets the key character associated with this key combination.

Returns:

The key character associated with this key combination

match

public boolean match(KeyEvent event)

Tests whether this key combination matches the key combination in the given KeyEvent.

Overrides:

match in class KeyCombination

Parameters:

event - the key event

Returns:

true if the key combinations match, false otherwise

getName

public java.lang.String getName()

Returns a string representation of this MnemonicKeyCombination.

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 main key character enclosed in single quotes and is the last section in the returned string.

Overrides:

getName in class KeyCombination

Returns:

the string representation of this MnemonicKeyCombination

equals

public boolean equals(java.lang.Object obj)

Tests whether this MnemonicKeyCombination 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 MnemonicKeyCombination.

Overrides:

hashCode in class KeyCombination

Returns:

the hash code value