java.awt.event

Class KeyEvent

public class KeyEvent extends InputEvent

This event is generated when a key is pressed or released. There are two categories of key events:

"Key typed" events are higher-level, and have already compensated for modifiers and keyboard layout to generate a single Unicode character. It may take several key press events to generate one key typed. The getKeyCode method will return VK_UNDEFINED, and getKeyChar will return a valid Unicode character or CHAR_UNDEFINED.

"Key pressed" and "key released" events are lower-level, and are platform and keyboard dependent. They correspond to the actaul motion on a keyboard, and return a virtual key code which labels the key that was pressed. The getKeyCode method will return one of the VK_* constants (except VK_UNDEFINED), and the getKeyChar method is undefined.

Some keys do not generate key typed events, such as the F1 or HELP keys. Not all keyboards can generate all virtual keys, and no attempt is made to simulate the ones that can't be typed. Virtual keys correspond to the keyboard layout, so for example, VK_Q in English is VK_A in French. Also, there are some additional virtual keys to ease handling of actions, such as VK_ALL_CANDIDATES in place of ALT+VK_CONVERT. Do not rely on the value of the VK_* constants, except for VK_ENTER, VK_BACK_SPACE, and VK_TAB.

Since: 1.1

See Also: KeyAdapter KeyListener

UNKNOWN: updated to 1.4

