java.awt.event
Class KeyEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--java.awt.event.ComponentEvent
                    |
                    +--java.awt.event.InputEvent
                          |
                          +--java.awt.event.KeyEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MenuKeyEvent

public class KeyEvent

extends InputEvent

Safe:

See Also:

Serialized Form

Field Summary

static char	CHAR_UNDEFINED Enabled: KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value.
private boolean	isProxyActive Stores the state of native event dispatching system - true, if when the event was created event proxying mechanism was active - false, if it was inactive Used in Component.dispatchEventImpl to correctly dispatch events when proxy is active
static int	KEY_FIRST Enabled: The first number in the range of ids used for key events.
static int	KEY_LAST Enabled: The last number in the range of ids used for key events.
static int	KEY_LOCATION_LEFT Enabled: A constant indicating that the key pressed or released is in the left key location (there is more than one possible location for this key).
static int	KEY_LOCATION_NUMPAD Enabled: A constant indicating that the key event originated on the numeric keypad or with a virtual key corresponding to the numeric keypad.
static int	KEY_LOCATION_RIGHT Enabled: A constant indicating that the key pressed or released is in the right key location (there is more than one possible location for this key).
static int	KEY_LOCATION_STANDARD Enabled: A constant indicating that the key pressed or released is not distinguished as the left or right version of a key, and did not originate on the numeric keypad (or did not originate with a virtual key corresponding to the numeric keypad).
static int	KEY_LOCATION_UNKNOWN Enabled: A constant indicating that the keyLocation is indeterminate or not relevant.
static int	KEY_PRESSED Enabled: The "key pressed" event.
static int	KEY_RELEASED Enabled: The "key released" event.
static int	KEY_TYPED Enabled: The "key typed" event.
(package private) char	keyChar keyChar is a valid unicode character that is fired by a key or a key combination on a keyboard.
(package private) int	keyCode The unique value assigned to each of the keys on the keyboard.
(package private) int	keyLocation The location of the key on the keyboard.
private static long	serialVersionUID
static int	VK_0 Enabled: VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)
static int	VK_1 Enabled:
static int	VK_2 Enabled:
static int	VK_3 Enabled:
static int	VK_4 Enabled:
static int	VK_5 Enabled:
static int	VK_6 Enabled:
static int	VK_7 Enabled:
static int	VK_8 Enabled:
static int	VK_9 Enabled:
static int	VK_A Enabled: VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)
static int	VK_ACCEPT Enabled: Constant for the Accept or Commit function key.
static int	VK_ADD Enabled:
static int	VK_AGAIN Enabled: @since 1.2
static int	VK_ALL_CANDIDATES Enabled: Constant for the All Candidates function key.
static int	VK_ALPHANUMERIC Enabled: Constant for the Alphanumeric function key.
static int	VK_ALT Enabled:
static int	VK_ALT_GRAPH Enabled: Constant for the AltGraph function key.
static int	VK_AMPERSAND Enabled: @since 1.2
static int	VK_ASTERISK Enabled: @since 1.2
static int	VK_AT Enabled: Constant for the "@" key.
static int	VK_B Enabled:
static int	VK_BACK_QUOTE Enabled:
static int	VK_BACK_SLASH Enabled:
static int	VK_BACK_SPACE Enabled:
static int	VK_BRACELEFT Enabled: @since 1.2
static int	VK_BRACERIGHT Enabled: @since 1.2
static int	VK_C Enabled:
static int	VK_CANCEL Enabled:
static int	VK_CAPS_LOCK Enabled:
static int	VK_CIRCUMFLEX Enabled: Constant for the "^" key.
static int	VK_CLEAR Enabled:
static int	VK_CLOSE_BRACKET Enabled:
static int	VK_CODE_INPUT Enabled: Constant for the Code Input function key.
static int	VK_COLON Enabled: Constant for the ":" key.
static int	VK_COMMA Enabled:
static int	VK_COMPOSE Enabled: Constant for the Compose function key.
static int	VK_CONTROL Enabled:
static int	VK_CONVERT Enabled: Constant for the Convert function key.
static int	VK_COPY Enabled: @since 1.2
static int	VK_CUT Enabled: @since 1.2
static int	VK_D Enabled:
static int	VK_DEAD_ABOVEDOT Enabled: @since 1.2
static int	VK_DEAD_ABOVERING Enabled: @since 1.2
static int	VK_DEAD_ACUTE Enabled: @since 1.2
static int	VK_DEAD_BREVE Enabled: @since 1.2
static int	VK_DEAD_CARON Enabled: @since 1.2
static int	VK_DEAD_CEDILLA Enabled: @since 1.2
static int	VK_DEAD_CIRCUMFLEX Enabled: @since 1.2
static int	VK_DEAD_DIAERESIS Enabled: @since 1.2
static int	VK_DEAD_DOUBLEACUTE Enabled: @since 1.2
static int	VK_DEAD_GRAVE Enabled: @since 1.2
static int	VK_DEAD_IOTA Enabled: @since 1.2
static int	VK_DEAD_MACRON Enabled: @since 1.2
static int	VK_DEAD_OGONEK Enabled: @since 1.2
static int	VK_DEAD_SEMIVOICED_SOUND Enabled: @since 1.2
static int	VK_DEAD_TILDE Enabled: @since 1.2
static int	VK_DEAD_VOICED_SOUND Enabled: @since 1.2
static int	VK_DECIMAL Enabled:
static int	VK_DELETE Enabled:
static int	VK_DIVIDE Enabled:
static int	VK_DOLLAR Enabled: Constant for the "$" key.
static int	VK_DOWN Enabled: Constant for the non-numpad down arrow key.
static int	VK_E Enabled:
static int	VK_END Enabled:
static int	VK_ENTER Enabled:
static int	VK_EQUALS Enabled:
static int	VK_ESCAPE Enabled:
static int	VK_EURO_SIGN Enabled: Constant for the Euro currency sign key.
static int	VK_EXCLAMATION_MARK Enabled: Constant for the "!" key.
static int	VK_F Enabled:
static int	VK_F1 Enabled: Constant for the F1 function key.
static int	VK_F10 Enabled: Constant for the F10 function key.
static int	VK_F11 Enabled: Constant for the F11 function key.
static int	VK_F12 Enabled: Constant for the F12 function key.
static int	VK_F13 Enabled: Constant for the F13 function key.
static int	VK_F14 Enabled: Constant for the F14 function key.
static int	VK_F15 Enabled: Constant for the F15 function key.
static int	VK_F16 Enabled: Constant for the F16 function key.
static int	VK_F17 Enabled: Constant for the F17 function key.
static int	VK_F18 Enabled: Constant for the F18 function key.
static int	VK_F19 Enabled: Constant for the F19 function key.
static int	VK_F2 Enabled: Constant for the F2 function key.
static int	VK_F20 Enabled: Constant for the F20 function key.
static int	VK_F21 Enabled: Constant for the F21 function key.
static int	VK_F22 Enabled: Constant for the F22 function key.
static int	VK_F23 Enabled: Constant for the F23 function key.
static int	VK_F24 Enabled: Constant for the F24 function key.
static int	VK_F3 Enabled: Constant for the F3 function key.
static int	VK_F4 Enabled: Constant for the F4 function key.
static int	VK_F5 Enabled: Constant for the F5 function key.
static int	VK_F6 Enabled: Constant for the F6 function key.
static int	VK_F7 Enabled: Constant for the F7 function key.
static int	VK_F8 Enabled: Constant for the F8 function key.
static int	VK_F9 Enabled: Constant for the F9 function key.
static int	VK_FINAL Enabled:
static int	VK_FIND Enabled: @since 1.2
static int	VK_FULL_WIDTH Enabled: Constant for the Full-Width Characters function key.
static int	VK_G Enabled:
static int	VK_GREATER Enabled: @since 1.2
static int	VK_H Enabled:
static int	VK_HALF_WIDTH Enabled: Constant for the Half-Width Characters function key.
static int	VK_HELP Enabled:
static int	VK_HIRAGANA Enabled: Constant for the Hiragana function key.
static int	VK_HOME Enabled:
static int	VK_I Enabled:
static int	VK_INPUT_METHOD_ON_OFF Enabled: Constant for the input method on/off key.
static int	VK_INSERT Enabled:
static int	VK_INVERTED_EXCLAMATION_MARK Enabled: Constant for the inverted exclamation mark key.
static int	VK_J Enabled:
static int	VK_JAPANESE_HIRAGANA Enabled: Constant for the Japanese-Hiragana function key.
static int	VK_JAPANESE_KATAKANA Enabled: Constant for the Japanese-Katakana function key.
static int	VK_JAPANESE_ROMAN Enabled: Constant for the Japanese-Roman function key.
static int	VK_K Enabled:
static int	VK_KANA Enabled:
static int	VK_KANA_LOCK Enabled: Constant for the locking Kana function key.
static int	VK_KANJI Enabled:
static int	VK_KATAKANA Enabled: Constant for the Katakana function key.
static int	VK_KP_DOWN Enabled: Constant for the numeric keypad down arrow key.
static int	VK_KP_LEFT Enabled: Constant for the numeric keypad left arrow key.
static int	VK_KP_RIGHT Enabled: Constant for the numeric keypad right arrow key.
static int	VK_KP_UP Enabled: Constant for the numeric keypad up arrow key.
static int	VK_L Enabled:
static int	VK_LEFT Enabled: Constant for the non-numpad left arrow key.
static int	VK_LEFT_PARENTHESIS Enabled: Constant for the "(" key.
static int	VK_LESS Enabled: @since 1.2
static int	VK_M Enabled:
static int	VK_META Enabled:
static int	VK_MINUS Enabled: Constant for the "-" key.
static int	VK_MODECHANGE Enabled:
static int	VK_MULTIPLY Enabled:
static int	VK_N Enabled:
static int	VK_NONCONVERT Enabled: Constant for the Don't Convert function key.
static int	VK_NUM_LOCK Enabled:
static int	VK_NUMBER_SIGN Enabled: Constant for the "#" key.
static int	VK_NUMPAD0 Enabled:
static int	VK_NUMPAD1 Enabled:
static int	VK_NUMPAD2 Enabled:
static int	VK_NUMPAD3 Enabled:
static int	VK_NUMPAD4 Enabled:
static int	VK_NUMPAD5 Enabled:
static int	VK_NUMPAD6 Enabled:
static int	VK_NUMPAD7 Enabled:
static int	VK_NUMPAD8 Enabled:
static int	VK_NUMPAD9 Enabled:
static int	VK_O Enabled:
static int	VK_OPEN_BRACKET Enabled:
static int	VK_P Enabled:
static int	VK_PAGE_DOWN Enabled:
static int	VK_PAGE_UP Enabled:
static int	VK_PASTE Enabled: @since 1.2
static int	VK_PAUSE Enabled:
static int	VK_PERIOD Enabled:
static int	VK_PLUS Enabled: Constant for the "+" key.
static int	VK_PREVIOUS_CANDIDATE Enabled: Constant for the Previous Candidate function key.
static int	VK_PRINTSCREEN Enabled:
static int	VK_PROPS Enabled: @since 1.2
static int	VK_Q Enabled:
static int	VK_QUOTE Enabled:
static int	VK_QUOTEDBL Enabled: @since 1.2
static int	VK_R Enabled:
static int	VK_RIGHT Enabled: Constant for the non-numpad right arrow key.
static int	VK_RIGHT_PARENTHESIS Enabled: Constant for the ")" key.
static int	VK_ROMAN_CHARACTERS Enabled: Constant for the Roman Characters function key.
static int	VK_S Enabled:
static int	VK_SCROLL_LOCK Enabled:
static int	VK_SEMICOLON Enabled:
static int	VK_SEPARATER Enabled: This constant is obsolete, and is included only for backwards compatibility.
static int	VK_SEPARATOR Enabled: Constant for the Numpad Separator key.
static int	VK_SHIFT Enabled:
static int	VK_SLASH Enabled:
static int	VK_SPACE Enabled:
static int	VK_STOP Enabled: @since 1.2
static int	VK_SUBTRACT Enabled:
static int	VK_T Enabled:
static int	VK_TAB Enabled:
static int	VK_U Enabled:
static int	VK_UNDEFINED Enabled: This value is used to indicate that the keyCode is unknown.
static int	VK_UNDERSCORE Enabled: Constant for the "_" key.
static int	VK_UNDO Enabled: @since 1.2
static int	VK_UP Enabled: Constant for the non-numpad up arrow key.
static int	VK_V Enabled:
static int	VK_W Enabled:
static int	VK_X Enabled:
static int	VK_Y Enabled:
static int	VK_Z Enabled:

