java.lang.Object java.awt.AWTKeyStroke javax.swing.KeyStroke
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 JavaBeans TM has been added to the java.beans package. Please see XMLEncoder .
Method Summary | |
---|---|
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
(
Character
keyChar, int modifiers) Returns a shared instance of a KeyStroke, given a Character object and a set of modifiers. |
static KeyStroke |
getKeyStroke
(char keyChar, boolean onKeyRelease) Deprecated. use getKeyStroke(char) |
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
(
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 inherited from class java.awt. AWTKeyStroke |
---|
equals , getAWTKeyStroke , getAWTKeyStroke , getAWTKeyStroke , getAWTKeyStroke , getAWTKeyStroke , getAWTKeyStrokeForEvent , getKeyChar , getKeyCode , getKeyEventType , getModifiers , hashCode , isOnKeyRelease , readResolve , registerSubclass , toString |
Methods inherited from class java.lang. Object |
---|
clone , finalize , getClass , notify , notifyAll , wait , wait , wait |
Method Detail |
---|
public static KeyStroke getKeyStroke(char keyChar)
public static KeyStroke getKeyStroke(char keyChar, boolean onKeyRelease)
public static KeyStroke getKeyStroke(Character keyChar, int modifiers)
public 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:
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:
public static KeyStroke getKeyStrokeForEvent(KeyEvent anEvent)
This method obtains the keyChar from a KeyTyped event, and the
keyCode
key code
from a KeyPressed or KeyReleased event. The KeyEvent modifiers are obtained for all three types of KeyEvent.
public static KeyStroke getKeyStroke(String s)
<modifiers>* (<typedID> | <pressedReleasedID>) modifiers := shift | control | ctrl | meta | alt | altGraphIf typed, pressed or released is not specified, pressed is assumed. Here are some examples:button1 | button2 | button3typedID := 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_".
"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.