| java.lang.Object
 java.awt.AWTKeyStroke
| AWTKeyStroke | | public class AWTKeyStroke implements Serializable(Code) | | An AWTKeyStroke represents a key action on the
keyboard, or equivalent input device. AWTKeyStrokes
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, AWTKeyStrokes can specify modifiers
(alt, shift, control, meta, 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.
See Also: AWTKeyStroke.getAWTKeyStroke
version:
1.14, 01/23/03
author:
Arnaud Weber
author:
David Mendenhall
since:
1.4 |
| Constructor Summary | |
| | AWTKeyStroke()
Constructs an AWTKeyStroke with default values.
The default values used are:
| Property | Default Value |
|---|
| Key Char |
KeyEvent.CHAR_UNDEFINED |
| Key Code |
KeyEvent.VK_UNDEFINED |
| Modifiers |
none |
| On key release? |
false |
AWTKeyStrokes should not be constructed
by client code. | | | AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)
Constructs an AWTKeyStroke with the specified
values. |
| Method Summary | |
| final public boolean | equals(Object anObject)
Returns true if this object is identical to the specified object. | | public static AWTKeyStroke | getAWTKeyStroke(char keyChar)
Returns a shared instance of an AWTKeyStroke
that represents a KEY_TYPED event for the
specified character. | | public static AWTKeyStroke | getAWTKeyStroke(Character keyChar, int modifiers)
Returns a shared instance of an AWTKeyStroke,
given a Character object and a set of modifiers. | | public static AWTKeyStroke | getAWTKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)
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. | | public static AWTKeyStroke | getAWTKeyStroke(int keyCode, int modifiers)
Returns a shared instance of an AWTKeyStroke,
given a numeric key code and a set of modifiers. | | public static AWTKeyStroke | getAWTKeyStroke(String s)
Parses a string and returns an AWTKeyStroke. | | public static AWTKeyStroke | getAWTKeyStrokeForEvent(KeyEvent anEvent)
Returns an AWTKeyStroke which represents the
stroke which generated a given KeyEvent.
This method obtains the key char from a KeyTyped
event, and the key code from a KeyPressed or
KeyReleased event. | | final public char | getKeyChar()
Returns the character for this AWTKeyStroke. | | final public int | getKeyCode()
Returns the numeric key code for this AWTKeyStroke. | | final public int | getKeyEventType()
Returns the type of KeyEvent which corresponds to
this AWTKeyStroke. | | final public int | getModifiers()
Returns the modifier keys for this AWTKeyStroke. | | 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. | | final public boolean | isOnKeyRelease()
Returns whether this AWTKeyStroke represents a key release. | | public String | toString()
Returns a string that displays and identifies this object's properties. |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| AWTKeyStroke | | AWTKeyStroke()(Code) | | Constructs an AWTKeyStroke with default values.
The default values used are:
| Property | Default Value |
|---|
| Key Char |
KeyEvent.CHAR_UNDEFINED |
| Key Code |
KeyEvent.VK_UNDEFINED |
| Modifiers |
none |
| On key release? |
false |
AWTKeyStrokes should not be constructed
by client code. Use a variant of getAWTKeyStroke
instead.
See Also: AWTKeyStroke.getAWTKeyStroke |
| AWTKeyStroke | | AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)(Code) | | Constructs an AWTKeyStroke with the specified
values. AWTKeyStrokes should not be constructed
by client code. Use a variant of getAWTKeyStroke
instead.
Parameters:
keyChar - the character value for a keyboard key
Parameters:
keyCode - the key code for this AWTKeyStroke
Parameters:
modifiers - a bitwise-ored combination of any modifiers
Parameters:
onKeyRelease - true if thisAWTKeyStroke correspondsto a key release; false otherwise
See Also: AWTKeyStroke.getAWTKeyStroke |
| equals | | final public boolean equals(Object anObject)(Code) | | Returns true if this object is identical to the specified object.
Parameters:
anObject - the Object to compare this object to true if the objects are identical |
| getAWTKeyStroke | | public static AWTKeyStroke getAWTKeyStroke(char keyChar)(Code) | | Returns a shared instance of an AWTKeyStroke
that represents a KEY_TYPED event for the
specified character.
Parameters:
keyChar - the character value for a keyboard key an AWTKeyStroke object for that key |
| getAWTKeyStroke | | public static AWTKeyStroke getAWTKeyStroke(Character keyChar, int modifiers)(Code) | | Returns a shared instance of an AWTKeyStroke,
given a 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:
- java.awt.event.InputEvent.SHIFT_DOWN_MASK
- java.awt.event.InputEvent.CTRL_DOWN_MASK
- java.awt.event.InputEvent.META_DOWN_MASK
- java.awt.event.InputEvent.ALT_DOWN_MASK
- java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
- java.awt.event.InputEvent.BUTTON1_DOWN_MASK
- java.awt.event.InputEvent.BUTTON2_DOWN_MASK
- java.awt.event.InputEvent.BUTTON3_DOWN_MASK
The old modifiers
- java.awt.event.InputEvent.SHIFT_MASK
- java.awt.event.InputEvent.CTRL_MASK
- java.awt.event.InputEvent.META_MASK
- java.awt.event.InputEvent.ALT_MASK
- java.awt.event.InputEvent.ALT_GRAPH_MASK
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.
Parameters:
keyChar - the Character object for a keyboard character
Parameters:
modifiers - a bitwise-ored combination of any modifiers an AWTKeyStroke object for that key
throws:
IllegalArgumentException - if keyChar isnull
See Also: java.awt.event.InputEvent |
| getAWTKeyStroke | | public static AWTKeyStroke getAWTKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)(Code) | | 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_ENTER
java.awt.event.KeyEvent.VK_TAB
java.awt.event.KeyEvent.VK_SPACE
The modifiers consist of any combination of:
- java.awt.event.InputEvent.SHIFT_DOWN_MASK
- java.awt.event.InputEvent.CTRL_DOWN_MASK
- java.awt.event.InputEvent.META_DOWN_MASK
- java.awt.event.InputEvent.ALT_DOWN_MASK
- java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
- java.awt.event.InputEvent.BUTTON1_DOWN_MASK
- java.awt.event.InputEvent.BUTTON2_DOWN_MASK
- java.awt.event.InputEvent.BUTTON3_DOWN_MASK
The old modifiers
- java.awt.event.InputEvent.SHIFT_MASK
- java.awt.event.InputEvent.CTRL_MASK
- java.awt.event.InputEvent.META_MASK
- java.awt.event.InputEvent.ALT_MASK
- java.awt.event.InputEvent.ALT_GRAPH_MASK
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.
Parameters:
keyCode - an int specifying the numeric code for a keyboard key
Parameters:
modifiers - a bitwise-ored combination of any modifiers
Parameters:
onKeyRelease - true if the AWTKeyStrokeshould represent a key release; false otherwise an AWTKeyStroke object for that key
See Also: java.awt.event.KeyEvent
See Also: java.awt.event.InputEvent |
| getAWTKeyStroke | | public static AWTKeyStroke getAWTKeyStroke(int keyCode, int modifiers)(Code) | | 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_ENTER
java.awt.event.KeyEvent.VK_TAB
java.awt.event.KeyEvent.VK_SPACE
The modifiers consist of any combination of:
- java.awt.event.InputEvent.SHIFT_DOWN_MASK
- java.awt.event.InputEvent.CTRL_DOWN_MASK
- java.awt.event.InputEvent.META_DOWN_MASK
- java.awt.event.InputEvent.ALT_DOWN_MASK
- java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
- java.awt.event.InputEvent.BUTTON1_DOWN_MASK
- java.awt.event.InputEvent.BUTTON2_DOWN_MASK
- java.awt.event.InputEvent.BUTTON3_DOWN_MASK
The old modifiers
- java.awt.event.InputEvent.SHIFT_MASK
- java.awt.event.InputEvent.CTRL_MASK
- java.awt.event.InputEvent.META_MASK
- java.awt.event.InputEvent.ALT_MASK
- java.awt.event.InputEvent.ALT_GRAPH_MASK
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.
Parameters:
keyCode - an int specifying the numeric code for a keyboard key
Parameters:
modifiers - a bitwise-ored combination of any modifiers an AWTKeyStroke object for that key
See Also: java.awt.event.KeyEvent
See Also: java.awt.event.InputEvent |
| getAWTKeyStroke | | public static AWTKeyStroke getAWTKeyStroke(String s)(Code) | | Parses a string and returns an AWTKeyStroke.
The string must have the following syntax:
<modifiers>* (<typedID> | <pressedReleasedID>)
modifiers := shift | control | ctrl | meta | alt | button1 | button2 | button3
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');
Parameters:
s - a String formatted as described above an AWTKeyStroke object for that String
throws:
IllegalArgumentException - if s is null,or is formatted incorrectly |
| getAWTKeyStrokeForEvent | | public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)(Code) | | Returns an AWTKeyStroke which represents the
stroke which generated a given KeyEvent.
This method obtains the key char from a KeyTyped
event, and the key code from a KeyPressed or
KeyReleased event. The KeyEvent modifiers are
obtained for all three types of KeyEvent.
Parameters:
anEvent - the KeyEvent from which toobtain the AWTKeyStroke the AWTKeyStroke that precipitated the event |
| getKeyEventType | | final public int getKeyEventType()(Code) | | Returns the type of KeyEvent which corresponds to
this AWTKeyStroke.
KeyEvent.KEY_PRESSED,KeyEvent.KEY_TYPED,or KeyEvent.KEY_RELEASED
See Also: java.awt.event.KeyEvent |
| hashCode | | public int hashCode()(Code) | | 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.
an int that represents this object |
| toString | | public String toString()(Code) | | Returns a string that displays and identifies this object's properties.
a String representation of this object |
|
|