Fields inherited from class java.awt.event.InputEvent

ALT_DOWN_MASK, ALT_GRAPH_DOWN_MASK, ALT_GRAPH_MASK, ALT_MASK, BUTTON1_DOWN_MASK, BUTTON1_MASK, BUTTON2_DOWN_MASK, BUTTON2_MASK, BUTTON3_DOWN_MASK, BUTTON3_MASK, CTRL_DOWN_MASK, CTRL_MASK, JDK_1_3_MODIFIERS, META_DOWN_MASK, META_MASK, modifiers, SHIFT_DOWN_MASK, SHIFT_MASK, when

Fields inherited from class java.awt.event.ComponentEvent

COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

	KeyEvent(Component source, int id, long when, int modifiers, int keyCode) Suppressed: @deprecated as of JDK1.1
	KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar) Suppressed: Constructs a KeyEvent object.
	KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar, int keyLocation) Suppressed:
private	KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar, int keyLocation, boolean isProxyActive) Constructs a KeyEvent object.

Method Summary

char	getKeyChar() Enabled: Returns the character associated with the key in this event.
int	getKeyCode() Enabled: Returns the integer keyCode associated with the key in this event.
int	getKeyLocation() Enabled: Returns the location of the key that originated this key event.
static String	getKeyModifiersText(int modifiers) Enabled: Returns a String describing the modifier key(s), such as "Shift", or "Ctrl+Shift".
static String	getKeyText(int keyCode) Enabled: Returns a String describing the keyCode, such as "HOME", "F1" or "A".
private static void	initIDs() Initialize JNI field and method IDs for fields that may be accessed from C.
boolean	isActionKey() Enabled: Returns whether the key in this event is an "action" key.
String	paramString() Suppressed: Returns a parameter string identifying this event.
private void	readObject(ObjectInputStream s) Sets new modifiers by the old ones.
void	setKeyChar(char keyChar) Suppressed: Set the keyChar value to indicate a logical character.
void	setKeyCode(int keyCode) Suppressed: Set the keyCode value to indicate a physical key.
void	setModifiers(int modifiers) Deprecated. as of JDK1.1.4
private void	setNewModifiers() Sets new modifiers by the old ones.
private void	setOldModifiers() Sets old modifiers by the new ones.