Field Summary
static charCHAR_UNDEFINED
The only char with no valid Unicode interpretation.
static intKEY_FIRST
This is the first id in the range of event ids used by this class.
static intKEY_LAST
This is the last id in the range of event ids used by this class.
static intKEY_LOCATION_LEFT
Indicates the key is on the left side of the keyboard, such as the left shift.
static intKEY_LOCATION_NUMPAD
Indicates the key is on the numeric pad, such as the numpad 0.
static intKEY_LOCATION_RIGHT
Indicates the key is on the right side of the keyboard, such as the right shift.
static intKEY_LOCATION_STANDARD
Indicates a standard key location, with no left/right variants and not on the numeric pad.
static intKEY_LOCATION_UNKNOWN
Indicates unknown or irrelavent key location.
static intKEY_PRESSED
This event id indicates a key was pressed.
static intKEY_RELEASED
This event it indicates a key was released.
static intKEY_TYPED
This event id indicates a key was typed, which is a key press followed by a key release to generate an actual Unicode character.
static intVK_0
The virtual key VK_0.
static intVK_1
The virtual key VK_1.
static intVK_2
The virtual key VK_2.
static intVK_3
The virtual key VK_3.
static intVK_4
The virtual key VK_4.
static intVK_5
The virtual key VK_5.
static intVK_6
The virtual key VK_6.
static intVK_7
The virtual key VK_7.
static intVK_8
The virtual key VK_8.
static intVK_9
The virtual key VK_9.
static intVK_A
The virtual key VK_A.
static intVK_ACCEPT
The virtual key VK_ACCEPT.
static intVK_ADD
The virtual key VK_ADD.
static intVK_AGAIN
The virtual key VK_AGAIN.
static intVK_ALL_CANDIDATES
The virtual key VK_ALL_CANDIDATES.
static intVK_ALPHANUMERIC
The virtual key VK_ALPHANUMERIC.
static intVK_ALT
The virtual key VK_ALT.
static intVK_ALT_GRAPH
The virtual key VK_ALT_GRAPH.
static intVK_AMPERSAND
The virtual key VK_AMPERSAND.
static intVK_ASTERISK
The virtual key VK_ASTERISK.
static intVK_AT
The virtual key VK_AT.
static intVK_B
The virtual key VK_B.
static intVK_BACK_QUOTE
The virtual key VK_BACK_QUOTE.
static intVK_BACK_SLASH
The virtual key VK_BACK_SLASH.
static intVK_BACK_SPACE
The virtual key Backspace, which will always map to '\b'.
static intVK_BEGIN
The 'begin' key VK_BEGIN
static intVK_BRACELEFT
The virtual key VK_BRACELEFT.
static intVK_BRACERIGHT
The virtual key VK_BRACERIGHT.
static intVK_C
The virtual key VK_C.
static intVK_CANCEL
The virtual key Cancel.
static intVK_CAPS_LOCK
The virtual key VK_CAPS_LOCK.
static intVK_CIRCUMFLEX
The virtual key VK_CIRCUMFLEX.
static intVK_CLEAR
The virtual key VK_CLEAR.
static intVK_CLOSE_BRACKET
The virtual key VK_CLOSE_BRACKET.
static intVK_CODE_INPUT
The virtual key VK_CODE_INPUT.
static intVK_COLON
The virtual key VK_COLON.
static intVK_COMMA
The virtual key VK_COMMA.
static intVK_COMPOSE
The virtual key VK_COMPOSE.
static intVK_CONTEXT_MENU
The context-menu key VK_CONTEXT_MENU
static intVK_CONTROL
The virtual key VK_CONTROL.
static intVK_CONVERT
The virtual key VK_CONVERT.
static intVK_COPY
The virtual key VK_COPY.
static intVK_CUT
The virtual key VK_CUT.
static intVK_D
The virtual key VK_D.
static intVK_DEAD_ABOVEDOT
The virtual key VK_DEAD_ABOVEDOT.
static intVK_DEAD_ABOVERING
The virtual key VK_DEAD_ABOVERING.
static intVK_DEAD_ACUTE
The virtual key VK_DEAD_ACUTE.
static intVK_DEAD_BREVE
The virtual key VK_DEAD_BREVE.
static intVK_DEAD_CARON
The virtual key VK_DEAD_CARON.
static intVK_DEAD_CEDILLA
The virtual key VK_DEAD_CEDILLA.
static intVK_DEAD_CIRCUMFLEX
The virtual key VK_DEAD_CIRCUMFLEX.
static intVK_DEAD_DIAERESIS
The virtual key VK_DEAD_DIAERESIS.
static intVK_DEAD_DOUBLEACUTE
The virtual key VK_DEAD_DOUBLEACUTE.
static intVK_DEAD_GRAVE
The virtual key VK_DEAD_GRAVE.
static intVK_DEAD_IOTA
The virtual key VK_DEAD_IOTA.
static intVK_DEAD_MACRON
The virtual key VK_DEAD_MACRON.
static intVK_DEAD_OGONEK
The virtual key VK_DEAD_OGONEK.
static intVK_DEAD_SEMIVOICED_SOUND
The virtual key VK_DEAD_SEMIVOICED_SOUND.
static intVK_DEAD_TILDE
The virtual key VK_DEAD_TILDE.
static intVK_DEAD_VOICED_SOUND
The virtual key VK_DEAD_VOICED_SOUND.
static intVK_DECIMAL
The virtual key VK_DECIMAL.
static intVK_DELETE
The virtual key VK_DELETE.
static intVK_DIVIDE
The virtual key VK_DIVIDE.
static intVK_DOLLAR
The virtual key VK_DOLLAR.
static intVK_DOWN
The virtual key for the non-numpad VK_DOWN.
static intVK_E
The virtual key VK_E.
static intVK_END
The virtual key VK_END.
static intVK_ENTER
The virtual key Enter, which will always map to '\n'.
static intVK_EQUALS
The virtual key VK_EQUALS.
static intVK_ESCAPE
The virtual key VK_ESCAPE.
static intVK_EURO_SIGN
The virtual key VK_EURO_SIGN.
static intVK_EXCLAMATION_MARK
The virtual key VK_EXCLAMATION_MARK.
static intVK_F
The virtual key VK_F.
static intVK_F1
The virtual key VK_F1.
static intVK_F10
The virtual key VK_F10.
static intVK_F11
The virtual key VK_F11.
static intVK_F12
The virtual key VK_F12.
static intVK_F13
The virtual key VK_F13.
static intVK_F14
The virtual key VK_F14.
static intVK_F15
The virtual key VK_F15.
static intVK_F16
The virtual key VK_F16.
static intVK_F17
The virtual key VK_F17.
static intVK_F18
The virtual key VK_F18.
static intVK_F19
The virtual key VK_F19.
static intVK_F2
The virtual key VK_F2.
static intVK_F20
The virtual key VK_F20.
static intVK_F21
The virtual key VK_F21.
static intVK_F22
The virtual key VK_F22.
static intVK_F23
The virtual key VK_F23.
static intVK_F24
The virtual key VK_F24.
static intVK_F3
The virtual key VK_F3.
static intVK_F4
The virtual key VK_F4.
static intVK_F5
The virtual key VK_F5.
static intVK_F6
The virtual key VK_F6.
static intVK_F7
The virtual key VK_F7.
static intVK_F8
The virtual key VK_F8.
static intVK_F9
The virtual key VK_F9.
static intVK_FINAL
The virtual key VK_FINAL.
static intVK_FIND
The virtual key VK_FIND.
static intVK_FULL_WIDTH
The virtual key VK_FULL_WIDTH.
static intVK_G
The virtual key VK_G.
static intVK_GREATER
The virtual key VK_GREATER.
static intVK_H
The virtual key VK_H.
static intVK_HALF_WIDTH
The virtual key VK_HALF_WIDTH.
static intVK_HELP
The virtual key VK_HELP.
static intVK_HIRAGANA
The virtual key VK_HIRAGANA.
static intVK_HOME
The virtual key VK_HOME.
static intVK_I
The virtual key VK_I.
static intVK_INPUT_METHOD_ON_OFF
The virtual key VK_INPUT_METHOD_ON_OFF.
static intVK_INSERT
The virtual key VK_INSERT.
static intVK_INVERTED_EXCLAMATION_MARK
The virtual key VK_INVERTED_EXCLAMATION_MARK.
static intVK_J
The virtual key VK_J.
static intVK_JAPANESE_HIRAGANA
The virtual key VK_JAPANESE_HIRAGANA.
static intVK_JAPANESE_KATAKANA
The virtual key VK_JAPANESE_KATAKANA.
static intVK_JAPANESE_ROMAN
The virtual key VK_JAPANESE_ROMAN.
static intVK_K
The virtual key VK_K.
static intVK_KANA
The virtual key VK_KANA.
static intVK_KANA_LOCK
The virtual key VK_KANA_LOCK.
static intVK_KANJI
The virtual key VK_KANJI.
static intVK_KATAKANA
The virtual key VK_KATAKANA.
static intVK_KP_DOWN
The virtual key for the numpad VK_KP_DOWN.
static intVK_KP_LEFT
The virtual key for the numpad VK_KP_LEFT.
static intVK_KP_RIGHT
The virtual key for the numpad VK_KP_RIGHT.
static intVK_KP_UP
The virtual key for the numpad VK_KP_UP.
static intVK_L
The virtual key VK_L.
static intVK_LEFT
The virtual key for the non-numpad VK_LEFT.
static intVK_LEFT_PARENTHESIS
The virtual key VK_LEFT_PARENTHESIS.
static intVK_LESS
The virtual key VK_LESS.
static intVK_M
The virtual key VK_M.
static intVK_META
The virtual key VK_META.
static intVK_MINUS
The virtual key VK_MINUS.
static intVK_MODECHANGE
The virtual key VK_MODECHANGE.
static intVK_MULTIPLY
The virtual key VK_MULTIPLY.
static intVK_N
The virtual key VK_N.
static intVK_NONCONVERT
The virtual key VK_NONCONVERT.
static intVK_NUMBER_SIGN
The virtual key VK_NUMBER_SIGN.
static intVK_NUMPAD0
The virtual key VK_NUMPAD0.
static intVK_NUMPAD1
The virtual key VK_NUMPAD1.
static intVK_NUMPAD2
The virtual key VK_NUMPAD2.
static intVK_NUMPAD3
The virtual key VK_NUMPAD3.
static intVK_NUMPAD4
The virtual key VK_NUMPAD4.
static intVK_NUMPAD5
The virtual key VK_NUMPAD5.
static intVK_NUMPAD6
The virtual key VK_NUMPAD6.
static intVK_NUMPAD7
The virtual key VK_NUMPAD7.
static intVK_NUMPAD8
The virtual key VK_NUMPAD8.
static intVK_NUMPAD9
The virtual key VK_NUMPAD9.
static intVK_NUM_LOCK
The virtual key VK_NUM_LOCK.
static intVK_O
The virtual key VK_O.
static intVK_OPEN_BRACKET
The virtual key VK_OPEN_BRACKET.
static intVK_P
The virtual key VK_P.
static intVK_PAGE_DOWN
The virtual key VK_PAGE_DOWN.
static intVK_PAGE_UP
The virtual key VK_PAGE_UP.
static intVK_PASTE
The virtual key VK_PASTE.
static intVK_PAUSE
The virtual key VK_PAUSE.
static intVK_PERIOD
The virtual key VK_PERIOD.
static intVK_PLUS
The virtual key VK_PLUS.
static intVK_PREVIOUS_CANDIDATE
The virtual key VK_PREVIOUS_CANDIDATE.
static intVK_PRINTSCREEN
The virtual key VK_PRINTSCREEN.
static intVK_PROPS
The virtual key VK_PROPS.
static intVK_Q
The virtual key VK_Q.
static intVK_QUOTE
The virtual key VK_QUOTE.
static intVK_QUOTEDBL
The virtual key VK_QUOTEDBL.
static intVK_R
The virtual key VK_R.
static intVK_RIGHT
The virtual key for the non-numpad VK_RIGHT.
static intVK_RIGHT_PARENTHESIS
The virtual key VK_RIGHT_PARENTHESIS.
static intVK_ROMAN_CHARACTERS
The virtual key VK_ROMAN_CHARACTERS.
static intVK_S
The virtual key VK_S.
static intVK_SCROLL_LOCK
The virtual key VK_SCROLL_LOCK.
static intVK_SEMICOLON
The virtual key VK_SEMICOLON.
static intVK_SEPARATER
The virtual key VK_SEPARATOR, handily mispelled for those who can't figure it out.
static intVK_SEPARATOR
The virtual key VK_SEPARATOR.
static intVK_SHIFT
The virtual key VK_SHIFT.
static intVK_SLASH
The virtual key VK_SLASH.
static intVK_SPACE
The virtual key VK_SPACE.
static intVK_STOP
The virtual key VK_STOP.
static intVK_SUBTRACT
The virtual key VK_SUBTRACT.
static intVK_T
The virtual key VK_T.
static intVK_TAB
The virtual key Tab, which will always map to '\t'.
static intVK_U
The virtual key VK_U.
static intVK_UNDEFINED
The virtual key VK_UNDEFINED.
static intVK_UNDERSCORE
The virtual key VK_UNDERSCORE.
static intVK_UNDO
The virtual key VK_UNDO.
static intVK_UP
The virtual key for the non-numpad VK_UP.
static intVK_V
The virtual key VK_V.
static intVK_W
The virtual key VK_W.
static intVK_WINDOWS
The 'Windows' key VK_WINDOWS
static intVK_X
The virtual key VK_X.
static intVK_Y
The virtual key VK_Y.
static intVK_Z
The virtual key VK_Z.
Constructor Summary
KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar, int keyLocation)
Initializes a new instance of KeyEvent with the specified information.
KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar)
Initializes a new instance of KeyEvent with the specified information.
KeyEvent(Component source, int id, long when, int modifiers, int keyCode)
Initializes a new instance of KeyEvent with the specified information.
Method Summary
chargetKeyChar()
Returns the Unicode value for the event key.
intgetKeyCode()
Returns the key code for the event key.
intgetKeyLocation()
Returns the keyboard location of the key that generated this event.
static StringgetKeyModifiersText(int modifiers)
Returns a string describing the modifiers, such as "Shift" or "Ctrl+Button1".
static StringgetKeyText(int keyCode)
Returns the text name of key code, such as "HOME", "F1", or "A".
booleanisActionKey()
Tests whether or not this key is an action key.
StringparamString()
Returns a string identifying the event.
voidsetKeyChar(char keyChar)
Sets the Unicode character for this event to the specified value.
voidsetKeyCode(int keyCode)
Sets the key code for this event.
voidsetModifiers(int modifiers)
Sets the modifier keys to the specified value.

