KeyEvent

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
extends InputEvent

Disabled: no SafeJ information.

An event which indicates that a keystroke occurred in a component.

This low-level event is generated by a component object (such as a text field) when a key is pressed, released, or typed. The event is passed to every KeyListener or KeyAdapter object which registered to receive such events using the component's addKeyListener method. (KeyAdapter objects implement the KeyListener interface.) Each such listener object gets this KeyEvent when the event occurs.

"Key typed" events are higher-level and generally do not depend on the platform or keyboard layout. They are generated when a Unicode character is entered, and are the preferred way to find out about character input. In the simplest case, a key typed event is produced by a single key press (e.g., 'a'). Often, however, characters are produced by series of key presses (e.g., 'shift' + 'a'), and the mapping from key pressed events to key typed events may be many-to-one or many-to-many. Key releases are not usually necessary to generate a key typed event, but there are some cases where the key typed event is not generated until a key is released (e.g., entering ASCII sequences via the Alt-Numpad method in Windows). No key typed events are generated for keys that don't generate Unicode characters (e.g., action keys, modifier keys, etc.).

The getKeyChar method always returns a valid Unicode character or CHAR_UNDEFINED. Character input is reported by KEY_TYPED events: KEY_PRESSED and KEY_RELEASED events are not necessarily associated with character input. Therefore, the result of the getKeyChar method is guaranteed to be meaningful only for KEY_TYPED events.

For key pressed and key released events, the getKeyCode method returns the event's keyCode. For key typed events, the getKeyCode method always returns VK_UNDEFINED. The getExtendedKeyCode method may also be used with many international keyboard layouts.

"Key pressed" and "key released" events are lower-level and depend on the platform and keyboard layout. They are generated whenever a key is pressed or released, and are the only way to find out about keys that don't generate character input (e.g., action keys, modifier keys, etc.). The key being pressed or released is indicated by the getKeyCode and getExtendedKeyCode methods, which return a virtual key code.

Virtual key codes are used to report which keyboard key has been pressed, rather than a character generated by the combination of one or more keystrokes (such as "A", which comes from shift and "a").

For example, pressing the Shift key will cause a KEY_PRESSED event with a VK_SHIFT keyCode, while pressing the 'a' key will result in a VK_A keyCode. After the 'a' key is released, a KEY_RELEASED event will be fired with VK_A. Separately, a KEY_TYPED event with a keyChar value of 'A' is generated.

Pressing and releasing a key on the keyboard results in the generating the following key events (in order):

    KEY_PRESSED
    KEY_TYPED (is only generated if a valid Unicode character could be generated.)
    KEY_RELEASED

But in some cases (e.g. auto-repeat or input method is activated) the order could be different (and platform dependent).

Notes:

Key combinations which do not result in Unicode characters, such as action keys like F1 and the HELP key, do not generate KEY_TYPED events.
Not all keyboards or systems are capable of generating all virtual key codes. No attempt is made in Java to generate these keys artificially.
Virtual key codes do not identify a physical key: they depend on the platform and keyboard layout. For example, the key that generates VK_Q when using a U.S. keyboard layout will generate VK_A when using a French keyboard layout.
The key that generates VK_Q when using a U.S. keyboard layout also generates a unique code for Russian or Hebrew layout. There is no a VK_ constant for these and many other codes in various layouts. These codes may be obtained by using getExtendedKeyCode and are used whenever a VK_ constant is used.
Not all characters have a keycode associated with them. For example, there is no keycode for the question mark because there is no keyboard for which it appears on the primary layer.
In order to support the platform-independent handling of action keys, the Java platform uses a few additional virtual key constants for functions that would otherwise have to be recognized by interpreting virtual key codes and modifiers. For example, for Japanese Windows keyboards, VK_ALL_CANDIDATES is returned instead of VK_CONVERT with the ALT modifier.
As specified in Focus Specification key events are dispatched to the focus owner by default.

WARNING: Aside from those keys that are defined by the Java language (VK_ENTER, VK_BACK_SPACE, and VK_TAB), do not rely on the values of the VK_ constants. Sun reserves the right to change these values as needed to accomodate a wider range of keyboards in the future.

An unspecified behavior will be caused if the id parameter of any particular KeyEvent instance is not in the range from KEY_FIRST to KEY_LAST.

Since:: 1.1
See Also:: KeyAdapter, KeyListener, Tutorial: Writing a Key Listener, Serialized Form

