Class KeySequence
- java.lang.Object
-
- org.eclipse.ui.keys.KeySequence
-
- All Implemented Interfaces:
Comparable
@Deprecated public final class KeySequence extends Object implements Comparable
Deprecated.Please use org.eclipse.jface.bindings.keys.KeySequenceA
KeySequence
is defined as a list of zero or moreKeyStrokes
, with the stipulation that allKeyStroke
objects must be complete, save for the last one, whose completeness is optional. AKeySequence
is said to be complete if all of itsKeyStroke
objects are complete.All
KeySequence
objects have a formal string representation available via thetoString()
method. There are a number of methods to get instances ofKeySequence
objects, including one which can parse this formal string representation.All
KeySequence
objects, via theformat()
method, provide a version of their formal string representation translated by platform and locale, suitable for display to a user.KeySequence
objects are immutable. Clients are not permitted to extend this class.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description static String
KEY_STROKE_DELIMITER
Deprecated.The delimiter between multiple key strokes in a single key sequence -- expressed in the formal key stroke grammar.static String
KEY_STROKE_DELIMITERS
Deprecated.The set of delimiters forKeyStroke
objects allowed during parsing of the formal string representation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
compareTo(Object object)
Deprecated.boolean
endsWith(KeySequence keySequence, boolean equals)
Deprecated.Returns whether or not this key sequence ends with the given key sequence.boolean
equals(Object object)
Deprecated.String
format()
Deprecated.Formats this key sequence into the current default look.static KeySequence
getInstance()
Deprecated.Gets an instance ofKeySequence
.static KeySequence
getInstance(String string)
Deprecated.Gets an instance ofKeySequence
by parsing a given a formal string representation.static KeySequence
getInstance(List keyStrokes)
Deprecated.Gets an instance ofKeySequence
given a list of key strokes.static KeySequence
getInstance(KeySequence newKeySequence)
Deprecated.Gets an instance ofKeySequence
given a new-style key sequence.static KeySequence
getInstance(KeySequence keySequence, KeyStroke keyStroke)
Deprecated.Gets an instance ofKeySequence
given a key sequence and a key stroke.static KeySequence
getInstance(KeyStroke keyStroke)
Deprecated.Gets an instance ofKeySequence
given a single key stroke.static KeySequence
getInstance(KeyStroke[] keyStrokes)
Deprecated.Gets an instance ofKeySequence
given an array of key strokes.List
getKeyStrokes()
Deprecated.Returns the list of key strokes for this key sequence.int
hashCode()
Deprecated.boolean
isComplete()
Deprecated.Returns whether or not this key sequence is complete.boolean
isEmpty()
Deprecated.Returns whether or not this key sequence is empty.boolean
startsWith(KeySequence keySequence, boolean equals)
Deprecated.Returns whether or not this key sequence starts with the given key sequence.String
toString()
Deprecated.Returns the formal string representation for this key sequence.
-
-
-
Field Detail
-
KEY_STROKE_DELIMITER
public static final String KEY_STROKE_DELIMITER
Deprecated.The delimiter between multiple key strokes in a single key sequence -- 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:
- Constant Field Values
-
KEY_STROKE_DELIMITERS
public static final String KEY_STROKE_DELIMITERS
Deprecated.The set of delimiters forKeyStroke
objects allowed during parsing of the formal string representation.- See Also:
- Constant Field Values
-
-
Method Detail
-
getInstance
public static KeySequence getInstance()
Deprecated.Gets an instance ofKeySequence
.- Returns:
- a key sequence. This key sequence will have no key strokes.
Guaranteed not to be
null
.
-
getInstance
public static KeySequence getInstance(KeySequence keySequence, KeyStroke keyStroke)
Deprecated.Gets an instance ofKeySequence
given a key sequence and a key stroke.- Parameters:
keySequence
- a key sequence. Must not benull
.keyStroke
- a key stroke. Must not benull
.- Returns:
- a key sequence that is equal to the given key sequence with the given
key stroke appended to the end. Guaranteed not to be
null
.
-
getInstance
public static KeySequence getInstance(KeyStroke keyStroke)
Deprecated.Gets an instance ofKeySequence
given a single key stroke.- Parameters:
keyStroke
- a single key stroke. Must not benull
.- Returns:
- a key sequence. Guaranteed not to be
null
.
-
getInstance
public static KeySequence getInstance(KeyStroke[] keyStrokes)
Deprecated.Gets an instance ofKeySequence
given an array of key strokes.- Parameters:
keyStrokes
- the array of key strokes. This array may be empty, but it must not benull
. This array must not containnull
elements.- Returns:
- a key sequence. Guaranteed not to be
null
.
-
getInstance
public static KeySequence getInstance(List keyStrokes)
Deprecated.Gets an instance ofKeySequence
given a list of key strokes.- Parameters:
keyStrokes
- the list of key strokes. This list may be empty, but it must not benull
. If this list is not empty, it must only contain instances ofKeyStroke
.- Returns:
- a key sequence. Guaranteed not to be
null
.
-
getInstance
public static KeySequence getInstance(KeySequence newKeySequence)
Deprecated.Gets an instance ofKeySequence
given a new-style key sequence.- Parameters:
newKeySequence
- The new-style key sequence to convert into a legacy key sequence; must not benull
.- Returns:
- a key sequence; never
null
.
-
getInstance
public static KeySequence getInstance(String string) throws ParseException
Deprecated.Gets an instance ofKeySequence
by parsing a given a formal string representation.- Parameters:
string
- the formal string representation to parse.- Returns:
- a key sequence. Guaranteed not to be
null
. - Throws:
ParseException
- if the given formal string representation could not be parsed to a valid key sequence.
-
compareTo
public int compareTo(Object object)
Deprecated.- Specified by:
compareTo
in interfaceComparable
-
endsWith
public boolean endsWith(KeySequence keySequence, boolean equals)
Deprecated.Returns whether or not this key sequence ends with the given key sequence.- Parameters:
keySequence
- a key sequence. Must not benull
.equals
- whether or not an identical key sequence should be considered as a possible match.- Returns:
true
, iff the given key sequence ends with this key sequence.
-
format
public String format()
Deprecated.Formats this key sequence into the current default look.- Returns:
- A string representation for this key sequence using the default look;
never
null
.
-
getKeyStrokes
public List getKeyStrokes()
Deprecated.Returns the list of key strokes for this key sequence.- Returns:
- the list of key strokes keys. This list may be empty, but is
guaranteed not to be
null
. If this list is not empty, it is guaranteed to only contain instances ofKeyStroke
.
-
isComplete
public boolean isComplete()
Deprecated.Returns whether or not this key sequence is complete. Key sequences are complete iff all of their key strokes are complete.- Returns:
true
, iff the key sequence is complete.
-
isEmpty
public boolean isEmpty()
Deprecated.Returns whether or not this key sequence is empty. Key sequences are complete iff they have no key strokes.- Returns:
true
, iff the key sequence is empty.
-
startsWith
public boolean startsWith(KeySequence keySequence, boolean equals)
Deprecated.Returns whether or not this key sequence starts with the given key sequence.- Parameters:
keySequence
- a key sequence. Must not benull
.equals
- whether or not an identical key sequence should be considered as a possible match.- Returns:
true
, iff the given key sequence starts with this key sequence.
-
-