Field Detail

CHAR_UNDEFINED

public static final char CHAR_UNDEFINED
The only char with no valid Unicode interpretation. This is used for key pressed and key released events which do not have a valid keyChar.

KEY_FIRST

public static final int KEY_FIRST
This is the first id in the range of event ids used by this class.

KEY_LAST

public static final int KEY_LAST
This is the last id in the range of event ids used by this class.

KEY_LOCATION_LEFT

public static final int KEY_LOCATION_LEFT
Indicates the key is on the left side of the keyboard, such as the left shift.

Since: 1.4

KEY_LOCATION_NUMPAD

public static final int KEY_LOCATION_NUMPAD
Indicates the key is on the numeric pad, such as the numpad 0.

Since: 1.4

KEY_LOCATION_RIGHT

public static final int KEY_LOCATION_RIGHT
Indicates the key is on the right side of the keyboard, such as the right shift.

Since: 1.4

KEY_LOCATION_STANDARD

public static final int KEY_LOCATION_STANDARD
Indicates a standard key location, with no left/right variants and not on the numeric pad.

Since: 1.4

KEY_LOCATION_UNKNOWN

public static final int KEY_LOCATION_UNKNOWN
Indicates unknown or irrelavent key location. This is also used for key typed events, which do not need a location.

Since: 1.4