Field Summary
`static char`	`CHAR_UNDEFINED` KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value.
`static int`	`KEY_FIRST` The first number in the range of ids used for key events.
`static int`	`KEY_LAST` The last number in the range of ids used for key events.
`static int`	`KEY_LOCATION_LEFT` 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` 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` 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` 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` A constant indicating that the keyLocation is indeterminate or not relevant.
`static int`	`KEY_PRESSED` The "key pressed" event.
`static int`	`KEY_RELEASED` The "key released" event.
`static int`	`KEY_TYPED` The "key typed" event.
`static int`	`VK_0` VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)
`static int`	`VK_1`
`static int`	`VK_2`
`static int`	`VK_3`
`static int`	`VK_4`
`static int`	`VK_5`
`static int`	`VK_6`
`static int`	`VK_7`
`static int`	`VK_8`
`static int`	`VK_9`
`static int`	`VK_A` VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)
`static int`	`VK_ACCEPT` Constant for the Accept or Commit function key.
`static int`	`VK_ADD`
`static int`	`VK_AGAIN`
`static int`	`VK_ALL_CANDIDATES` Constant for the All Candidates function key.
`static int`	`VK_ALPHANUMERIC` Constant for the Alphanumeric function key.
`static int`	`VK_ALT`
`static int`	`VK_ALT_GRAPH` Constant for the AltGraph function key.
`static int`	`VK_AMPERSAND`
`static int`	`VK_ASTERISK`
`static int`	`VK_AT` Constant for the "@" key.
`static int`	`VK_B`
`static int`	`VK_BACK_QUOTE`
`static int`	`VK_BACK_SLASH` Constant for the back slash key, "\"
`static int`	`VK_BACK_SPACE`
`static int`	`VK_BEGIN` Constant for the Begin key.
`static int`	`VK_BRACELEFT`
`static int`	`VK_BRACERIGHT`
`static int`	`VK_C`
`static int`	`VK_CANCEL`
`static int`	`VK_CAPS_LOCK`
`static int`	`VK_CIRCUMFLEX` Constant for the "^" key.
`static int`	`VK_CLEAR`
`static int`	`VK_CLOSE_BRACKET` Constant for the close bracket key, "]"
`static int`	`VK_CODE_INPUT` Constant for the Code Input function key.
`static int`	`VK_COLON` Constant for the ":" key.
`static int`	`VK_COMMA` Constant for the comma key, ","
`static int`	`VK_COMPOSE` Constant for the Compose function key.
`static int`	`VK_CONTEXT_MENU` Constant for the Microsoft Windows Context Menu key.
`static int`	`VK_CONTROL`
`static int`	`VK_CONVERT` Constant for the Convert function key.
`static int`	`VK_COPY`
`static int`	`VK_CUT`
`static int`	`VK_D`
`static int`	`VK_DEAD_ABOVEDOT`
`static int`	`VK_DEAD_ABOVERING`
`static int`	`VK_DEAD_ACUTE`
`static int`	`VK_DEAD_BREVE`
`static int`	`VK_DEAD_CARON`
`static int`	`VK_DEAD_CEDILLA`
`static int`	`VK_DEAD_CIRCUMFLEX`
`static int`	`VK_DEAD_DIAERESIS`
`static int`	`VK_DEAD_DOUBLEACUTE`
`static int`	`VK_DEAD_GRAVE`
`static int`	`VK_DEAD_IOTA`
`static int`	`VK_DEAD_MACRON`
`static int`	`VK_DEAD_OGONEK`
`static int`	`VK_DEAD_SEMIVOICED_SOUND`
`static int`	`VK_DEAD_TILDE`
`static int`	`VK_DEAD_VOICED_SOUND`
`static int`	`VK_DECIMAL`
`static int`	`VK_DELETE`
`static int`	`VK_DIVIDE`
`static int`	`VK_DOLLAR` Constant for the "$" key.
`static int`	`VK_DOWN` Constant for the non-numpad down arrow key.
`static int`	`VK_E`
`static int`	`VK_END`
`static int`	`VK_ENTER`
`static int`	`VK_EQUALS` Constant for the equals key, "="
`static int`	`VK_ESCAPE`
`static int`	`VK_EURO_SIGN` Constant for the Euro currency sign key.
`static int`	`VK_EXCLAMATION_MARK` Constant for the "!" key.
`static int`	`VK_F`
`static int`	`VK_F1` Constant for the F1 function key.
`static int`	`VK_F10` Constant for the F10 function key.
`static int`	`VK_F11` Constant for the F11 function key.
`static int`	`VK_F12` Constant for the F12 function key.
`static int`	`VK_F13` Constant for the F13 function key.
`static int`	`VK_F14` Constant for the F14 function key.
`static int`	`VK_F15` Constant for the F15 function key.
`static int`	`VK_F16` Constant for the F16 function key.
`static int`	`VK_F17` Constant for the F17 function key.
`static int`	`VK_F18` Constant for the F18 function key.
`static int`	`VK_F19` Constant for the F19 function key.
`static int`	`VK_F2` Constant for the F2 function key.
`static int`	`VK_F20` Constant for the F20 function key.
`static int`	`VK_F21` Constant for the F21 function key.
`static int`	`VK_F22` Constant for the F22 function key.
`static int`	`VK_F23` Constant for the F23 function key.
`static int`	`VK_F24` Constant for the F24 function key.
`static int`	`VK_F3` Constant for the F3 function key.
`static int`	`VK_F4` Constant for the F4 function key.
`static int`	`VK_F5` Constant for the F5 function key.
`static int`	`VK_F6` Constant for the F6 function key.
`static int`	`VK_F7` Constant for the F7 function key.
`static int`	`VK_F8` Constant for the F8 function key.
`static int`	`VK_F9` Constant for the F9 function key.
`static int`	`VK_FINAL`
`static int`	`VK_FIND`
`static int`	`VK_FULL_WIDTH` Constant for the Full-Width Characters function key.
`static int`	`VK_G`
`static int`	`VK_GREATER`
`static int`	`VK_H`
`static int`	`VK_HALF_WIDTH` Constant for the Half-Width Characters function key.
`static int`	`VK_HELP`
`static int`	`VK_HIRAGANA` Constant for the Hiragana function key.
`static int`	`VK_HOME`
`static int`	`VK_I`
`static int`	`VK_INPUT_METHOD_ON_OFF` Constant for the input method on/off key.
`static int`	`VK_INSERT`
`static int`	`VK_INVERTED_EXCLAMATION_MARK` Constant for the inverted exclamation mark key.
`static int`	`VK_J`
`static int`	`VK_JAPANESE_HIRAGANA` Constant for the Japanese-Hiragana function key.
`static int`	`VK_JAPANESE_KATAKANA` Constant for the Japanese-Katakana function key.
`static int`	`VK_JAPANESE_ROMAN` Constant for the Japanese-Roman function key.
`static int`	`VK_K`
`static int`	`VK_KANA`
`static int`	`VK_KANA_LOCK` Constant for the locking Kana function key.
`static int`	`VK_KANJI`
`static int`	`VK_KATAKANA` Constant for the Katakana function key.
`static int`	`VK_KP_DOWN` Constant for the numeric keypad down arrow key.
`static int`	`VK_KP_LEFT` Constant for the numeric keypad left arrow key.
`static int`	`VK_KP_RIGHT` Constant for the numeric keypad right arrow key.
`static int`	`VK_KP_UP` Constant for the numeric keypad up arrow key.
`static int`	`VK_L`
`static int`	`VK_LEFT` Constant for the non-numpad left arrow key.
`static int`	`VK_LEFT_PARENTHESIS` Constant for the "(" key.
`static int`	`VK_LESS`
`static int`	`VK_M`
`static int`	`VK_META`
`static int`	`VK_MINUS` Constant for the minus key, "-"
`static int`	`VK_MODECHANGE`
`static int`	`VK_MULTIPLY`
`static int`	`VK_N`
`static int`	`VK_NONCONVERT` Constant for the Don't Convert function key.
`static int`	`VK_NUM_LOCK`
`static int`	`VK_NUMBER_SIGN` Constant for the "#" key.
`static int`	`VK_NUMPAD0`
`static int`	`VK_NUMPAD1`
`static int`	`VK_NUMPAD2`
`static int`	`VK_NUMPAD3`
`static int`	`VK_NUMPAD4`
`static int`	`VK_NUMPAD5`
`static int`	`VK_NUMPAD6`
`static int`	`VK_NUMPAD7`
`static int`	`VK_NUMPAD8`
`static int`	`VK_NUMPAD9`
`static int`	`VK_O`
`static int`	`VK_OPEN_BRACKET` Constant for the open bracket key, "["
`static int`	`VK_P`
`static int`	`VK_PAGE_DOWN`
`static int`	`VK_PAGE_UP`
`static int`	`VK_PASTE`
`static int`	`VK_PAUSE`
`static int`	`VK_PERIOD` Constant for the period key, "."
`static int`	`VK_PLUS` Constant for the "+" key.
`static int`	`VK_PREVIOUS_CANDIDATE` Constant for the Previous Candidate function key.
`static int`	`VK_PRINTSCREEN`
`static int`	`VK_PROPS`
`static int`	`VK_Q`
`static int`	`VK_QUOTE`
`static int`	`VK_QUOTEDBL`
`static int`	`VK_R`
`static int`	`VK_RIGHT` Constant for the non-numpad right arrow key.
`static int`	`VK_RIGHT_PARENTHESIS` Constant for the ")" key.
`static int`	`VK_ROMAN_CHARACTERS` Constant for the Roman Characters function key.
`static int`	`VK_S`
`static int`	`VK_SCROLL_LOCK`
`static int`	`VK_SEMICOLON` Constant for the semicolon key, ";"
`static int`	`VK_SEPARATER` This constant is obsolete, and is included only for backwards compatibility.
`static int`	`VK_SEPARATOR` Constant for the Numpad Separator key.
`static int`	`VK_SHIFT`
`static int`	`VK_SLASH` Constant for the forward slash key, "/"
`static int`	`VK_SPACE`
`static int`	`VK_STOP`
`static int`	`VK_SUBTRACT`
`static int`	`VK_T`
`static int`	`VK_TAB`
`static int`	`VK_U`
`static int`	`VK_UNDEFINED` This value is used to indicate that the keyCode is unknown.
`static int`	`VK_UNDERSCORE` Constant for the "_" key.
`static int`	`VK_UNDO`
`static int`	`VK_UP` Constant for the non-numpad up arrow key.
`static int`	`VK_V`
`static int`	`VK_W`
`static int`	`VK_WINDOWS` Constant for the Microsoft Windows "Windows" key.
`static int`	`VK_X`
`static int`	`VK_Y`
`static int`	`VK_Z`

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, META_DOWN_MASK, META_MASK, SHIFT_DOWN_MASK, SHIFT_MASK`

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.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)` Deprecated. as of JDK1.1
`KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar)` Constructs a `KeyEvent` object.
`KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar, int keyLocation)` Constructs a `KeyEvent` object.

