public final class KeySequence extends TriggerSequence implements Comparable
A KeySequence
is defined as a list of zero or more
KeyStrokes
, with the stipulation that all
KeyStroke
objects must be complete, save for the last one,
whose completeness is optional. A KeySequence
is said to be
complete if all of its KeyStroke
objects are complete.
All KeySequence
objects have a formal string representation
available via the toString()
method. There are a number of
methods to get instances of KeySequence
objects, including one
which can parse this formal string representation.
All KeySequence
objects, via the format()
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.
Modifier and Type | Field and Description |
---|---|
static String |
KEY_STROKE_DELIMITER
The delimiter between multiple key strokes in a single key sequence --
expressed in the formal key stroke grammar.
|
static String |
KEY_STROKE_DELIMITERS
The set of delimiters for
KeyStroke objects allowed during
parsing of the formal string representation. |
hashCode, triggers
Modifier | Constructor and Description |
---|---|
protected |
KeySequence(KeyStroke[] keyStrokes)
Constructs an instance of
KeySequence given a list of key
strokes. |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object object) |
String |
format()
Formats this key sequence into the current default look.
|
static KeySequence |
getInstance()
Gets an instance of
KeySequence . |
static KeySequence |
getInstance(KeySequence keySequence,
KeyStroke keyStroke)
Creates an instance of
KeySequence given a key sequence
and a key stroke. |
static KeySequence |
getInstance(KeyStroke keyStroke)
Creates an instance of
KeySequence given a single key
stroke. |
static KeySequence |
getInstance(KeyStroke[] keyStrokes)
Creates an instance of
KeySequence given an array of key
strokes. |
static KeySequence |
getInstance(List keyStrokes)
Creates an instance of
KeySequence given a list of key
strokes. |
static KeySequence |
getInstance(String string)
Creates an instance of
KeySequence by parsing a given
formal string representation. |
KeyStroke[] |
getKeyStrokes()
Returns the list of key strokes for this key sequence.
|
TriggerSequence[] |
getPrefixes()
Returns a list of prefixes for the current sequence.
|
boolean |
isComplete()
Returns whether or not this key sequence is complete.
|
String |
toString()
Returns the formal string representation for this key sequence.
|
endsWith, equals, getTriggers, hashCode, isEmpty, startsWith
public static final String KEY_STROKE_DELIMITER
public static final String KEY_STROKE_DELIMITERS
KeyStroke
objects allowed during
parsing of the formal string representation.protected KeySequence(KeyStroke[] keyStrokes)
KeySequence
given a list of key
strokes.keyStrokes
- the list of key strokes. This list may be empty, but it must
not be null
. If this list is not empty, it
must only contain instances of KeyStroke
.public static final KeySequence getInstance()
KeySequence
.null
.public static final KeySequence getInstance(KeySequence keySequence, KeyStroke keyStroke)
KeySequence
given a key sequence
and a key stroke.keySequence
- a key sequence. Must not be null
.keyStroke
- a key stroke. Must not be null
.null
.public static final KeySequence getInstance(KeyStroke keyStroke)
KeySequence
given a single key
stroke.keyStroke
- a single key stroke. Must not be null
.null
.public static final KeySequence getInstance(KeyStroke[] keyStrokes)
KeySequence
given an array of key
strokes.keyStrokes
- the array of key strokes. This array may be empty, but it must
not be null
. This array must not contain
null
elements.null
.public static final KeySequence getInstance(List keyStrokes)
KeySequence
given a list of key
strokes.keyStrokes
- the list of key strokes. This list may be empty, but it must
not be null
. If this list is not empty, it
must only contain instances of KeyStroke
.null
.public static final KeySequence getInstance(String string) throws ParseException
KeySequence
by parsing a given
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 sequence.public final int compareTo(Object object)
compareTo
in interface Comparable
public final String format()
format
in class TriggerSequence
null
.public final KeyStroke[] getKeyStrokes()
null
. If this list is not
empty, it is guaranteed to only contain instances of
KeyStroke
.public final TriggerSequence[] getPrefixes()
TriggerSequence
Returns a list of prefixes for the current sequence. A prefix is any
leading subsequence in a TriggerSequence
. A prefix is
also an instance of TriggerSequence
.
For example, consider a trigger sequence that consists of four triggers: A, B, C and D. The prefixes would be "", "A", "A B", and "A B C". The list of prefixes must always be the same as the size of the trigger list.
getPrefixes
in class TriggerSequence
null
, but may be empty. It must only
contains instances of TriggerSequence
.public final boolean isComplete()
true
, iff the key sequence is complete.public final 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.