KEY_PRESSED

public static final int KEY_PRESSED
This event id indicates a key was pressed.

KEY_RELEASED

public static final int KEY_RELEASED
This event it indicates a key was released.

KEY_TYPED

public static final int KEY_TYPED
This event id indicates a key was typed, which is a key press followed by a key release to generate an actual Unicode character. It may take several key presses to generate one key typed event, and some action keys have no corresponding key typed.

VK_0

public static final int VK_0
The virtual key VK_0.

VK_1

public static final int VK_1
The virtual key VK_1.

VK_2

public static final int VK_2
The virtual key VK_2.

VK_3

public static final int VK_3
The virtual key VK_3.

VK_4

public static final int VK_4
The virtual key VK_4.

VK_5

public static final int VK_5
The virtual key VK_5.

VK_6

public static final int VK_6
The virtual key VK_6.

VK_7

public static final int VK_7
The virtual key VK_7.

VK_8

public static final int VK_8
The virtual key VK_8.

VK_9

public static final int VK_9
The virtual key VK_9.

VK_A

public static final int VK_A
The virtual key VK_A.

VK_ACCEPT

public static final int VK_ACCEPT
The virtual key VK_ACCEPT.

VK_ADD

public static final int VK_ADD
The virtual key VK_ADD.

VK_AGAIN

public static final int VK_AGAIN
The virtual key VK_AGAIN.

Since: 1.2

VK_ALL_CANDIDATES

public static final int VK_ALL_CANDIDATES
The virtual key VK_ALL_CANDIDATES.

Since: 1.2

VK_ALPHANUMERIC

public static final int VK_ALPHANUMERIC
The virtual key VK_ALPHANUMERIC.

Since: 1.2

VK_ALT

public static final int VK_ALT
The virtual key VK_ALT.

VK_ALT_GRAPH

public static final int VK_ALT_GRAPH
The virtual key VK_ALT_GRAPH.

Since: 1.2

VK_AMPERSAND

public static final int VK_AMPERSAND
The virtual key VK_AMPERSAND.

Since: 1.2

VK_ASTERISK

public static final int VK_ASTERISK
The virtual key VK_ASTERISK.

Since: 1.2

VK_AT

public static final int VK_AT
The virtual key VK_AT.

Since: 1.2

VK_B

public static final int VK_B
The virtual key VK_B.

VK_BACK_QUOTE

public static final int VK_BACK_QUOTE
The virtual key VK_BACK_QUOTE.

VK_BACK_SLASH

public static final int VK_BACK_SLASH
The virtual key VK_BACK_SLASH.

VK_BACK_SPACE

public static final int VK_BACK_SPACE
The virtual key Backspace, which will always map to '\b'.

VK_BEGIN

public static final int VK_BEGIN
The 'begin' key VK_BEGIN

Since: 1.5

VK_BRACELEFT

public static final int VK_BRACELEFT
The virtual key VK_BRACELEFT.

Since: 1.2

VK_BRACERIGHT

public static final int VK_BRACERIGHT
The virtual key VK_BRACERIGHT.

Since: 1.2

VK_C

public static final int VK_C
The virtual key VK_C.

VK_CANCEL

public static final int VK_CANCEL
The virtual key Cancel.

VK_CAPS_LOCK

public static final int VK_CAPS_LOCK
The virtual key VK_CAPS_LOCK.

VK_CIRCUMFLEX

public static final int VK_CIRCUMFLEX
The virtual key VK_CIRCUMFLEX.

Since: 1.2

VK_CLEAR

public static final int VK_CLEAR
The virtual key VK_CLEAR.

