Class KeyStroke
- All Implemented Interfaces:
Comparable
A KeyStroke
is defined as an optional set of modifier keys
followed optionally by a natural key. A KeyStroke
is said to be
complete if it contains a natural key. A natural key is any Unicode character
(e.g., "backspace", etc.), any character belonging to a natural language
(e.g., "A", "1", "[", etc.), or any special control character specific to
computers (e.g., "F10", "PageUp", etc.).
All KeyStroke
objects have a formal string representation
available via the toString()
method. There are a number of
methods to get instances of KeyStroke
objects, including one
which can parse this formal string representation.
All KeyStroke
objects, via the format()
method,
provide a version of their formal string representation translated by
platform and locale, suitable for display to a user.
KeyStroke
objects are immutable. Clients are not permitted to
extend this class.
- Since:
- 3.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Deprecated, for removal: This API element is subject to removal in a future version.The delimiter between multiple keys in a single key strokes -- expressed in the formal key stroke grammar.static final String
Deprecated, for removal: This API element is subject to removal in a future version.The set of delimiters forKey
objects allowed during parsing of the formal string representation. -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated, for removal: This API element is subject to removal in a future version.boolean
Deprecated, for removal: This API element is subject to removal in a future version.format()
Deprecated, for removal: This API element is subject to removal in a future version.Formats this key stroke into the current default look.static KeyStroke
getInstance
(String string) Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
by parsing a given a formal string representation.static KeyStroke
getInstance
(SortedSet modifierKeys, NaturalKey naturalKey) Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given a set of modifier keys and a natural key.static KeyStroke
getInstance
(ModifierKey[] modifierKeys, NaturalKey naturalKey) Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given an array of modifier keys and a natural key.static KeyStroke
getInstance
(ModifierKey modifierKey, NaturalKey naturalKey) Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given a single modifier key and a natural key.static KeyStroke
getInstance
(NaturalKey naturalKey) Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given a natural key.Deprecated, for removal: This API element is subject to removal in a future version.Returns the set of modifier keys for this key stroke.Deprecated, for removal: This API element is subject to removal in a future version.Returns the natural key for this key stroke.int
hashCode()
Deprecated, for removal: This API element is subject to removal in a future version.boolean
Deprecated, for removal: This API element is subject to removal in a future version.Returns whether or not this key stroke is complete.toString()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the formal string representation for this key stroke.
-
Field Details
-
KEY_DELIMITER
Deprecated, for removal: This API element is subject to removal in a future version.The delimiter between multiple keys in a single key strokes -- expressed in the formal key stroke grammar. This is not to be displayed to the user. It is only intended as an internal representation.- See Also:
-
KEY_DELIMITERS
Deprecated, for removal: This API element is subject to removal in a future version.The set of delimiters forKey
objects allowed during parsing of the formal string representation.- See Also:
-
-
Method Details
-
getInstance
Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given a single modifier key and a natural key.- Parameters:
modifierKey
- a modifier key. Must not benull
.naturalKey
- the natural key. May benull
.- Returns:
- a key stroke. Guaranteed not to be
null
.
-
getInstance
Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given an array of modifier keys and a natural key.- Parameters:
modifierKeys
- the array of modifier keys. This array may be empty, but it must not benull
. If this array is not empty, it must not containnull
elements.naturalKey
- the natural key. May benull
.- Returns:
- a key stroke. Guaranteed not to be
null
.
-
getInstance
Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given a natural key.- Parameters:
naturalKey
- the natural key. May benull
.- Returns:
- a key stroke. This key stroke will have no modifier keys. Guaranteed
not to be
null
.
-
getInstance
Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
given a set of modifier keys and a natural key.- Parameters:
modifierKeys
- the set of modifier keys. This set may be empty, but it must not benull
. If this set is not empty, it must only contain instances ofModifierKey
.naturalKey
- the natural key. May benull
.- Returns:
- a key stroke. Guaranteed not to be
null
.
-
getInstance
Deprecated, for removal: This API element is subject to removal in a future version.Gets an instance ofKeyStroke
by parsing a given a formal string representation.- Parameters:
string
- the formal string representation to parse.- Returns:
- a key stroke. Guaranteed not to be
null
. - Throws:
ParseException
- if the given formal string representation could not be parsed to a valid key stroke.
-
compareTo
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
compareTo
in interfaceComparable
- See Also:
-
equals
Deprecated, for removal: This API element is subject to removal in a future version. -
format
Deprecated, for removal: This API element is subject to removal in a future version.Formats this key stroke into the current default look.- Returns:
- A string representation for this key stroke using the default look;
never
null
.
-
getModifierKeys
Deprecated, for removal: This API element is subject to removal in a future version.Returns the set of modifier keys for this key stroke.- Returns:
- the set of modifier keys. This set may be empty, but is guaranteed
not to be
null
. If this set is not empty, it is guaranteed to only contain instances ofModifierKey
.
-
getNaturalKey
Deprecated, for removal: This API element is subject to removal in a future version.Returns the natural key for this key stroke.- Returns:
- the natural key. May be
null
.
-
hashCode
public int hashCode()Deprecated, for removal: This API element is subject to removal in a future version. -
isComplete
public boolean isComplete()Deprecated, for removal: This API element is subject to removal in a future version.Returns whether or not this key stroke is complete. Key strokes are complete iff they have a natural key which is notnull
.- Returns:
true
, iff the key stroke is complete.
-
toString
Deprecated, for removal: This API element is subject to removal in a future version.Returns the formal string representation for this key stroke.
-