Methods inherited from class java.awt.event.InputEvent

consume, getModifiers, getModifiersEx, getModifiersExText, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown

Methods inherited from class java.awt.event.ComponentEvent

getComponent

Methods inherited from class java.awt.AWTEvent

getID, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

isProxyActive

private boolean isProxyActive

Stores the state of native event dispatching system - true, if when the event was created event proxying mechanism was active - false, if it was inactive Used in Component.dispatchEventImpl to correctly dispatch events when proxy is active

KEY_FIRST

public static final int KEY_FIRST

Enabled: The first number in the range of ids used for key events.

KEY_LAST

public static final int KEY_LAST

Enabled: The last number in the range of ids used for key events.

KEY_TYPED

public static final int KEY_TYPED

Enabled: The "key typed" event. This event is generated when a character is entered. In the simplest case, it is produced by a single key press. Often, however, characters are produced by series of key presses, and the mapping from key pressed events to key typed events may be many-to-one or many-to-many.

KEY_PRESSED

public static final int KEY_PRESSED

Enabled: The "key pressed" event. This event is generated when a key is pushed down.

KEY_RELEASED

public static final int KEY_RELEASED

Enabled: The "key released" event. This event is generated when a key is let up.

VK_ENTER

public static final int VK_ENTER

Enabled:

VK_BACK_SPACE

public static final int VK_BACK_SPACE

Enabled:

VK_TAB

public static final int VK_TAB

Enabled:

VK_CANCEL

public static final int VK_CANCEL

Enabled:

VK_CLEAR

public static final int VK_CLEAR

Enabled:

VK_SHIFT

public static final int VK_SHIFT

Enabled:

VK_CONTROL

public static final int VK_CONTROL

Enabled:

VK_ALT

public static final int VK_ALT

Enabled:

VK_PAUSE

public static final int VK_PAUSE

Enabled:

VK_CAPS_LOCK

public static final int VK_CAPS_LOCK

Enabled:

VK_ESCAPE

public static final int VK_ESCAPE

Enabled:

VK_SPACE

public static final int VK_SPACE

Enabled:

VK_PAGE_UP

public static final int VK_PAGE_UP

Enabled:

VK_PAGE_DOWN

public static final int VK_PAGE_DOWN

Enabled:

VK_END

public static final int VK_END

Enabled:

VK_HOME

public static final int VK_HOME

Enabled:

VK_LEFT

public static final int VK_LEFT

Enabled: Constant for the non-numpad left arrow key.

See Also:

VK_KP_LEFT

VK_UP

public static final int VK_UP

Enabled: Constant for the non-numpad up arrow key.

See Also:

VK_KP_UP

VK_RIGHT

public static final int VK_RIGHT

Enabled: Constant for the non-numpad right arrow key.

See Also:

VK_KP_RIGHT

VK_DOWN

public static final int VK_DOWN

Enabled: Constant for the non-numpad down arrow key.

See Also:

VK_KP_DOWN

VK_COMMA

public static final int VK_COMMA

Enabled:

VK_MINUS

public static final int VK_MINUS

Enabled: Constant for the "-" key.

Since:

1.2

VK_PERIOD

public static final int VK_PERIOD

Enabled:

VK_SLASH

public static final int VK_SLASH

Enabled:

VK_0

public static final int VK_0

Enabled: VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)

VK_1

public static final int VK_1

Enabled:

VK_2

public static final int VK_2

Enabled:

VK_3

public static final int VK_3

Enabled:

VK_4

public static final int VK_4

Enabled:

VK_5

public static final int VK_5

Enabled:

VK_6

public static final int VK_6

Enabled:

VK_7

public static final int VK_7

Enabled:

VK_8

public static final int VK_8

Enabled:

VK_9

public static final int VK_9

Enabled:

VK_SEMICOLON

public static final int VK_SEMICOLON

Enabled:

VK_EQUALS

public static final int VK_EQUALS

Enabled:

VK_A

public static final int VK_A

Enabled: VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)

VK_B

public static final int VK_B

Enabled:

VK_C

public static final int VK_C

Enabled:

VK_D

public static final int VK_D

Enabled:

VK_E

public static final int VK_E

Enabled:

VK_F

public static final int VK_F

Enabled:

VK_G

public static final int VK_G

Enabled:

VK_H

public static final int VK_H

Enabled:

VK_I

public static final int VK_I

Enabled:

VK_J

public static final int VK_J

Enabled:

VK_K

public static final int VK_K

Enabled:

VK_L

public static final int VK_L

Enabled:

VK_M

public static final int VK_M

Enabled:

VK_N

public static final int VK_N

Enabled:

VK_O

public static final int VK_O

Enabled:

VK_P

public static final int VK_P

Enabled:

VK_Q

public static final int VK_Q

Enabled:

VK_R

public static final int VK_R

Enabled:

VK_S

public static final int VK_S

Enabled:

VK_T

public static final int VK_T

Enabled:

VK_U

public static final int VK_U

Enabled:

VK_V

public static final int VK_V

Enabled:

VK_W

public static final int VK_W

Enabled:

VK_X

public static final int VK_X

Enabled:

VK_Y

public static final int VK_Y

Enabled:

VK_Z

public static final int VK_Z

Enabled:

VK_OPEN_BRACKET

public static final int VK_OPEN_BRACKET

Enabled:

VK_BACK_SLASH

public static final int VK_BACK_SLASH

Enabled:

VK_CLOSE_BRACKET

