KeyStrokepublic class KeyStroke extends AWTKeyStroke | A KeyStroke represents a key action on the keyboard, or equivalent input
device. KeyStrokes can correspond to only a press or release of a particular
key, just as KEY_PRESSED and KEY_RELEASED KeyEvents do; alternately, they
can correspond to typing a specific Java character, just as KEY_TYPED
KeyEvents do. In all cases, KeyStrokes can specify modifiers (alt, shift,
control, meta, or a combination thereof) which must be present during the
action for an exact match.
KeyStrokes are used to define high-level (semantic) action events. Instead
of trapping every keystroke and throwing away the ones you are not
interested in, those keystrokes you care about automatically initiate
actions on the Components with which they are registered.
KeyStrokes are immutable, and are intended to be unique. Client code cannot
create a KeyStroke; a variant of getKeyStroke must be used
instead. These factory methods allow the KeyStroke implementation to cache
and share instances efficiently.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see {@link java.beans.XMLEncoder}. |
| Fields Summary |
|---|
| private static final long | serialVersionUIDSerial Version ID. |
| Constructors Summary |
|---|
private KeyStroke()
| private KeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)
super(keyChar, keyCode, modifiers, onKeyRelease);
|
| Methods Summary |
|---|
| public static javax.swing.KeyStroke | getKeyStroke(char keyChar)Returns a shared instance of a KeyStroke
that represents a KEY_TYPED event for the
specified character.
synchronized (AWTKeyStroke.class) {
registerSubclass(KeyStroke.class);
return (KeyStroke)getAWTKeyStroke(keyChar);
}
| | public static javax.swing.KeyStroke | getKeyStroke(char keyChar, boolean onKeyRelease)Returns an instance of a KeyStroke, specifying whether the key is
considered to be activated when it is pressed or released. Unlike all
other factory methods in this class, the instances returned by this
method are not necessarily cached or shared.
return new KeyStroke(keyChar, KeyEvent.VK_UNDEFINED, 0, onKeyRelease);
| | public static javax.swing.KeyStroke | getKeyStroke(java.lang.Character keyChar, int modifiers)Returns a shared instance of a KeyStroke, given a Character object and a
set of modifiers. Note that the first parameter is of type Character
rather than char. This is to avoid inadvertent clashes with calls to
getKeyStroke(int keyCode, int modifiers).
The modifiers consist of any combination of:
- java.awt.event.InputEvent.SHIFT_MASK (1)
- java.awt.event.InputEvent.CTRL_MASK (2)
- java.awt.event.InputEvent.META_MASK (4)
- java.awt.event.InputEvent.ALT_MASK (8)
Since these numbers are all different powers of two, any combination of
them is an integer in which each bit represents a different modifier
key. Use 0 to specify no modifiers.
synchronized (AWTKeyStroke.class) {
registerSubclass(KeyStroke.class);
return (KeyStroke)getAWTKeyStroke(keyChar, modifiers);
}
| | public static javax.swing.KeyStroke | getKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)Returns a shared instance of a KeyStroke, given a numeric key code and a
set of modifiers, specifying whether the key is activated when it is
pressed or released.
The "virtual key" constants defined in java.awt.event.KeyEvent can be
used to specify the key code. For example:
- java.awt.event.KeyEvent.VK_ENTER
- java.awt.event.KeyEvent.VK_TAB
- java.awt.event.KeyEvent.VK_SPACE
The modifiers consist of any combination of:
- java.awt.event.InputEvent.SHIFT_MASK (1)
- java.awt.event.InputEvent.CTRL_MASK (2)
- java.awt.event.InputEvent.META_MASK (4)
- java.awt.event.InputEvent.ALT_MASK (8)
Since these numbers are all different powers of two, any combination of
them is an integer in which each bit represents a different modifier
key. Use 0 to specify no modifiers.
synchronized (AWTKeyStroke.class) {
registerSubclass(KeyStroke.class);
return (KeyStroke)getAWTKeyStroke(keyCode, modifiers,
onKeyRelease);
}
| | public static javax.swing.KeyStroke | getKeyStroke(int keyCode, int modifiers)Returns a shared instance of a KeyStroke, given a numeric key code and a
set of modifiers. The returned KeyStroke will correspond to a key press.
The "virtual key" constants defined in java.awt.event.KeyEvent can be
used to specify the key code. For example:
- java.awt.event.KeyEvent.VK_ENTER
- java.awt.event.KeyEvent.VK_TAB
- java.awt.event.KeyEvent.VK_SPACE
The modifiers consist of any combination of:
- java.awt.event.InputEvent.SHIFT_MASK (1)
- java.awt.event.InputEvent.CTRL_MASK (2)
- java.awt.event.InputEvent.META_MASK (4)
- java.awt.event.InputEvent.ALT_MASK (8)
Since these numbers are all different powers of two, any combination of
them is an integer in which each bit represents a different modifier
key. Use 0 to specify no modifiers.
synchronized (AWTKeyStroke.class) {
registerSubclass(KeyStroke.class);
return (KeyStroke)getAWTKeyStroke(keyCode, modifiers);
}
| | public static javax.swing.KeyStroke | getKeyStroke(java.lang.String s)Parses a string and returns a KeyStroke.
The string must have the following syntax:
<modifiers>* (<typedID> | <pressedReleasedID>)
modifiers := shift | control | ctrl | meta | alt | altGraph
typedID := typed <typedKey>
typedKey := string of length 1 giving Unicode character.
pressedReleasedID := (pressed | released) key
key := KeyEvent key code name, i.e. the name following "VK_".
If typed, pressed or released is not specified, pressed is assumed. Here
are some examples:
"INSERT" => getKeyStroke(KeyEvent.VK_INSERT, 0);
"control DELETE" => getKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
"alt shift X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
"alt shift released X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
"typed a" => getKeyStroke('a');
In order to maintain backward-compatibility, specifying a null String,
or a String which is formatted incorrectly, returns null.
if (s == null || s.length() == 0) {
return null;
}
synchronized (AWTKeyStroke.class) {
registerSubclass(KeyStroke.class);
try {
return (KeyStroke)getAWTKeyStroke(s);
} catch (IllegalArgumentException e) {
return null;
}
}
| | public static javax.swing.KeyStroke | getKeyStrokeForEvent(java.awt.event.KeyEvent anEvent)Returns a KeyStroke which represents the stroke which generated a given
KeyEvent.
This method obtains the keyChar from a KeyTyped event, and the keyCode
from a KeyPressed or KeyReleased event. The KeyEvent modifiers are
obtained for all three types of KeyEvent.
synchronized (AWTKeyStroke.class) {
registerSubclass(KeyStroke.class);
return (KeyStroke)getAWTKeyStrokeForEvent(anEvent);
}
|
|