VK_CLOSE_BRACKET

public static final int VK_CLOSE_BRACKET
The virtual key VK_CLOSE_BRACKET.

VK_CODE_INPUT

public static final int VK_CODE_INPUT
The virtual key VK_CODE_INPUT.

Since: 1.2

VK_COLON

public static final int VK_COLON
The virtual key VK_COLON.

Since: 1.2

VK_COMMA

public static final int VK_COMMA
The virtual key VK_COMMA.

VK_COMPOSE

public static final int VK_COMPOSE
The virtual key VK_COMPOSE.

Since: 1.2

VK_CONTEXT_MENU

public static final int VK_CONTEXT_MENU
The context-menu key VK_CONTEXT_MENU

Since: 1.5

VK_CONTROL

public static final int VK_CONTROL
The virtual key VK_CONTROL.

VK_CONVERT

public static final int VK_CONVERT
The virtual key VK_CONVERT.

VK_COPY

public static final int VK_COPY
The virtual key VK_COPY.

Since: 1.2

VK_CUT

public static final int VK_CUT
The virtual key VK_CUT.

Since: 1.2

VK_D

public static final int VK_D
The virtual key VK_D.

VK_DEAD_ABOVEDOT

public static final int VK_DEAD_ABOVEDOT
The virtual key VK_DEAD_ABOVEDOT.

Since: 1.2

VK_DEAD_ABOVERING

public static final int VK_DEAD_ABOVERING
The virtual key VK_DEAD_ABOVERING.

Since: 1.2

VK_DEAD_ACUTE

public static final int VK_DEAD_ACUTE
The virtual key VK_DEAD_ACUTE.

Since: 1.2

VK_DEAD_BREVE

public static final int VK_DEAD_BREVE
The virtual key VK_DEAD_BREVE.

Since: 1.2

VK_DEAD_CARON

public static final int VK_DEAD_CARON
The virtual key VK_DEAD_CARON.

Since: 1.2

VK_DEAD_CEDILLA

public static final int VK_DEAD_CEDILLA
The virtual key VK_DEAD_CEDILLA.

Since: 1.2

VK_DEAD_CIRCUMFLEX

public static final int VK_DEAD_CIRCUMFLEX
The virtual key VK_DEAD_CIRCUMFLEX.

Since: 1.2

VK_DEAD_DIAERESIS

public static final int VK_DEAD_DIAERESIS
The virtual key VK_DEAD_DIAERESIS.

Since: 1.2

VK_DEAD_DOUBLEACUTE

public static final int VK_DEAD_DOUBLEACUTE
The virtual key VK_DEAD_DOUBLEACUTE.

Since: 1.2

VK_DEAD_GRAVE

public static final int VK_DEAD_GRAVE
The virtual key VK_DEAD_GRAVE.

Since: 1.2

VK_DEAD_IOTA

public static final int VK_DEAD_IOTA
The virtual key VK_DEAD_IOTA.

Since: 1.2

VK_DEAD_MACRON

public static final int VK_DEAD_MACRON
The virtual key VK_DEAD_MACRON.

Since: 1.2

VK_DEAD_OGONEK

public static final int VK_DEAD_OGONEK
The virtual key VK_DEAD_OGONEK.

Since: 1.2

VK_DEAD_SEMIVOICED_SOUND

public static final int VK_DEAD_SEMIVOICED_SOUND
The virtual key VK_DEAD_SEMIVOICED_SOUND.

Since: 1.2

VK_DEAD_TILDE

public static final int VK_DEAD_TILDE
The virtual key VK_DEAD_TILDE.

Since: 1.2

VK_DEAD_VOICED_SOUND

public static final int VK_DEAD_VOICED_SOUND
The virtual key VK_DEAD_VOICED_SOUND.

Since: 1.2

VK_DECIMAL

public static final int VK_DECIMAL
The virtual key VK_DECIMAL.

VK_DELETE

public static final int VK_DELETE
The virtual key VK_DELETE.

VK_DIVIDE

public static final int VK_DIVIDE
The virtual key VK_DIVIDE.

VK_DOLLAR

public static final int VK_DOLLAR
The virtual key VK_DOLLAR.

Since: 1.2

VK_DOWN

public static final int VK_DOWN
The virtual key for the non-numpad VK_DOWN.

See Also: VK_KP_DOWN

VK_E

public static final int VK_E
The virtual key VK_E.

VK_END

public static final int VK_END
The virtual key VK_END.

VK_ENTER

public static final int VK_ENTER
The virtual key Enter, which will always map to '\n'.

VK_EQUALS

public static final int VK_EQUALS
The virtual key VK_EQUALS.

VK_ESCAPE

public static final int VK_ESCAPE
The virtual key VK_ESCAPE.

VK_EURO_SIGN

public static final int VK_EURO_SIGN
The virtual key VK_EURO_SIGN.

Since: 1.2

VK_EXCLAMATION_MARK

public static final int VK_EXCLAMATION_MARK
The virtual key VK_EXCLAMATION_MARK.

Since: 1.2

VK_F

public static final int VK_F
The virtual key VK_F.

VK_F1

public static final int VK_F1
The virtual key VK_F1.

VK_F10

public static final int VK_F10
The virtual key VK_F10.

VK_F11

public static final int VK_F11
The virtual key VK_F11.