public static final int VK_CLOSE_BRACKET

Enabled:

VK_NUMPAD0

public static final int VK_NUMPAD0

Enabled:

VK_NUMPAD1

public static final int VK_NUMPAD1

Enabled:

VK_NUMPAD2

public static final int VK_NUMPAD2

Enabled:

VK_NUMPAD3

public static final int VK_NUMPAD3

Enabled:

VK_NUMPAD4

public static final int VK_NUMPAD4

Enabled:

VK_NUMPAD5

public static final int VK_NUMPAD5

Enabled:

VK_NUMPAD6

public static final int VK_NUMPAD6

Enabled:

VK_NUMPAD7

public static final int VK_NUMPAD7

Enabled:

VK_NUMPAD8

public static final int VK_NUMPAD8

Enabled:

VK_NUMPAD9

public static final int VK_NUMPAD9

Enabled:

VK_MULTIPLY

public static final int VK_MULTIPLY

Enabled:

VK_ADD

public static final int VK_ADD

Enabled:

VK_SEPARATER

public static final int VK_SEPARATER

Enabled: This constant is obsolete, and is included only for backwards compatibility.

See Also:

VK_SEPARATOR

VK_SEPARATOR

public static final int VK_SEPARATOR

Enabled: Constant for the Numpad Separator key.

Since:

1.4

VK_SUBTRACT

public static final int VK_SUBTRACT

Enabled:

VK_DECIMAL

public static final int VK_DECIMAL

Enabled:

VK_DIVIDE

public static final int VK_DIVIDE

Enabled:

VK_DELETE

public static final int VK_DELETE

Enabled:

VK_NUM_LOCK

public static final int VK_NUM_LOCK

Enabled:

VK_SCROLL_LOCK

public static final int VK_SCROLL_LOCK

Enabled:

VK_F1

public static final int VK_F1

Enabled: Constant for the F1 function key.

VK_F2

public static final int VK_F2

Enabled: Constant for the F2 function key.

VK_F3

public static final int VK_F3

Enabled: Constant for the F3 function key.

VK_F4

public static final int VK_F4

Enabled: Constant for the F4 function key.

VK_F5

public static final int VK_F5

Enabled: Constant for the F5 function key.

VK_F6

public static final int VK_F6

Enabled: Constant for the F6 function key.

VK_F7

public static final int VK_F7

Enabled: Constant for the F7 function key.

VK_F8

public static final int VK_F8

Enabled: Constant for the F8 function key.

VK_F9

public static final int VK_F9

Enabled: Constant for the F9 function key.

VK_F10

public static final int VK_F10

Enabled: Constant for the F10 function key.

VK_F11

public static final int VK_F11

Enabled: Constant for the F11 function key.

VK_F12

public static final int VK_F12

Enabled: Constant for the F12 function key.

VK_F13

public static final int VK_F13

Enabled: Constant for the F13 function key.

Since:

1.2

VK_F14

public static final int VK_F14

Enabled: Constant for the F14 function key.

Since:

1.2

VK_F15

public static final int VK_F15

Enabled: Constant for the F15 function key.

Since:

1.2

VK_F16

public static final int VK_F16

Enabled: Constant for the F16 function key.

Since:

1.2

VK_F17

public static final int VK_F17

Enabled: Constant for the F17 function key.

Since:

1.2

VK_F18

public static final int VK_F18

Enabled: Constant for the F18 function key.

Since:

1.2

VK_F19

public static final int VK_F19

Enabled: Constant for the F19 function key.

Since:

1.2

VK_F20

public static final int VK_F20

Enabled: Constant for the F20 function key.

Since:

1.2

VK_F21

public static final int VK_F21

Enabled: Constant for the F21 function key.

Since:

1.2

VK_F22

public static final int VK_F22

Enabled: Constant for the F22 function key.

Since:

1.2

VK_F23

public static final int VK_F23

Enabled: Constant for the F23 function key.

Since:

1.2

VK_F24

public static final int VK_F24

Enabled: Constant for the F24 function key.

Since:

1.2

VK_PRINTSCREEN

public static final int VK_PRINTSCREEN

Enabled:

VK_INSERT

public static final int VK_INSERT

Enabled:

VK_HELP

public static final int VK_HELP

Enabled:

VK_META

public static final int VK_META

Enabled:

VK_BACK_QUOTE

public static final int VK_BACK_QUOTE

Enabled:

VK_QUOTE

public static final int VK_QUOTE

Enabled:

VK_KP_UP

public static final int VK_KP_UP

Enabled: Constant for the numeric keypad up arrow key.

Since:

1.2

See Also:

VK_UP

VK_KP_DOWN

public static final int VK_KP_DOWN

Enabled: Constant for the numeric keypad down arrow key.

Since:

1.2

See Also:

VK_DOWN

VK_KP_LEFT

public static final int VK_KP_LEFT

Enabled: Constant for the numeric keypad left arrow key.

Since:

1.2

See Also:

VK_LEFT

VK_KP_RIGHT

public static final int VK_KP_RIGHT

Enabled: Constant for the numeric keypad right arrow key.

Since:

1.2

See Also:

VK_RIGHT

VK_DEAD_GRAVE

public static final int VK_DEAD_GRAVE

Enabled: @since 1.2

VK_DEAD_ACUTE

public static final int VK_DEAD_ACUTE

Enabled: @since 1.2

VK_DEAD_CIRCUMFLEX

public static final int VK_DEAD_CIRCUMFLEX

Enabled: @since 1.2

VK_DEAD_TILDE

public static final int VK_DEAD_TILDE

Enabled: @since 1.2

VK_DEAD_MACRON

public static final int VK_DEAD_MACRON

Enabled: @since 1.2

VK_DEAD_BREVE

public static final int VK_DEAD_BREVE

Enabled: @since 1.2

VK_DEAD_ABOVEDOT

public static final int VK_DEAD_ABOVEDOT

Enabled: @since 1.2

VK_DEAD_DIAERESIS

public static final int VK_DEAD_DIAERESIS

Enabled: @since 1.2

VK_DEAD_ABOVERING

public static final int VK_DEAD_ABOVERING

Enabled: @since 1.2

VK_DEAD_DOUBLEACUTE

public static final int VK_DEAD_DOUBLEACUTE

Enabled: @since 1.2

VK_DEAD_CARON

public static final int VK_DEAD_CARON

Enabled: @since 1.2

VK_DEAD_CEDILLA

public static final int VK_DEAD_CEDILLA

Enabled: @since 1.2

VK_DEAD_OGONEK

public static final int VK_DEAD_OGONEK

Enabled: @since 1.2

VK_DEAD_IOTA

public static final int VK_DEAD_IOTA

Enabled: @since 1.2

VK_DEAD_VOICED_SOUND

public static final int VK_DEAD_VOICED_SOUND

Enabled: @since 1.2

VK_DEAD_SEMIVOICED_SOUND

public static final int VK_DEAD_SEMIVOICED_SOUND

Enabled: @since 1.2

VK_AMPERSAND

public static final int VK_AMPERSAND

Enabled: @since 1.2

VK_ASTERISK

public static final int VK_ASTERISK

Enabled: @since 1.2

VK_QUOTEDBL

public static final int VK_QUOTEDBL

Enabled: @since 1.2

VK_LESS

public static final int VK_LESS

Enabled: @since 1.2

VK_GREATER

public static final int VK_GREATER

Enabled: @since 1.2

VK_BRACELEFT

public static final int VK_BRACELEFT

Enabled: @since 1.2

VK_BRACERIGHT

public static final int VK_BRACERIGHT

Enabled: @since 1.2

VK_AT

public static final int VK_AT

Enabled: Constant for the "@" key.

Since:

1.2

VK_COLON

public static final int VK_COLON

Enabled: Constant for the ":" key.

Since:

1.2

VK_CIRCUMFLEX

public static final int VK_CIRCUMFLEX

Enabled: Constant for the "^" key.

Since:

1.2

VK_DOLLAR

public static final int VK_DOLLAR

Enabled: Constant for the "$" key.

Since:

1.2

VK_EURO_SIGN

public static final int VK_EURO_SIGN

Enabled: Constant for the Euro currency sign key.

Since:

1.2

VK_EXCLAMATION_MARK

public static final int VK_EXCLAMATION_MARK

Enabled: Constant for the "!" key.

Since:

1.2

VK_INVERTED_EXCLAMATION_MARK

public static final int VK_INVERTED_EXCLAMATION_MARK

Enabled: Constant for the inverted exclamation mark key.

Since:

1.2

VK_LEFT_PARENTHESIS

public static final int VK_LEFT_PARENTHESIS

Enabled: Constant for the "(" key.

Since:

1.2

VK_NUMBER_SIGN

public static final int VK_NUMBER_SIGN

Enabled: Constant for the "#" key.

Since:

1.2

VK_PLUS

public static final int VK_PLUS

Enabled: Constant for the "+" key.

Since:

1.2

VK_RIGHT_PARENTHESIS

public static final int VK_RIGHT_PARENTHESIS

Enabled: Constant for the ")" key.

Since:

1.2

VK_UNDERSCORE

public static final int VK_UNDERSCORE

Enabled: Constant for the "_" key.

Since:

1.2

VK_FINAL

public static final int VK_FINAL

Enabled:

VK_CONVERT

public static final int VK_CONVERT

Enabled: Constant for the Convert function key.

VK_NONCONVERT

public static final int VK_NONCONVERT

Enabled: Constant for the Don't Convert function key.

VK_ACCEPT

public static final int VK_ACCEPT

Enabled: Constant for the Accept or Commit function key.

VK_MODECHANGE

public static final int VK_MODECHANGE

Enabled:

VK_KANA

public static final int VK_KANA

Enabled:

VK_KANJI

public static final int VK_KANJI

Enabled:

VK_ALPHANUMERIC

public static final int VK_ALPHANUMERIC

Enabled: Constant for the Alphanumeric function key.

Since:

1.2

VK_KATAKANA

public static final int VK_KATAKANA

Enabled: Constant for the Katakana function key.

Since:

1.2

VK_HIRAGANA

public static final int VK_HIRAGANA

