|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.bindings.keys.KeySequenceText
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.
Field Summary | |
---|---|
static int |
INFINITE
The special integer value for the maximum number of strokes indicating that an infinite number should be allowed. |
static List |
TRAPPED_KEYS
The keys trapped by this widget. |
Constructor Summary | |
---|---|
KeySequenceText(Text wrappedText)
Constructs an instance of KeySequenceTextField with the
text field to use. |
Method Summary | |
---|---|
void |
clear()
Clears the text field and resets all the internal values. |
KeySequence |
getKeySequence()
An accessor for the KeySequence 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 |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int INFINITE
public static final List TRAPPED_KEYS
Constructor Detail |
public KeySequenceText(Text wrappedText)
KeySequenceTextField
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.
wrappedText
- The text widget to wrap; must not be null
.Method Detail |
public void clear()
public KeySequence getKeySequence()
KeySequence
that corresponds to the
current state of the text field. This includes incomplete strokes.
null
.public void insert(KeyStroke stroke)
stroke
- The key stroke to insert; must not be null
.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.
newKeySequence
- The new key sequence for this widget; may be null
if none.public int getKeyStrokeLimit()
INFINITE
.public void setKeyStrokeLimit(int keyStrokeLimit)
keyStrokeLimit
- The maximum number of strokes; must be a positive integer or
INFINITE
.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.