VK_F12

public static final int VK_F12
The virtual key VK_F12.

VK_F13

public static final int VK_F13
The virtual key VK_F13.

Since: 1.2

VK_F14

public static final int VK_F14
The virtual key VK_F14.

Since: 1.2

VK_F15

public static final int VK_F15
The virtual key VK_F15.

Since: 1.2

VK_F16

public static final int VK_F16
The virtual key VK_F16.

Since: 1.2

VK_F17

public static final int VK_F17
The virtual key VK_F17.

Since: 1.2

VK_F18

public static final int VK_F18
The virtual key VK_F18.

Since: 1.2

VK_F19

public static final int VK_F19
The virtual key VK_F19.

Since: 1.2

VK_F2

public static final int VK_F2
The virtual key VK_F2.

VK_F20

public static final int VK_F20
The virtual key VK_F20.

Since: 1.2

VK_F21

public static final int VK_F21
The virtual key VK_F21.

Since: 1.2

VK_F22

public static final int VK_F22
The virtual key VK_F22.

Since: 1.2

VK_F23

public static final int VK_F23
The virtual key VK_F23.

Since: 1.2

VK_F24

public static final int VK_F24
The virtual key VK_F24.

Since: 1.2

VK_F3

public static final int VK_F3
The virtual key VK_F3.

VK_F4

public static final int VK_F4
The virtual key VK_F4.

VK_F5

public static final int VK_F5
The virtual key VK_F5.

VK_F6

public static final int VK_F6
The virtual key VK_F6.

VK_F7

public static final int VK_F7
The virtual key VK_F7.

VK_F8

public static final int VK_F8
The virtual key VK_F8.

VK_F9

public static final int VK_F9
The virtual key VK_F9.

VK_FINAL

public static final int VK_FINAL
The virtual key VK_FINAL.

VK_FIND

public static final int VK_FIND
The virtual key VK_FIND.

Since: 1.2

VK_FULL_WIDTH

public static final int VK_FULL_WIDTH
The virtual key VK_FULL_WIDTH.

Since: 1.2

VK_G

public static final int VK_G
The virtual key VK_G.

VK_GREATER

public static final int VK_GREATER
The virtual key VK_GREATER.

Since: 1.2

VK_H

public static final int VK_H
The virtual key VK_H.

VK_HALF_WIDTH

public static final int VK_HALF_WIDTH
The virtual key VK_HALF_WIDTH.

Since: 1.2

VK_HELP

public static final int VK_HELP
The virtual key VK_HELP.

VK_HIRAGANA

public static final int VK_HIRAGANA
The virtual key VK_HIRAGANA.

Since: 1.2

VK_HOME

public static final int VK_HOME
The virtual key VK_HOME.

VK_I

public static final int VK_I
The virtual key VK_I.

VK_INPUT_METHOD_ON_OFF

public static final int VK_INPUT_METHOD_ON_OFF
The virtual key VK_INPUT_METHOD_ON_OFF.

Since: 1.3

VK_INSERT

public static final int VK_INSERT
The virtual key VK_INSERT.

VK_INVERTED_EXCLAMATION_MARK

public static final int VK_INVERTED_EXCLAMATION_MARK
The virtual key VK_INVERTED_EXCLAMATION_MARK.

Since: 1.2

VK_J

public static final int VK_J
The virtual key VK_J.

VK_JAPANESE_HIRAGANA

public static final int VK_JAPANESE_HIRAGANA
The virtual key VK_JAPANESE_HIRAGANA.

Since: 1.2

VK_JAPANESE_KATAKANA

public static final int VK_JAPANESE_KATAKANA
The virtual key VK_JAPANESE_KATAKANA.

Since: 1.2

VK_JAPANESE_ROMAN

public static final int VK_JAPANESE_ROMAN
The virtual key VK_JAPANESE_ROMAN.

Since: 1.2

VK_K

public static final int VK_K
The virtual key VK_K.

VK_KANA

public static final int VK_KANA
The virtual key VK_KANA.

VK_KANA_LOCK

public static final int VK_KANA_LOCK
The virtual key VK_KANA_LOCK.

Since: 1.3

VK_KANJI

public static final int VK_KANJI
The virtual key VK_KANJI.

VK_KATAKANA

public static final int VK_KATAKANA
The virtual key VK_KATAKANA.

Since: 1.2

VK_KP_DOWN

public static final int VK_KP_DOWN
The virtual key for the numpad VK_KP_DOWN.

Since: 1.2

See Also: VK_DOWN

VK_KP_LEFT

public static final int VK_KP_LEFT
The virtual key for the numpad VK_KP_LEFT.

Since: 1.2

See Also: VK_LEFT

VK_KP_RIGHT

public static final int VK_KP_RIGHT
The virtual key for the numpad VK_KP_RIGHT.

Since: 1.2

See Also: VK_RIGHT

VK_KP_UP

public static final int VK_KP_UP
The virtual key for the numpad VK_KP_UP.

Since: 1.2

See Also: VK_UP

VK_L

public static final int VK_L
The virtual key VK_L.

VK_LEFT

public static final int VK_LEFT
The virtual key for the non-numpad VK_LEFT.

See Also: VK_KP_LEFT

VK_LEFT_PARENTHESIS

public static final int VK_LEFT_PARENTHESIS
The virtual key VK_LEFT_PARENTHESIS.

