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 JavaBeans
has been added to the java.beans package.
Please see java..
javax.swing.text.Keymap , getKeyStroke
| Modifier and Type | Field and Description |
|---|---|
| private static final long | serialVersionUID
Use serialVersionUID from JDK 1.4 for interoperability.
|
| Access | Constructor and Description |
|---|---|
| private | |
| private |
| Modifier and Type | Method and Description |
|---|---|
| public static KeyStroke | Returns: a KeyStroke object for that keythe character value for a keyboard key keyChar)Returns a shared instance of a |
| public static KeyStroke | Returns: a KeyStroke object for that keythe character value for a keyboard key keyChar, boolean true if this KeyStroke corresponds to a
key release; false otherwise.
Deprecated
use getKeyStroke(char)
Returns an instance of a KeyStroke, specifying whether the key is
considered to be activated when it is pressed or released.
|
| public static KeyStroke | Returns: an KeyStroke object for that keythe Character object for a keyboard character keyChar, int a bitwise-ored combination of any modifiers modifiers)Returns a shared instance of a |
| public static KeyStroke | Returns: a KeyStroke object for that keyan int specifying the numeric code for a keyboard key keyCode, int a bitwise-ored combination of any modifiers modifiers, boolean true if the KeyStroke should represent
a key release; false otherwise.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. |
| public static KeyStroke | Returns: a KeyStroke object for that keyan int specifying the numeric code for a keyboard key keyCode, int a bitwise-ored combination of any modifiers modifiers)Returns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers. |
| public static KeyStroke | Returns: a KeyStroke object for that String, or null if the specified String is null, or is formatted incorrectlya String formatted as described above s)Parses a string and returns a |
| public static KeyStroke | Returns: the KeyStroke that precipitated the eventthe KeyEvent from which to obtain the KeyStroke anEvent)Returns a KeyStroke which represents the stroke which generated a given KeyEvent. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides java. Use serialVersionUID from JDK 1.4 for interoperability. | |
| KeyStroke | back to summary |
|---|---|
| private KeyStroke() | |
| KeyStroke | back to summary |
|---|---|
| private KeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease) | |
| getKeyStroke | back to summary |
|---|---|
| public static KeyStroke getKeyStroke(char keyChar) Returns a shared instance of a
| |
| getKeyStroke | back to summary |
|---|---|
| public static KeyStroke getKeyStroke(char keyChar, boolean onKeyRelease)
Deprecated use getKeyStroke(char) 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.
| |
| getKeyStroke | back to summary |
|---|---|
| public static KeyStroke getKeyStroke(Character keyChar, int modifiers) Returns a shared instance of a
| |
| getKeyStroke | back to summary |
|---|---|
| public static 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.getExtendedKeyCodeForChar.
The modifiers consist of any combination of:
| |
| getKeyStroke | back to summary |
|---|---|
| public static 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.getExtendedKeyCodeForChar.
The modifiers consist of any combination of:
| |
| getKeyStroke | back to summary |
|---|---|
| public static KeyStroke getKeyStroke(String s) Parses a string and returns a <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.
| |
| getKeyStrokeForEvent | back to summary |
|---|---|
| public static KeyStroke getKeyStrokeForEvent(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.
| |