Serializable
KeyStroke
An
AWTKeyStroke
represents a key action on the keyboard, or equivalent input device.
AWTKeyStroke
s can correspond to only a press or release of a particular key, just as
KEY_PRESSED
and
KEY_RELEASED KeyEvent
s do; alternately, they can correspond to typing a specific Java character, just as
KEY_TYPED KeyEvent
s do. In all cases,
AWTKeyStroke
s can specify modifiers (alt, shift, control, meta, altGraph, or a combination thereof) which must be present during the action for an exact match.
AWTKeyStrokes are immutable, and are intended to be unique. Client code should never create an AWTKeyStroke on its own, but should instead use a variant of getAWTKeyStroke. Client use of these factory methods allows the AWTKeyStroke implementation to cache and share instances efficiently.
Constructors
protected
Constructs an AWTKeyStroke with default values.
protected
AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)
Constructs an AWTKeyStroke with the specified values.
final boolean
Returns true if this object is identical to the specified object.
Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.
Returns a shared instance of an AWTKeyStroke, given a numeric key code and a set of modifiers.
Returns a shared instance of an AWTKeyStroke, given a numeric key code and a set of modifiers, specifying whether the key is activated when it is pressed or released.
Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified Character object and a set of modifiers.
Parses a string and returns an AWTKeyStroke.
Returns an AWTKeyStroke which represents the stroke which generated a given KeyEvent.
final char
Returns the character for this AWTKeyStroke.
final int
Returns the numeric key code for this AWTKeyStroke.
final int
Returns the type of KeyEvent which corresponds to this AWTKeyStroke.
final int
Returns the modifier keys for this AWTKeyStroke.
int
Returns a numeric value for this object that is likely to be unique, making it a good choice as the index value in a hash table.
final boolean
Returns whether this AWTKeyStroke represents a key release.
Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.
protected static void
Returns a string that displays and identifies this object's properties.
protected AWTKeyStroke()
Constructs an
AWTKeyStroke
with default values. The default values used are:
AWTKeyStroke default values Property Default Value Key CharKeyEvent.CHAR_UNDEFINED Key Code KeyEvent.VK_UNDEFINED Modifiers none On key release? false AWTKeyStroke
s should not be constructed by client code. Use a variant of
getAWTKeyStroke
instead.
protected AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)
Constructs an AWTKeyStroke with the specified values. AWTKeyStrokes should not be constructed by client code. Use a variant of getAWTKeyStroke instead.
keyChar - the character value for a keyboard key
keyCode - the key code for this AWTKeyStroke
modifiers - a bitwise-ored combination of any modifiers
onKeyRelease - true if this AWTKeyStroke corresponds to a key release; false otherwise
Deprecated.
The method has no effect and is only left present to avoid introducing a binary incompatibility.
subclass - the new Class of which the factory methods should create instances
Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.
keyChar - the character value for a keyboard key
AWTKeyStroke object for that key
Returns a shared instance of an
AWTKeyStroke
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
getAWTKeyStroke(int keyCode, int modifiers)
. The modifiers consist of any combination of following:
The old modifiers listed below also can be used, but they are mapped to _DOWN_ modifiers.
also can be used, but they are mapped to _DOWN_ modifiers. 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.
keyChar - the Character object for a keyboard character
modifiers - a bitwise-ored combination of any modifiers
AWTKeyStroke object for that key
IllegalArgumentException - if keyChar is null
Returns a shared instance of an
AWTKeyStroke
, 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_ENTERjava.awt.event.KeyEvent.VK_TABjava.awt.event.KeyEvent.VK_SPACEAlternatively, the key code may be obtained by calling
java.awt.event.KeyEvent.getExtendedKeyCodeForChar
. The modifiers consist of any combination of:
The old modifiers
also can be used, but they are mapped to _DOWN_ modifiers. 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.
keyCode - an int specifying the numeric code for a keyboard key
modifiers - a bitwise-ored combination of any modifiers
onKeyRelease - true if the AWTKeyStroke should represent a key release; false otherwise
Returns a shared instance of an
AWTKeyStroke
, given a numeric key code and a set of modifiers. The returned
AWTKeyStroke
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_ENTERjava.awt.event.KeyEvent.VK_TABjava.awt.event.KeyEvent.VK_SPACEThe modifiers consist of any combination of:
The old modifiers
also can be used, but they are mapped to _DOWN_ modifiers. 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.
keyCode - an int specifying the numeric code for a keyboard key
modifiers - a bitwise-ored combination of any modifiers
AWTKeyStroke object for that key
Returns an
AWTKeyStroke
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.
anEvent - the KeyEvent from which to obtain the AWTKeyStroke
AWTKeyStroke that precipitated the event
NullPointerException - if anEvent is null
Parses a string and returns an
AWTKeyStroke
. 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" => getAWTKeyStroke(KeyEvent.VK_INSERT, 0);
"control DELETE" => getAWTKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
"alt shift X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
"alt shift released X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
"typed a" => getAWTKeyStroke('a');
s - a String formatted as described above
AWTKeyStroke object for that String
IllegalArgumentException - if s is null, or is formatted incorrectly
public final char getKeyChar()
Returns the character for this AWTKeyStroke.
public final int getKeyCode()
Returns the numeric key code for this AWTKeyStroke.
public final int getModifiers()
Returns the modifier keys for this AWTKeyStroke.
public final boolean isOnKeyRelease()
Returns whether this AWTKeyStroke represents a key release.
true if this AWTKeyStroke represents a key release; false otherwise
public final int getKeyEventType()
Returns the type of KeyEvent which corresponds to this AWTKeyStroke.
KeyEvent.KEY_PRESSED, KeyEvent.KEY_TYPED, or KeyEvent.KEY_RELEASED
public int hashCode()
Returns a numeric value for this object that is likely to be unique, making it a good choice as the index value in a hash table.
Returns true if this object is identical to the specified object.
Returns a string that displays and identifies this object's properties. The String returned by this method can be passed as a parameter to getAWTKeyStroke(String) to produce a key stroke equal to this key stroke.
Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.
ObjectStreamException - if a serialization problem occurs
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4