KeyStroke (Java SE 15 & JDK 15) (original) (raw)

All Implemented Interfaces:

[Serializable](../../../java.base/java/io/Serializable.html "interface in java.io")

public 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, altGraph, 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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:

1.2

See Also:

Keymap, getKeyStroke(char)

Modifier and Type Method Description
static KeyStroke getKeyStroke​(char keyChar) Returns a shared instance of a KeyStroke that represents a KEY_TYPED event for the specified character.
static KeyStroke getKeyStroke​(char keyChar, boolean onKeyRelease) Deprecated.
static KeyStroke getKeyStroke​(int keyCode, int modifiers) Returns a shared instance of a KeyStroke, given a numeric key code and a set of modifiers.
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.
static KeyStroke getKeyStroke​(Character keyChar, int modifiers) 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​(String s) Parses a string and returns a KeyStroke.
static KeyStroke getKeyStrokeForEvent​(KeyEvent anEvent) Returns a KeyStroke which represents the stroke which generated a given KeyEvent.

Methods declared in class java.awt.AWTKeyStroke

[equals](../../java/awt/AWTKeyStroke.html#equals%28java.lang.Object%29), [getAWTKeyStroke](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke%28char%29), [getAWTKeyStroke](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke%28int,int%29), [getAWTKeyStroke](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke%28int,int,boolean%29), [getAWTKeyStroke](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke%28java.lang.Character,int%29), [getAWTKeyStroke](../../java/awt/AWTKeyStroke.html#getAWTKeyStroke%28java.lang.String%29), [getAWTKeyStrokeForEvent](../../java/awt/AWTKeyStroke.html#getAWTKeyStrokeForEvent%28java.awt.event.KeyEvent%29), [getKeyChar](../../java/awt/AWTKeyStroke.html#getKeyChar%28%29), [getKeyCode](../../java/awt/AWTKeyStroke.html#getKeyCode%28%29), [getKeyEventType](../../java/awt/AWTKeyStroke.html#getKeyEventType%28%29), [getModifiers](../../java/awt/AWTKeyStroke.html#getModifiers%28%29), [hashCode](../../java/awt/AWTKeyStroke.html#hashCode%28%29), [isOnKeyRelease](../../java/awt/AWTKeyStroke.html#isOnKeyRelease%28%29), [readResolve](../../java/awt/AWTKeyStroke.html#readResolve%28%29), [registerSubclass](../../java/awt/AWTKeyStroke.html#registerSubclass%28java.lang.Class%29), [toString](../../java/awt/AWTKeyStroke.html#toString%28%29)