java.awt
Class AWTKeyStroke

java.lang.Object
  java.awt.AWTKeyStroke

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

KeyStroke

public class AWTKeyStroke
extends Object
implements Serializable

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.

Since:

1.4

See Also:

getAWTKeyStroke(char), Serialized Form

Constructor Summary

protected	AWTKeyStroke() Constructs an AWTKeyStroke with default values.
protected	AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease) Constructs an AWTKeyStroke with the specified values.

Method Summary

boolean	equals(Object anObject) Returns true if this object is identical to the specified object.
static AWTKeyStroke	getAWTKeyStroke(char keyChar) Returns a shared instance of an AWTKeyStroke that represents a KEY_TYPED event for the specified character.
static AWTKeyStroke	getAWTKeyStroke(Character keyChar, int modifiers) Returns a shared instance of an AWTKeyStroke, given a Character object and a set of modifiers.
static AWTKeyStroke	getAWTKeyStroke(int keyCode, int modifiers) Returns a shared instance of an AWTKeyStroke, given a numeric key code and a set of modifiers.
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.
static AWTKeyStroke	getAWTKeyStroke(String s) Parses a string and returns an AWTKeyStroke.
static AWTKeyStroke	getAWTKeyStrokeForEvent(KeyEvent anEvent) Returns an AWTKeyStroke which represents the stroke which generated a given KeyEvent.
char	getKeyChar() Returns the character for this AWTKeyStroke.
int	getKeyCode() Returns the numeric key code for this AWTKeyStroke.
int	getKeyEventType() Returns the type of KeyEvent which corresponds to this AWTKeyStroke.
int	getModifiers() Returns the modifier keys for this AWTKeyStroke.
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.
boolean	isOnKeyRelease() Returns whether this AWTKeyStroke represents a key release.
protected Object	readResolve() Returns a cached instance of AWTKeyStroke (or a subclass of AWTKeyStroke) which is equal to this instance.
protected static void	registerSubclass(Class<?> subclass) Registers a new class which the factory methods in AWTKeyStroke will use when generating new instances of AWTKeyStrokes.
String	toString() Returns a string that displays and identifies this object's properties.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AWTKeyStroke

protected 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. Use a variant of getAWTKeyStroke instead.

See Also:

getAWTKeyStroke(char)

AWTKeyStroke

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.

Parameters:

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

See Also:

getAWTKeyStroke(char)

Method Detail

registerSubclass

protected static void registerSubclass(Class<?> subclass)

Registers a new class which the factory methods in AWTKeyStroke will use when generating new instances of AWTKeyStrokes. After invoking this method, the factory methods will return instances of the specified Class. The specified Class must be either AWTKeyStroke or derived from AWTKeyStroke, and it must have a no-arg constructor. The constructor can be of any accessibility, including private. This operation flushes the current AWTKeyStroke cache.

Parameters:

subclass - the new Class of which the factory methods should create instances

Throws:

IllegalArgumentException - if subclass is null, or if subclass does not have a no-arg constructor

ClassCastException - if subclass is not AWTKeyStroke, or a class derived from AWTKeyStroke

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(char keyChar)

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

Returns:

an AWTKeyStroke object for that key

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(