Since: 1.2

VK_LESS

public static final int VK_LESS
The virtual key VK_LESS.

Since: 1.2

VK_M

public static final int VK_M
The virtual key VK_M.

VK_META

public static final int VK_META
The virtual key VK_META.

VK_MINUS

public static final int VK_MINUS
The virtual key VK_MINUS.

Since: 1.2

VK_MODECHANGE

public static final int VK_MODECHANGE
The virtual key VK_MODECHANGE.

VK_MULTIPLY

public static final int VK_MULTIPLY
The virtual key VK_MULTIPLY.

VK_N

public static final int VK_N
The virtual key VK_N.

VK_NONCONVERT

public static final int VK_NONCONVERT
The virtual key VK_NONCONVERT.

VK_NUMBER_SIGN

public static final int VK_NUMBER_SIGN
The virtual key VK_NUMBER_SIGN.

Since: 1.2

VK_NUMPAD0

public static final int VK_NUMPAD0
The virtual key VK_NUMPAD0.

VK_NUMPAD1

public static final int VK_NUMPAD1
The virtual key VK_NUMPAD1.

VK_NUMPAD2

public static final int VK_NUMPAD2
The virtual key VK_NUMPAD2.

VK_NUMPAD3

public static final int VK_NUMPAD3
The virtual key VK_NUMPAD3.

VK_NUMPAD4

public static final int VK_NUMPAD4
The virtual key VK_NUMPAD4.

VK_NUMPAD5

public static final int VK_NUMPAD5
The virtual key VK_NUMPAD5.

VK_NUMPAD6

public static final int VK_NUMPAD6
The virtual key VK_NUMPAD6.

VK_NUMPAD7

public static final int VK_NUMPAD7
The virtual key VK_NUMPAD7.

VK_NUMPAD8

public static final int VK_NUMPAD8
The virtual key VK_NUMPAD8.

VK_NUMPAD9

public static final int VK_NUMPAD9
The virtual key VK_NUMPAD9.

VK_NUM_LOCK

public static final int VK_NUM_LOCK
The virtual key VK_NUM_LOCK.

VK_O

public static final int VK_O
The virtual key VK_O.

VK_OPEN_BRACKET

public static final int VK_OPEN_BRACKET
The virtual key VK_OPEN_BRACKET.

VK_P

public static final int VK_P
The virtual key VK_P.

VK_PAGE_DOWN

public static final int VK_PAGE_DOWN
The virtual key VK_PAGE_DOWN.

VK_PAGE_UP

public static final int VK_PAGE_UP
The virtual key VK_PAGE_UP.

VK_PASTE

public static final int VK_PASTE
The virtual key VK_PASTE.

Since: 1.2

VK_PAUSE

public static final int VK_PAUSE
The virtual key VK_PAUSE.

VK_PERIOD

public static final int VK_PERIOD
The virtual key VK_PERIOD.

VK_PLUS

public static final int VK_PLUS
The virtual key VK_PLUS.

Since: 1.2

VK_PREVIOUS_CANDIDATE

public static final int VK_PREVIOUS_CANDIDATE
The virtual key VK_PREVIOUS_CANDIDATE.

Since: 1.2

VK_PRINTSCREEN

public static final int VK_PRINTSCREEN
The virtual key VK_PRINTSCREEN.

VK_PROPS

public static final int VK_PROPS
The virtual key VK_PROPS.

Since: 1.2

VK_Q

public static final int VK_Q
The virtual key VK_Q.

VK_QUOTE

public static final int VK_QUOTE
The virtual key VK_QUOTE.

VK_QUOTEDBL

public static final int VK_QUOTEDBL
The virtual key VK_QUOTEDBL.

Since: 1.2

VK_R

public static final int VK_R
The virtual key VK_R.

VK_RIGHT

public static final int VK_RIGHT
The virtual key for the non-numpad VK_RIGHT.

See Also: VK_KP_RIGHT

VK_RIGHT_PARENTHESIS

public static final int VK_RIGHT_PARENTHESIS
The virtual key VK_RIGHT_PARENTHESIS.

Since: 1.2

VK_ROMAN_CHARACTERS

public static final int VK_ROMAN_CHARACTERS
The virtual key VK_ROMAN_CHARACTERS.

Since: 1.2

VK_S

public static final int VK_S
The virtual key VK_S.

VK_SCROLL_LOCK

public static final int VK_SCROLL_LOCK
The virtual key VK_SCROLL_LOCK.

VK_SEMICOLON

public static final int VK_SEMICOLON
The virtual key VK_SEMICOLON.

VK_SEPARATER

public static final int VK_SEPARATER