Method Summary
`int`	`getExtendedKeyCode()` Returns an extended key code for the event.
`static int`	`getExtendedKeyCodeForChar(int c)` Returns an extended key code for a unicode character.
`char`	`getKeyChar()` Returns the character associated with the key in this event.
`int`	`getKeyCode()` Returns the integer keyCode associated with the key in this event.
`int`	`getKeyLocation()` Returns the location of the key that originated this key event.
`static String`	`getKeyModifiersText(int modifiers)` Returns a `String` describing the modifier key(s), such as "Shift", or "Ctrl+Shift".
`static String`	`getKeyText(int keyCode)` Returns a String describing the keyCode, such as "HOME", "F1" or "A".
`boolean`	`isActionKey()` Returns whether the key in this event is an "action" key.
`String`	`paramString()` Returns a parameter string identifying this event.
`void`	`setKeyChar(char keyChar)` Set the keyChar value to indicate a logical character.
`void`	`setKeyCode(int keyCode)` Set the keyCode value to indicate a physical key.
`void`	`setModifiers(int modifiers)` Deprecated. as of JDK1.1.4

Methods inherited from class java.awt.event.InputEvent
`consume, getMaskForButton, 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

KEY_FIRST

public static final int KEY_FIRST

Class is disabled.

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

See Also:: Constant Field Values

KEY_LAST

public static final int KEY_LAST

Class is disabled.

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

See Also:: Constant Field Values

KEY_TYPED

public static final int KEY_TYPED

Class is disabled.

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.

See Also:: Constant Field Values

KEY_PRESSED

public static final int KEY_PRESSED

Class is disabled.

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

See Also:: Constant Field Values

KEY_RELEASED

public static final int KEY_RELEASED

Class is disabled.

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

See Also:: Constant Field Values

VK_ENTER

public static final int VK_ENTER

Class is disabled.

VK_BACK_SPACE

public static final int VK_BACK_SPACE

Class is disabled.

VK_TAB

public static final int VK_TAB

Class is disabled.

VK_CANCEL

public static final int VK_CANCEL

Class is disabled.

VK_CLEAR

public static final int VK_CLEAR

Class is disabled.

VK_SHIFT

public static final int VK_SHIFT

Class is disabled.

VK_CONTROL

public static final int VK_CONTROL

Class is disabled.

VK_ALT

public static final int VK_ALT

Class is disabled.

VK_PAUSE

public static final int VK_PAUSE

Class is disabled.

VK_CAPS_LOCK

public static final int VK_CAPS_LOCK

Class is disabled.

VK_ESCAPE

public static final int VK_ESCAPE

Class is disabled.

VK_SPACE

public static final int VK_SPACE

Class is disabled.

VK_PAGE_UP

public static final int VK_PAGE_UP

Class is disabled.

VK_PAGE_DOWN

public static final int VK_PAGE_DOWN

Class is disabled.

VK_END

public static final int VK_END

Class is disabled.

VK_HOME

public static final int VK_HOME

Class is disabled.

VK_LEFT

public static final int VK_LEFT

Class is disabled.

Constant for the non-numpad left arrow key.

See Also:: VK_KP_LEFT, Constant Field Values

VK_UP

public static final int VK_UP

Class is disabled.

Constant for the non-numpad up arrow key.

See Also:: VK_KP_UP, Constant Field Values

VK_RIGHT

public static final int VK_RIGHT

Class is disabled.

Constant for the non-numpad right arrow key.

See Also:: VK_KP_RIGHT, Constant Field Values

VK_DOWN

public static final int VK_DOWN

Class is disabled.

Constant for the non-numpad down arrow key.

See Also:: VK_KP_DOWN, Constant Field Values

VK_COMMA

public static final int VK_COMMA

Class is disabled.

Constant for the comma key, ","

See Also:: Constant Field Values

VK_MINUS

public static final int VK_MINUS

Class is disabled.

Constant for the minus key, "-"

Since:: 1.2
See Also:: Constant Field Values

VK_PERIOD

public static final int VK_PERIOD

Class is disabled.

Constant for the period key, "."

See Also:: Constant Field Values

VK_SLASH

public static final int VK_SLASH

Class is disabled.

Constant for the forward slash key, "/"

See Also:: Constant Field Values

VK_0

public static final int VK_0

Class is disabled.

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

See Also:: Constant Field Values

VK_1

public static final int VK_1

Class is disabled.

VK_2

public static final int VK_2

Class is disabled.

VK_3

public static final int VK_3

Class is disabled.

VK_4

public static final int VK_4

Class is disabled.

VK_5

public static final int VK_5

Class is disabled.

VK_6

public static final int VK_6

Class is disabled.

VK_7

public static final int VK_7

Class is disabled.

VK_8

public static final int VK_8

Class is disabled.

VK_9

public static final int VK_9

Class is disabled.

VK_SEMICOLON

public static final int VK_SEMICOLON

Class is disabled.

Constant for the semicolon key, ";"

See Also:: Constant Field Values

VK_EQUALS

public static final int VK_EQUALS

Class is disabled.

Constant for the equals key, "="

See Also:: Constant Field Values

VK_A

public static final int VK_A

Class is disabled.

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

See Also:: Constant Field Values

VK_B

public static final int VK_B

Class is disabled.

VK_C

public static final int VK_C

Class is disabled.

VK_D

public static final int VK_D

Class is disabled.

VK_E

public static final int VK_E

Class is disabled.

VK_F

public static final int VK_F

Class is disabled.

VK_G

public static final int VK_G

Class is disabled.

VK_H

public static final int VK_H

Class is disabled.

VK_I

public static final int VK_I

Class is disabled.

VK_J

public static final int VK_J

Class is disabled.

VK_K

public static final int VK_K

Class is disabled.

VK_L

public static final int VK_L

Class is disabled.

VK_M

public static final int VK_M

Class is disabled.

VK_N

public static final int VK_N

Class is disabled.

VK_O

public static final int VK_O

Class is disabled.

VK_P

public static final int VK_P

Class is disabled.

VK_Q

public static final int VK_Q

Class is disabled.

VK_R

public static final int VK_R

Class is disabled.

VK_S

public static final int VK_S

Class is disabled.

VK_T

public static final int VK_T

Class is disabled.

VK_U

public static final int VK_U

Class is disabled.

VK_V

public static final int VK_V

Class is disabled.

VK_W

public static final int VK_W

Class is disabled.

VK_X

public static final int VK_X

Class is disabled.

VK_Y

public static final int VK_Y

Class is disabled.

VK_Z

public static final int VK_Z

Class is disabled.

VK_OPEN_BRACKET

public static final int VK_OPEN_BRACKET

Class is disabled.

Constant for the open bracket key, "["

See Also:: Constant Field Values

VK_BACK_SLASH

public static final int VK_BACK_SLASH

Class is disabled.

Constant for the back slash key, "\"

See Also:: Constant Field Values

VK_CLOSE_BRACKET

public static final int VK_CLOSE_BRACKET

Class is disabled.

Constant for the close bracket key, "]"

See Also:: Constant Field Values

VK_NUMPAD0

public static final int VK_NUMPAD0

Class is disabled.

VK_NUMPAD1

public static final int VK_NUMPAD1

Class is disabled.

VK_NUMPAD2

public static final int VK_NUMPAD2

Class is disabled.

VK_NUMPAD3

public static final int VK_NUMPAD3

Class is disabled.

VK_NUMPAD4

public static final int VK_NUMPAD4

Class is disabled.

VK_NUMPAD5

public static final int VK_NUMPAD5

Class is disabled.

VK_NUMPAD6

public static final int VK_NUMPAD6

Class is disabled.

VK_NUMPAD7

public static final int VK_NUMPAD7

Class is disabled.

VK_NUMPAD8

public static final int VK_NUMPAD8

Class is disabled.

VK_NUMPAD9

public static final int VK_NUMPAD9

Class is disabled.

VK_MULTIPLY

public static final int VK_MULTIPLY

Class is disabled.

VK_ADD

public static final int VK_ADD

Class is disabled.

VK_SEPARATER

public static final int VK_SEPARATER

Class is disabled.

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

See Also:: VK_SEPARATOR, Constant Field Values

VK_SEPARATOR

public static final int VK_SEPARATOR

Class is disabled.

Constant for the Numpad Separator key.

Since:: 1.4
See Also:: Constant Field Values

VK_SUBTRACT

public static final int VK_SUBTRACT

Class is disabled.

VK_DECIMAL

public static final int VK_DECIMAL

Class is disabled.

VK_DIVIDE

public static final int VK_DIVIDE

Class is disabled.

VK_DELETE

public static final int VK_DELETE

Class is disabled.

VK_NUM_LOCK

public static final int VK_NUM_LOCK

Class is disabled.

VK_SCROLL_LOCK

public static final int VK_SCROLL_LOCK

Class is disabled.

VK_F1

public static final int VK_F1

Class is disabled.

Constant for the F1 function key.

See Also:: Constant Field Values

VK_F2

public static final int VK_F2

Class is disabled.

Constant for the F2 function key.

See Also:: Constant Field Values

VK_F3

public static final int VK_F3

Class is disabled.

Constant for the F3 function key.

See Also:: Constant Field Values

VK_F4

public static final int VK_F4

Class is disabled.

Constant for the F4 function key.

See Also:: Constant Field Values

VK_F5

public static final int VK_F5

Class is disabled.

Constant for the F5 function key.

See Also:: Constant Field Values

VK_F6

public static final int VK_F6

Class is disabled.

Constant for the F6 function key.

See Also:: Constant Field Values

VK_F7

public static final int VK_F7

Class is disabled.

Constant for the F7 function key.

See Also:: Constant Field Values

VK_F8

public static final int VK_F8

Class is disabled.

Constant for the F8 function key.

See Also:: Constant Field Values

VK_F9

public static final int VK_F9

Class is disabled.

Constant for the F9 function key.

See Also:: Constant Field Values

VK_F10

public static final int VK_F10

Class is disabled.

Constant for the F10 function key.

See Also:: Constant Field Values

VK_F11

public static final int VK_F11

Class is disabled.

Constant for the F11 function key.

See Also:: Constant Field Values

VK_F12

public static final int VK_F12

Class is disabled.

Constant for the F12 function key.

See Also:: Constant Field Values

VK_F13

public static final int VK_F13

Class is disabled.

Constant for the F13 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F14

public static final int VK_F14

Class is disabled.

Constant for the F14 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F15

public static final int VK_F15

Class is disabled.

Constant for the F15 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F16

public static final int VK_F16

Class is disabled.

Constant for the F16 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F17

public static final int VK_F17

Class is disabled.

Constant for the F17 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F18

public static final int VK_F18

Class is disabled.

Constant for the F18 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F19

public static final int VK_F19

Class is disabled.

Constant for the F19 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F20

public static final int VK_F20

Class is disabled.

Constant for the F20 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F21

public static final int VK_F21

Class is disabled.

Constant for the F21 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F22

public static final int VK_F22

Class is disabled.

Constant for the F22 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F23

public static final int VK_F23

Class is disabled.

Constant for the F23 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_F24

public static final int VK_F24

Class is disabled.

Constant for the F24 function key.

Since:: 1.2
See Also:: Constant Field Values

VK_PRINTSCREEN

public static final int VK_PRINTSCREEN

Class is disabled.

VK_INSERT

public static final int VK_INSERT

Class is disabled.

VK_HELP

public static final int VK_HELP

Class is disabled.

VK_META

public static final int VK_META

Class is disabled.

VK_BACK_QUOTE

public static final int VK_BACK_QUOTE

Class is disabled.

VK_QUOTE

public static final int VK_QUOTE

Class is disabled.

VK_KP_UP

public static final int VK_KP_UP

Class is disabled.

Constant for the numeric keypad up arrow key.

Since:: 1.2
See Also:: VK_UP, Constant Field Values

VK_KP_DOWN

public static final int VK_KP_DOWN

Class is disabled.

Constant for the numeric keypad down arrow key.

Since:: 1.2
See Also:: VK_DOWN, Constant Field Values

VK_KP_LEFT

public static final int VK_KP_LEFT

Class is disabled.

Constant for the numeric keypad left arrow key.

Since:: 1.2
See Also:: VK_LEFT, Constant Field Values

VK_KP_RIGHT

public static final int VK_KP_RIGHT

Class is disabled.

Constant for the numeric keypad right arrow key.

Since:: 1.2
See Also:: VK_RIGHT, Constant Field Values

VK_DEAD_GRAVE

public static final int VK_DEAD_GRAVE

Class is disabled.

VK_DEAD_ACUTE

public static final int VK_DEAD_ACUTE

Class is disabled.

VK_DEAD_CIRCUMFLEX

public static final int VK_DEAD_CIRCUMFLEX

Class is disabled.

VK_DEAD_TILDE

public static final int VK_DEAD_TILDE

Class is disabled.

VK_DEAD_MACRON

public static final int VK_DEAD_MACRON

Class is disabled.

VK_DEAD_BREVE

public static final int VK_DEAD_BREVE

Class is disabled.

VK_DEAD_ABOVEDOT

public static final int VK_DEAD_ABOVEDOT

Class is disabled.

VK_DEAD_DIAERESIS

public static final int VK_DEAD_DIAERESIS

Class is disabled.

VK_DEAD_ABOVERING

public static final int VK_DEAD_ABOVERING

Class is disabled.

VK_DEAD_DOUBLEACUTE

public static final int VK_DEAD_DOUBLEACUTE

Class is disabled.

VK_DEAD_CARON

public static final int VK_DEAD_CARON

Class is disabled.

VK_DEAD_CEDILLA

public static final int VK_DEAD_CEDILLA

Class is disabled.

VK_DEAD_OGONEK

public static final int VK_DEAD_OGONEK

Class is disabled.

VK_DEAD_IOTA

public static final int VK_DEAD_IOTA

Class is disabled.

VK_DEAD_VOICED_SOUND

public static final int VK_DEAD_VOICED_SOUND

Class is disabled.

VK_DEAD_SEMIVOICED_SOUND

public static final int VK_DEAD_SEMIVOICED_SOUND

Class is disabled.

VK_AMPERSAND

public static final int VK_AMPERSAND

Class is disabled.

VK_ASTERISK

public static final int VK_ASTERISK

Class is disabled.

VK_QUOTEDBL

public static final int VK_QUOTEDBL

Class is disabled.

VK_LESS

public static final int VK_LESS

Class is disabled.

VK_GREATER

public static final int VK_GREATER

Class is disabled.

VK_BRACELEFT

public static final int VK_BRACELEFT

Class is disabled.

VK_BRACERIGHT

public static final int VK_BRACERIGHT

Class is disabled.

VK_AT

public static final int VK_AT

Class is disabled.

Constant for the "@" key.

Since:: 1.2
See Also:: Constant Field Values

VK_COLON

public static final int VK_COLON

Class is disabled.

Constant for the ":" key.

Since:: 1.2
See Also:: Constant Field Values

VK_CIRCUMFLEX

public static final int VK_CIRCUMFLEX

Class is disabled.

Constant for the "^" key.

Since:: 1.2
See Also:: Constant Field Values

VK_DOLLAR

public static final int VK_DOLLAR

Class is disabled.

Constant for the "$" key.

Since:: 1.2
See Also:: Constant Field Values

VK_EURO_SIGN

public static final int VK_EURO_SIGN

Class is disabled.

Constant for the Euro currency sign key.

Since:: 1.2
See Also:: Constant Field Values

VK_EXCLAMATION_MARK

public static final int VK_EXCLAMATION_MARK

Class is disabled.

Constant for the "!" key.

Since:: 1.2
See Also:: Constant Field Values

VK_INVERTED_EXCLAMATION_MARK

public static final int VK_INVERTED_EXCLAMATION_MARK

Class is disabled.

Constant for the inverted exclamation mark key.

Since:: 1.2
See Also:: Constant Field Values

VK_LEFT_PARENTHESIS

public static final int VK_LEFT_PARENTHESIS

Class is disabled.

Constant for the "(" key.

Since:: 1.2
See Also:: Constant Field Values

VK_NUMBER_SIGN

public static final int VK_NUMBER_SIGN

Class is disabled.

Constant for the "#" key.

Since:: 1.2
See Also:: Constant Field Values

VK_PLUS

public static final int VK_PLUS

Class is disabled.

Constant for the "+" key.

Since:: 1.2
See Also:: Constant Field Values

VK_RIGHT_PARENTHESIS

public static final int VK_RIGHT_PARENTHESIS

Class is disabled.

Constant for the ")" key.

Since:: 1.2
See Also:: Constant Field Values

VK_UNDERSCORE

public static final int VK_UNDERSCORE

Class is disabled.

Constant for the "_" key.

Since:: 1.2
See Also:: Constant Field Values

VK_WINDOWS

public static final int VK_WINDOWS

Class is disabled.

Constant for the Microsoft Windows "Windows" key. It is used for both the left and right version of the key.

Since:: 1.5
See Also:: getKeyLocation(), Constant Field Values

VK_CONTEXT_MENU

public static final int VK_CONTEXT_MENU

Class is disabled.

Constant for the Microsoft Windows Context Menu key.

Since:: 1.5
See Also:: Constant Field Values

VK_FINAL

public static final int VK_FINAL

Class is disabled.

VK_CONVERT

public static final int VK_CONVERT

Class is disabled.

Constant for the Convert function key.

See Also:: Constant Field Values

VK_NONCONVERT

public static final int VK_NONCONVERT

Class is disabled.

Constant for the Don't Convert function key.

See Also:: Constant Field Values

VK_ACCEPT

public static final int VK_ACCEPT

Class is disabled.

Constant for the Accept or Commit function key.

See Also:: Constant Field Values

VK_MODECHANGE

public static final int VK_MODECHANGE

Class is disabled.

VK_KANA

public static final int VK_KANA

Class is disabled.

VK_KANJI

public static final int VK_KANJI

Class is disabled.

VK_ALPHANUMERIC

public static final int VK_ALPHANUMERIC

Class is disabled.

Constant for the Alphanumeric function key.

Since:: 1.2
See Also:: Constant Field Values

VK_KATAKANA

public static final int VK_KATAKANA

Class is disabled.

Constant for the Katakana function key.

Since:: 1.2
See Also:: Constant Field Values

VK_HIRAGANA

public static final int VK_HIRAGANA

Class is disabled.

Constant for the Hiragana function key.

Since:: 1.2
See Also:: Constant Field Values

VK_FULL_WIDTH

public static final int VK_FULL_WIDTH

Class is disabled.

Constant for the Full-Width Characters function key.

Since:: 1.2
See Also:: Constant Field Values

VK_HALF_WIDTH

public static final int VK_HALF_WIDTH

Class is disabled.

Constant for the Half-Width Characters function key.

Since:: 1.2
See Also:: Constant Field Values

VK_ROMAN_CHARACTERS

public static final int VK_ROMAN_CHARACTERS

Class is disabled.

Constant for the Roman Characters function key.

Since:: 1.2
See Also:: Constant Field Values

VK_ALL_CANDIDATES

public static final int VK_ALL_CANDIDATES

Class is disabled.

Constant for the All Candidates function key.

Since:: 1.2
See Also:: Constant Field Values

VK_PREVIOUS_CANDIDATE

public static final int VK_PREVIOUS_CANDIDATE

Class is disabled.

Constant for the Previous Candidate function key.

Since:: 1.2
See Also:: Constant Field Values

VK_CODE_INPUT

public static final int VK_CODE_INPUT

Class is disabled.

Constant for the Code Input function key.

Since:: 1.2
See Also:: Constant Field Values

VK_JAPANESE_KATAKANA

public static final int VK_JAPANESE_KATAKANA

Class is disabled.

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

Since:: 1.2
See Also:: Constant Field Values

VK_JAPANESE_HIRAGANA

public static final int VK_JAPANESE_HIRAGANA

Class is disabled.

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

Since:: 1.2
See Also:: Constant Field Values

VK_JAPANESE_ROMAN

public static final int VK_JAPANESE_ROMAN

Class is disabled.

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
See Also:: Constant Field Values

VK_KANA_LOCK

public static final int VK_KANA_LOCK

Class is disabled.

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

Since:: 1.3
See Also:: Constant Field Values

VK_INPUT_METHOD_ON_OFF

public static final int VK_INPUT_METHOD_ON_OFF

Class is disabled.

Constant for the input method on/off key.

Since:: 1.3
See Also:: Constant Field Values

VK_CUT

public static final int VK_CUT

Class is disabled.

VK_COPY

public static final int VK_COPY

Class is disabled.

VK_PASTE

public static final int VK_PASTE

Class is disabled.

VK_UNDO

public static final int VK_UNDO

Class is disabled.

VK_AGAIN

public static final int VK_AGAIN

Class is disabled.

VK_FIND

public static final int VK_FIND

Class is disabled.

VK_PROPS

public static final int VK_PROPS

Class is disabled.

VK_STOP

public static final int VK_STOP

Class is disabled.

VK_COMPOSE

public static final int VK_COMPOSE

Class is disabled.

Constant for the Compose function key.

Since:: 1.2
See Also:: Constant Field Values

VK_ALT_GRAPH

public static final int VK_ALT_GRAPH

Class is disabled.

Constant for the AltGraph function key.

Since:: 1.2
See Also:: Constant Field Values

VK_BEGIN

public static final int VK_BEGIN

Class is disabled.

Constant for the Begin key.

Since:: 1.5
See Also:: Constant Field Values

VK_UNDEFINED

public static final int VK_UNDEFINED

Class is disabled.

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.

See Also:: Constant Field Values

CHAR_UNDEFINED

public static final char CHAR_UNDEFINED

Class is disabled.

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

See Also:: Constant Field Values

KEY_LOCATION_UNKNOWN

public static final int KEY_LOCATION_UNKNOWN

Class is disabled.

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
See Also:: Constant Field Values

KEY_LOCATION_STANDARD

public static final int KEY_LOCATION_STANDARD

Class is disabled.

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
See Also:: Constant Field Values

KEY_LOCATION_LEFT

public static final int KEY_LOCATION_LEFT

Class is disabled.

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
See Also:: Constant Field Values

KEY_LOCATION_RIGHT

public static final int KEY_LOCATION_RIGHT

Class is disabled.

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
See Also:: Constant Field Values

KEY_LOCATION_NUMPAD

public static final int KEY_LOCATION_NUMPAD

Class is disabled.

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
See Also:: Constant Field Values

Constructor Detail

KeyEvent

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

Class is disabled.

Constructs a KeyEvent object.

This method throws an IllegalArgumentException if source is null.

Parameters:: source - The Component that originated the event; id - An integer indicating the type of event. For information on allowable values, see the class description for KeyEvent; when - A long integer that specifies the time the event occurred. Passing negative or zero value is not recommended; modifiers - The modifier keys down during event (shift, ctrl, alt, meta). Passing negative value is not recommended. Zero value means that no modifiers were passed. Use either an extended _DOWN_MASK or old _MASK modifiers, however do not mix models in the one event. The extended modifiers are preferred for using; 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.
Throws:: IllegalArgumentException - if id is KEY_TYPED and keyChar is CHAR_UNDEFINED; or if id is KEY_TYPED and keyCode is not VK_UNDEFINED; or if id is KEY_TYPED and keyLocation is not KEY_LOCATION_UNKNOWN; or if keyLocation is not one of the legal values enumerated above.; IllegalArgumentException - if source is null
Since:: 1.4
See Also:: EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getKeyCode(), getKeyChar(), getKeyLocation()

KeyEvent

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

Class is disabled.

Constructs a KeyEvent object.

This method throws an IllegalArgumentException if source is null.

Parameters:: source - The Component that originated the event; id - An integer indicating the type of event. For information on allowable values, see the class description for KeyEvent; when - A long integer that specifies the time the event occurred. Passing negative or zero value is not recommended; modifiers - The modifier keys down during event (shift, ctrl, alt, meta). Passing negative value is not recommended. Zero value means that no modifiers were passed. Use either an extended _DOWN_MASK or old _MASK modifiers, however do not mix models in the one event. The extended modifiers are preferred for using; 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)
Throws:: IllegalArgumentException - if id is KEY_TYPED and keyChar is CHAR_UNDEFINED; or if id is KEY_TYPED and keyCode is not VK_UNDEFINED; IllegalArgumentException - if source is null
See Also:: EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getKeyCode(), getKeyChar()

KeyEvent

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

Deprecated. as of JDK1.1

Class is disabled.

Method Detail

getKeyCode

public int getKeyCode()

Class is disabled.

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)

Class is disabled.

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()

Class is disabled.

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

KEY_PRESSED and KEY_RELEASED events are not intended for reporting of character input. Therefore, the values returned by this method are guaranteed to be meaningful only for KEY_TYPED events.

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

setKeyChar

public void setKeyChar(char keyChar)

Class is disabled.

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

@Deprecated
public void setModifiers(int modifiers)

Deprecated. as of JDK1.1.4

Class is disabled.

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()

Class is disabled.

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)

Class is disabled.

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)

Class is disabled.

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.

Note that InputEvent.ALT_MASK and InputEvent.BUTTON2_MASK have the same value, so the string "Alt" is returned for both modifiers. Likewise, InputEvent.META_MASK and InputEvent.BUTTON3_MASK have the same value, so the string "Meta" is returned for both modifiers.

Returns:: string a text description of the combination of modifier keys that were held down during the event
See Also:: InputEvent.getModifiersExText(int)

isActionKey

public boolean isActionKey()

Class is disabled.

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()

Class is disabled.

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

getExtendedKeyCode

public int getExtendedKeyCode()

Class is disabled.

Returns an extended key code for the event. The extended key code is a unique id assigned to a key on the keyboard just like keyCode. However, unlike keyCode, this value depends on the current keyboard layout. For instance, pressing the left topmost letter key in a common English layout produces the same value as keyCode, VK_Q. Pressing the same key in a regular Russian layout gives another code, unique for the letter "Cyrillic I short".

Since:: 1.7

getExtendedKeyCodeForChar

public static int getExtendedKeyCodeForChar(int c)

Class is disabled.

Returns an extended key code for a unicode character.

Returns:: for a unicode character with a corresponding VK_ constant -- this VK_ constant; for a character appearing on the primary level of a known keyboard layout -- a unique integer. If a character does not appear on the primary level of a known keyboard, VK_UNDEFINED is returned.
Since:: 1.7

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt.event Class KeyEvent

KEY_FIRST

KEY_LAST

KEY_TYPED

KEY_PRESSED

KEY_RELEASED

VK_ENTER

VK_BACK_SPACE

VK_TAB

VK_CANCEL

VK_CLEAR

VK_SHIFT

VK_CONTROL

VK_ALT

VK_PAUSE

VK_CAPS_LOCK

VK_ESCAPE

VK_SPACE

VK_PAGE_UP

VK_PAGE_DOWN

VK_END

VK_HOME

VK_LEFT

VK_UP

VK_RIGHT

VK_DOWN

VK_COMMA

VK_MINUS

VK_PERIOD

VK_SLASH

VK_0

VK_1

VK_2

VK_3

VK_4

VK_5

VK_6

VK_7

VK_8

VK_9

VK_SEMICOLON

VK_EQUALS

VK_A

VK_B

VK_C

VK_D

VK_E

VK_F

VK_G

VK_H

VK_I

VK_J

VK_K

VK_L

VK_M

VK_N

VK_O

VK_P

VK_Q

VK_R

VK_S

VK_T

VK_U

VK_V

VK_W

VK_X

VK_Y

VK_Z

VK_OPEN_BRACKET

VK_BACK_SLASH

VK_CLOSE_BRACKET

VK_NUMPAD0

VK_NUMPAD1

VK_NUMPAD2

VK_NUMPAD3

VK_NUMPAD4

VK_NUMPAD5

VK_NUMPAD6

VK_NUMPAD7

VK_NUMPAD8

java.awt.event
Class KeyEvent