Package org.eclipse.jface.bindings.keys
Class KeySequenceText
- java.lang.Object
-
- org.eclipse.jface.bindings.keys.KeySequenceText
-
public final class KeySequenceText extends Object
A wrapper around the SWT text widget that traps literal key presses and converts them into key sequences for display. There are two types of key strokes that are displayed: complete and incomplete. A complete key stroke is one with a natural key, while an incomplete one has no natural key. Incomplete key strokes are only displayed until they are made complete or their component key presses are released.
- Since:
- 3.1
-
-
Field Summary
Fields Modifier and Type Field Description static int
INFINITE
The special integer value for the maximum number of strokes indicating that an infinite number should be allowed.static String
P_KEY_SEQUENCE
The name of the property representing the current key sequence in this key sequence widget.static List
TRAPPED_KEYS
The keys trapped by this widget.
-
Constructor Summary
Constructors Constructor Description KeySequenceText(Text wrappedText)
Constructs an instance ofKeySequenceTextField
with the text field to use.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property change listener to this key sequence widget.void
clear()
Clears the text field and resets all the internal values.protected void
firePropertyChangeEvent(KeySequence oldKeySequence)
Fires a property change event to all of the listeners.KeySequence
getKeySequence()
An accessor for theKeySequence
that corresponds to the current state of the text field.int
getKeyStrokeLimit()
Returns the maximum number of strokes that are permitted in this widget at one time.void
insert(KeyStroke stroke)
Inserts the key stroke at the current insertion point.void
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given listener from this key sequence widget.void
setKeySequence(KeySequence newKeySequence)
A mutator for the key sequence stored within this widget.void
setKeyStrokeLimit(int keyStrokeLimit)
A mutator for the maximum number of strokes that are permitted in this widget at one time.
-
-
-
Field Detail
-
INFINITE
public static final int INFINITE
The special integer value for the maximum number of strokes indicating that an infinite number should be allowed.- See Also:
- Constant Field Values
-
P_KEY_SEQUENCE
public static final String P_KEY_SEQUENCE
The name of the property representing the current key sequence in this key sequence widget.- Since:
- 3.2
- See Also:
- Constant Field Values
-
TRAPPED_KEYS
public static final List TRAPPED_KEYS
The keys trapped by this widget. This list is guaranteed to be roughly accurate. Perfection is not possible, as SWT does not export traversal keys as constants.
-
-
Constructor Detail
-
KeySequenceText
public KeySequenceText(Text wrappedText)
Constructs an instance ofKeySequenceTextField
with the text field to use. If the platform is carbon (MacOS X), then the font is set to be the same font used to display accelerators in the menus.- Parameters:
wrappedText
- The text widget to wrap; must not benull
.
-
-
Method Detail
-
addPropertyChangeListener
public final void addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property change listener to this key sequence widget. It will be notified when the key sequence changes.- Parameters:
listener
- The listener to be notified when changes occur; must not benull
.- Since:
- 3.2
-
clear
public void clear()
Clears the text field and resets all the internal values.
-
firePropertyChangeEvent
protected final void firePropertyChangeEvent(KeySequence oldKeySequence)
Fires a property change event to all of the listeners.- Parameters:
oldKeySequence
- The old key sequence; must not benull
.- Since:
- 3.2
-
getKeySequence
public KeySequence getKeySequence()
An accessor for theKeySequence
that corresponds to the current state of the text field. This includes incomplete strokes.- Returns:
- The key sequence representation; never
null
.
-
insert
public void insert(KeyStroke stroke)
Inserts the key stroke at the current insertion point. This does a regular delete and insert, as if the key had been pressed.- Parameters:
stroke
- The key stroke to insert; must not benull
.
-
removePropertyChangeListener
public final void removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given listener from this key sequence widget.- Parameters:
listener
- The listener to be removed; must not benull
.- Since:
- 3.2
-
setKeySequence
public void setKeySequence(KeySequence newKeySequence)
A mutator for the key sequence stored within this widget. The text and caret position are updated.
All sequences are limited to maxStrokes number of strokes in length. If there are already that number of strokes, then it does not show incomplete strokes, and does not keep track of them.
- Parameters:
newKeySequence
- The new key sequence for this widget; may benull
if none.
-
getKeyStrokeLimit
public int getKeyStrokeLimit()
Returns the maximum number of strokes that are permitted in this widget at one time.- Returns:
- The maximum number of strokes; will be a positive integer or
INFINITE
.
-
setKeyStrokeLimit
public void setKeyStrokeLimit(int keyStrokeLimit)
A mutator for the maximum number of strokes that are permitted in this widget at one time.- Parameters:
keyStrokeLimit
- The maximum number of strokes; must be a positive integer orINFINITE
.
-
-