@Deprecated public final class KeyStroke extends Object implements 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.
ModifierKey
,
NaturalKey
Modifier and Type | Field and Description |
---|---|
static String |
KEY_DELIMITER
Deprecated.
The delimiter between multiple keys in a single key strokes -- expressed
in the formal key stroke grammar.
|
static String |
KEY_DELIMITERS
Deprecated.
The set of delimiters for
Key objects allowed during
parsing of the formal string representation. |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object object)
Deprecated.
|
boolean |
equals(Object object)
Deprecated.
|
String |
format()
Deprecated.
Formats this key stroke into the current default look.
|
static KeyStroke |
getInstance(ModifierKey[] modifierKeys,
NaturalKey naturalKey)
Deprecated.
Gets an instance of
KeyStroke given an array of modifier
keys and a natural key. |
static KeyStroke |
getInstance(ModifierKey modifierKey,
NaturalKey naturalKey)
Deprecated.
Gets an instance of
KeyStroke given a single modifier key
and a natural key. |
static KeyStroke |
getInstance(NaturalKey naturalKey)
Deprecated.
Gets an instance of
KeyStroke given a natural key. |
static KeyStroke |
getInstance(SortedSet modifierKeys,
NaturalKey naturalKey)
Deprecated.
Gets an instance of
KeyStroke given a set of modifier
keys and a natural key. |
static KeyStroke |
getInstance(String string)
Deprecated.
Gets an instance of
KeyStroke by parsing a given a formal
string representation. |
Set |
getModifierKeys()
Deprecated.
Returns the set of modifier keys for this key stroke.
|
NaturalKey |
getNaturalKey()
Deprecated.
Returns the natural key for this key stroke.
|
int |
hashCode()
Deprecated.
|
boolean |
isComplete()
Deprecated.
Returns whether or not this key stroke is complete.
|
String |
toString()
Deprecated.
Returns the formal string representation for this key stroke.
|
public static final String KEY_DELIMITER
public static final String KEY_DELIMITERS
Key
objects allowed during
parsing of the formal string representation.public static KeyStroke getInstance(ModifierKey modifierKey, NaturalKey naturalKey)
KeyStroke
given a single modifier key
and a natural key.modifierKey
- a modifier key. Must not be null
.naturalKey
- the natural key. May be null
.null
.public static KeyStroke getInstance(ModifierKey[] modifierKeys, NaturalKey naturalKey)
KeyStroke
given an array of modifier
keys and a natural key.modifierKeys
- the array of modifier keys. This array may be empty, but it
must not be null
. If this array is not empty,
it must not contain null
elements.naturalKey
- the natural key. May be null
.null
.public static KeyStroke getInstance(NaturalKey naturalKey)
KeyStroke
given a natural key.naturalKey
- the natural key. May be null
.null
.public static KeyStroke getInstance(SortedSet modifierKeys, NaturalKey naturalKey)
KeyStroke
given a set of modifier
keys and a natural key.modifierKeys
- the set of modifier keys. This set may be empty, but it must
not be null
. If this set is not empty, it
must only contain instances of ModifierKey
.naturalKey
- the natural key. May be null
.null
.public static KeyStroke getInstance(String string) throws ParseException
KeyStroke
by parsing a given a formal
string representation.string
- the formal string representation to parse.null
.ParseException
- if the given formal string representation could not be
parsed to a valid key stroke.public int compareTo(Object object)
compareTo
in interface Comparable
Comparable.compareTo(java.lang.Object)
public boolean equals(Object object)
equals
in class Object
Object.equals(java.lang.Object)
public String format()
null
.public Set getModifierKeys()
null
. If this set is not
empty, it is guaranteed to only contain instances of ModifierKey
.public NaturalKey getNaturalKey()
null
.public int hashCode()
hashCode
in class Object
Object.hashCode()
public boolean isComplete()
null
.true
, iff the key stroke is complete.public String toString()
toString
in class Object
null
.Object.toString()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.