Enabled: Constant for the Hiragana function key.

Since:

1.2

VK_FULL_WIDTH

public static final int VK_FULL_WIDTH

Enabled: Constant for the Full-Width Characters function key.

Since:

1.2

VK_HALF_WIDTH

public static final int VK_HALF_WIDTH

Enabled: Constant for the Half-Width Characters function key.

Since:

1.2

VK_ROMAN_CHARACTERS

public static final int VK_ROMAN_CHARACTERS

Enabled: Constant for the Roman Characters function key.

Since:

1.2

VK_ALL_CANDIDATES

public static final int VK_ALL_CANDIDATES

Enabled: Constant for the All Candidates function key.

Since:

1.2

VK_PREVIOUS_CANDIDATE

public static final int VK_PREVIOUS_CANDIDATE

Enabled: Constant for the Previous Candidate function key.

Since:

1.2

VK_CODE_INPUT

public static final int VK_CODE_INPUT

Enabled: Constant for the Code Input function key.

Since:

1.2

VK_JAPANESE_KATAKANA

public static final int VK_JAPANESE_KATAKANA

Enabled: Constant for the Japanese-Katakana function key. This key switches to a Japanese input method and selects its Katakana input mode.

Since:

1.2

VK_JAPANESE_HIRAGANA

public static final int VK_JAPANESE_HIRAGANA

Enabled: Constant for the Japanese-Hiragana function key. This key switches to a Japanese input method and selects its Hiragana input mode.

Since:

1.2

VK_JAPANESE_ROMAN

public static final int VK_JAPANESE_ROMAN

Enabled: Constant for the Japanese-Roman function key. This key switches to a Japanese input method and selects its Roman-Direct input mode.

Since:

1.2

VK_KANA_LOCK

public static final int VK_KANA_LOCK

Enabled: Constant for the locking Kana function key. This key locks the keyboard into a Kana layout.

Since:

1.3

VK_INPUT_METHOD_ON_OFF

public static final int VK_INPUT_METHOD_ON_OFF

Enabled: Constant for the input method on/off key.

Since:

1.3

VK_CUT

public static final int VK_CUT

Enabled: @since 1.2

VK_COPY

public static final int VK_COPY

Enabled: @since 1.2

VK_PASTE

public static final int VK_PASTE

Enabled: @since 1.2

VK_UNDO

public static final int VK_UNDO

Enabled: @since 1.2

VK_AGAIN

public static final int VK_AGAIN

Enabled: @since 1.2

VK_FIND

public static final int VK_FIND

Enabled: @since 1.2

VK_PROPS

public static final int VK_PROPS

Enabled: @since 1.2

VK_STOP

public static final int VK_STOP

Enabled: @since 1.2

VK_COMPOSE

public static final int VK_COMPOSE

Enabled: Constant for the Compose function key.

Since:

1.2

VK_ALT_GRAPH

public static final int VK_ALT_GRAPH

Enabled: Constant for the AltGraph function key.

Since:

1.2

VK_UNDEFINED

public static final int VK_UNDEFINED

Enabled: This value is used to indicate that the keyCode is unknown. KEY_TYPED events do not have a keyCode value; this value is used instead.

CHAR_UNDEFINED

public static final char CHAR_UNDEFINED

Enabled: KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value.

KEY_LOCATION_UNKNOWN

public static final int KEY_LOCATION_UNKNOWN

Enabled: A constant indicating that the keyLocation is indeterminate or not relevant. KEY_TYPED events do not have a keyLocation; this value is used instead.

Since:

1.4

KEY_LOCATION_STANDARD

public static final int KEY_LOCATION_STANDARD

Enabled: A constant indicating that the key pressed or released is not distinguished as the left or right version of a key, and did not originate on the numeric keypad (or did not originate with a virtual key corresponding to the numeric keypad).

Since:

1.4

KEY_LOCATION_LEFT

public static final int KEY_LOCATION_LEFT

Enabled: A constant indicating that the key pressed or released is in the left key location (there is more than one possible location for this key). Example: the left shift key.

Since:

1.4

KEY_LOCATION_RIGHT

public static final int KEY_LOCATION_RIGHT

Enabled: A constant indicating that the key pressed or released is in the right key location (there is more than one possible location for this key). Example: the right shift key.

Since:

1.4

KEY_LOCATION_NUMPAD

public static final int KEY_LOCATION_NUMPAD

Enabled: A constant indicating that the key event originated on the numeric keypad or with a virtual key corresponding to the numeric keypad.

Since:

1.4

keyCode

int keyCode

The unique value assigned to each of the keys on the keyboard. There is a common set of key codes that can be fired by most keyboards. The symbolic name for a key code should be used rather than the code value itself.

See Also:

getKeyCode(), setKeyCode()

keyChar

char keyChar

keyChar is a valid unicode character that is fired by a key or a key combination on a keyboard.

See Also:

getKeyChar(), setKeyChar()

keyLocation

int keyLocation

The location of the key on the keyboard. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This variable is used to distinguish such keys. The only legal values are KEY_LOCATION_UNKNOWN, KEY_LOCATION_STANDARD, KEY_LOCATION_LEFT, KEY_LOCATION_RIGHT, and KEY_LOCATION_NUMPAD.

See Also:

getKeyLocation()

serialVersionUID

private static final long serialVersionUID

Constructor Detail

KeyEvent

private KeyEvent(Component source,
                 int id,
                 long when,
                 int modifiers,
                 int keyCode,
                 char keyChar,
                 int keyLocation,
                 boolean isProxyActive)

Constructs a KeyEvent object.

Note that passing in an invalid id results in unspecified behavior.

Parameters:

source - the Component that originated the event

id - an integer identifying the type of event

when - a long integer that specifies the time the event occurred

modifiers - the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.

keyCode - the integer code for an actual key, or VK_UNDEFINED (for a key-typed event)

keyChar - the Unicode character generated by this event, or CHAR_UNDEFINED (for key-pressed and key-released events which do not map to a valid Unicode character)

keyLocation - identifies the key location. The only legal values are KEY_LOCATION_UNKNOWN, KEY_LOCATION_STANDARD, KEY_LOCATION_LEFT, KEY_LOCATION_RIGHT, and KEY_LOCATION_NUMPAD.

Since:

1.4

KeyEvent

public KeyEvent(Component source,
                int id,
                long when,
                int modifiers,
                int keyCode,
                char keyChar,
                int keyLocation)

Suppressed:

KeyEvent

public KeyEvent(Component source,
                int id,
                long when,
                int modifiers,
                int keyCode,
                char keyChar)

Suppressed: Constructs a KeyEvent object.

Note that passing in an invalid id results in unspecified behavior.

Parameters:

source - the Component that originated the event

id - an integer identifying the type of event

when - a long integer that specifies the time the event occurred

modifiers - the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.

keyCode - the integer code for an actual key, or VK_UNDEFINED (for a key-typed event)

keyChar - the Unicode character generated by this event, or CHAR_UNDEFINED (for key-pressed and key-released events which do not map to a valid Unicode character)

KeyEvent

public KeyEvent(Component source,
                int id,
                long when,
                int modifiers,
                int keyCode)

Suppressed: @deprecated as of JDK1.1

Method Detail

initIDs

private static void initIDs()

Initialize JNI field and method IDs for fields that may be accessed from C.

getKeyCode

public int getKeyCode()

Enabled: Returns the integer keyCode associated with the key in this event.

Returns:

the integer code for an actual key on the keyboard. (For KEY_TYPED events, the keyCode is VK_UNDEFINED.)

setKeyCode

public void setKeyCode(int keyCode)

Suppressed: Set the keyCode value to indicate a physical key.

Parameters:

keyCode - an integer corresponding to an actual key on the keyboard.

getKeyChar

public char getKeyChar()

Enabled: Returns the character associated with the key in this event. For example, the key-typed event for shift + "a" returns the value for "A".

Returns:

the Unicode character defined for this key event. If no valid Unicode character exists for this key event, keyChar is CHAR_UNDEFINED.

setKeyChar

public void setKeyChar(char keyChar)

Suppressed: Set the keyChar value to indicate a logical character.

Parameters:

keyChar - a char corresponding to to the combination of keystrokes that make up this event.

setModifiers

public void setModifiers(int modifiers)

Deprecated. as of JDK1.1.4

Suppressed: Set the modifiers to indicate additional keys that were held down (e.g. shift, ctrl, alt, meta) defined as part of InputEvent.

NOTE: use of this method is not recommended, because many AWT implementations do not recognize modifier changes. This is especially true for KEY_TYPED events where the shift modifier is changed.

Parameters:

modifiers - an integer combination of the modifier constants.

See Also:

InputEvent

getKeyLocation

public int getKeyLocation()

Enabled: Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys.

Returns:

the location of the key that was pressed or released. Always returns KEY_LOCATION_UNKNOWN for KEY_TYPED events.

Since:

1.4

getKeyText

public static String getKeyText(int keyCode)

Enabled: Returns a String describing the keyCode, such as "HOME", "F1" or "A". These strings can be localized by changing the awt.properties file.

Returns:

a string containing a text description for a physical key, identified by its keyCode

getKeyModifiersText

public static String getKeyModifiersText(int modifiers)

Enabled: Returns a String describing the modifier key(s), such as "Shift", or "Ctrl+Shift". These strings can be localized by changing the awt.properties file.

Returns:

string a text description of the combination of modifier keys that were held down during the event

isActionKey

public boolean isActionKey()

Enabled: Returns whether the key in this event is an "action" key. Typically an action key does not fire a unicode character and is not a modifier key.

Returns:

true if the key is an "action" key, false otherwise

paramString

public String paramString()

Suppressed: Returns a parameter string identifying this event. This method is useful for event logging and for debugging.

Overrides:

paramString in class ComponentEvent

Returns:

a string identifying the event and its attributes

setNewModifiers

private void setNewModifiers()

Sets new modifiers by the old ones. The key modifiers override overlaping mouse modifiers.

setOldModifiers

private void setOldModifiers()

Sets old modifiers by the new ones.

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException

Sets new modifiers by the old ones. The key modifiers override overlaping mouse modifiers.

IOException

ClassNotFoundException