Deprecated: use {@link #VK_SEPARATOR}

The virtual key VK_SEPARATOR, handily mispelled for those who can't figure it out.

VK_SEPARATOR

public static final int VK_SEPARATOR
The virtual key VK_SEPARATOR.

Since: 1.4

VK_SHIFT

public static final int VK_SHIFT
The virtual key VK_SHIFT.

VK_SLASH

public static final int VK_SLASH
The virtual key VK_SLASH.

VK_SPACE

public static final int VK_SPACE
The virtual key VK_SPACE.

VK_STOP

public static final int VK_STOP
The virtual key VK_STOP.

Since: 1.2

VK_SUBTRACT

public static final int VK_SUBTRACT
The virtual key VK_SUBTRACT.

VK_T

public static final int VK_T
The virtual key VK_T.

VK_TAB

public static final int VK_TAB
The virtual key Tab, which will always map to '\t'.

VK_U

public static final int VK_U
The virtual key VK_U.

VK_UNDEFINED

public static final int VK_UNDEFINED
The virtual key VK_UNDEFINED. This is used for key typed events, which do not have a virtual key.

VK_UNDERSCORE

public static final int VK_UNDERSCORE
The virtual key VK_UNDERSCORE.

Since: 1.2

VK_UNDO

public static final int VK_UNDO
The virtual key VK_UNDO.

Since: 1.2

VK_UP

public static final int VK_UP
The virtual key for the non-numpad VK_UP.

See Also: VK_KP_UP

VK_V

public static final int VK_V
The virtual key VK_V.

VK_W

public static final int VK_W
The virtual key VK_W.

VK_WINDOWS

public static final int VK_WINDOWS
The 'Windows' key VK_WINDOWS

Since: 1.5

VK_X

public static final int VK_X
The virtual key VK_X.

VK_Y

public static final int VK_Y
The virtual key VK_Y.

VK_Z

public static final int VK_Z
The virtual key VK_Z.

Constructor Detail

KeyEvent

public KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar, int keyLocation)
Initializes a new instance of KeyEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the component that generated this event id the event id when the timestamp when the even occurred modifiers the modifier keys during the event, in old or new style keyCode the integer constant for the virtual key type keyChar the Unicode value of the key keyLocation the location of the key

Throws: IllegalArgumentException if source is null, if keyLocation is invalid, or if (id == KEY_TYPED && (keyCode != VK_UNDEFINED || keyChar == CHAR_UNDEFINED))

KeyEvent

public KeyEvent(Component source, int id, long when, int modifiers, int keyCode, char keyChar)
Initializes a new instance of KeyEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the component that generated this event id the event id when the timestamp when the even occurred modifiers the modifier keys during the event, in old or new style keyCode the integer constant for the virtual key type keyChar the Unicode value of the key

Throws: IllegalArgumentException if source is null, or if (id == KEY_TYPED && (keyCode != VK_UNDEFINED || keyChar == CHAR_UNDEFINED))

KeyEvent

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

Deprecated:

Initializes a new instance of KeyEvent with the specified information. Note that an invalid id leads to unspecified results.

Parameters: source the component that generated this event id the event id when the timestamp when the even occurred modifiers the modifier keys during the event, in old or new style keyCode the integer constant for the virtual key type

Throws: IllegalArgumentException if source is null, or if id == KEY_TYPED but keyCode != VK_UNDEFINED

Method Detail

getKeyChar

public char getKeyChar()
Returns the Unicode value for the event key. This will be CHAR_UNDEFINED if there is no Unicode equivalent for this key, usually when this is a KEY_PRESSED or KEY_RELEASED event.

Returns: the Unicode character for this event

getKeyCode

public int getKeyCode()
Returns the key code for the event key. This will be one of the VK_* constants defined in this class. If the event type is KEY_TYPED, the result will be VK_UNDEFINED.

Returns: the key code for this event

getKeyLocation

public int getKeyLocation()
Returns the keyboard location of the key that generated this event. This provides a way to distinguish between keys like left and right shift which share a common key code. The result will be one of {@link #KEY_LOCATION_UNKNOWN}, {@link #KEY_LOCATION_STANDARD}, {@link #KEY_LOCATION_LEFT}, {@link #KEY_LOCATION_RIGHT}, or {@link #KEY_LOCATION_NUMPAD}.

Returns: the key location

Since: 1.4

getKeyModifiersText

public static String getKeyModifiersText(int modifiers)
Returns a string describing the modifiers, such as "Shift" or "Ctrl+Button1". XXX Sun claims this can be localized via the awt.properties file - how do we implement that?

Parameters: modifiers the old-style modifiers to convert to text

Returns: a string representation of the modifiers in this bitmask

getKeyText

public static String getKeyText(int keyCode)
Returns the text name of key code, such as "HOME", "F1", or "A". XXX Sun claims this can be localized via the awt.properties file - how do we implement that?

Returns: the text name of the key code

isActionKey

public boolean isActionKey()
Tests whether or not this key is an action key. An action key typically does not fire a KEY_TYPED event, and is not a modifier.

Returns: true if this is an action key

paramString

public String paramString()
Returns a string identifying the event. This is formatted as the field name of the id type, followed by the keyCode, then the keyChar, modifiers (if any), extModifiers (if any), and keyLocation.

Returns: a string identifying the event

setKeyChar

public void setKeyChar(char keyChar)
Sets the Unicode character for this event to the specified value.

Parameters: keyChar the new Unicode character for this event

setKeyCode

public void setKeyCode(int keyCode)
Sets the key code for this event. This must be one of the VK_* constants defined in this class.

Parameters: keyCode the new key code for this event

setModifiers

public void setModifiers(int modifiers)

Deprecated:

Sets the modifier keys to the specified value. This should be a union of the bit mask constants from InputEvent. The use of this method is not recommended, particularly for KEY_TYPED events, which do not check if the modifiers were changed.

Parameters: modifiers the new modifier value, in either old or new style

See Also: