Serializablepublic class KeyStroke extends AWTKeyStroke
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 XMLEncoder.
| Modifier and Type | Method | Description |
|---|---|---|
static KeyStroke |
getKeyStroke |
Returns a shared instance of a KeyStroke that represents a KEY_TYPED event for the specified character. |
static KeyStroke |
getKeyStroke |
Deprecated. use getKeyStroke(char) |
static KeyStroke |
getKeyStroke |
Returns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers. |
static KeyStroke |
getKeyStroke |
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. |
static KeyStroke |
getKeyStroke |
Returns a shared instance of a KeyStroke that represents a KEY_TYPED event for the specified Character object and a set of modifiers. |
static KeyStroke |
getKeyStroke |
Parses a string and returns a KeyStroke. |
static KeyStroke |
getKeyStrokeForEvent |
Returns a KeyStroke which represents the stroke which generated a given KeyEvent. |
equals, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStroke, getAWTKeyStrokeForEvent, getKeyChar, getKeyCode, getKeyEventType, getModifiers, hashCode, isOnKeyRelease, readResolve, registerSubclass, toString
public static KeyStroke getKeyStroke(char keyChar)
KeyStroke that represents a KEY_TYPED event for the specified character.keyChar - the character value for a keyboard key@Deprecated public static KeyStroke getKeyStroke(char keyChar, boolean onKeyRelease)
keyChar - the character value for a keyboard keyonKeyRelease - true if this KeyStroke corresponds to a key release; false otherwise.public static KeyStroke getKeyStroke(Character keyChar, int modifiers)
KeyStroke that represents a KEY_TYPED event for the specified 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 following:keyChar - the Character object for a keyboard charactermodifiers - a bitwise-ored combination of any modifiersIllegalArgumentException - if keyChar is nullpublic static KeyStroke getKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)
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:keyCode - an int specifying the numeric code for a keyboard keymodifiers - a bitwise-ored combination of any modifiersonKeyRelease - true if the KeyStroke should represent a key release; false otherwise.public static KeyStroke getKeyStroke(int keyCode, int modifiers)
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:keyCode - an int specifying the numeric code for a keyboard keymodifiers - a bitwise-ored combination of any modifierspublic static KeyStroke getKeyStrokeForEvent(KeyEvent anEvent)
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.
anEvent - the KeyEvent from which to obtain the KeyStrokeNullPointerException - if anEvent is nullpublic static KeyStroke getKeyStroke(String s)
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.s - a String formatted as described above
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/KeyStroke.html