Class KeyEvent

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.

Field Value:

'\uffff'

public static final int KEY_FIRST

This is the first id in the range of event ids used by this class.

Field Value:

400

public static final int KEY_LAST

This is the last id in the range of event ids used by this class.

Field Value:

402

public static final int KEY_LOCATION_LEFT

Indicates the key is on the left side of the keyboard, such as the left shift.

Field Value:

2

Since:

1.4

public static final int KEY_LOCATION_NUMPAD

Indicates the key is on the numeric pad, such as the numpad 0.

Field Value:

4

Since:

1.4

public static final int KEY_LOCATION_RIGHT

Indicates the key is on the right side of the keyboard, such as the right shift.

Field Value:

3

Since:

1.4

public static final int KEY_LOCATION_STANDARD

Indicates a standard key location, with no left/right variants and not on the numeric pad.

Field Value:

1

Since:

1.4

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.

Field Value:

0

Since:

1.4

public static final int KEY_PRESSED

This event id indicates a key was pressed.

Field Value:

401

public static final int KEY_RELEASED

This event it indicates a key was released.

Field Value:

402

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.

Field Value:

400

public static final int VK_0

The virtual key VK_0.

Field Value:

48

public static final int VK_1

The virtual key VK_1.

Field Value:

49

public static final int VK_2

The virtual key VK_2.

Field Value:

50

public static final int VK_3

The virtual key VK_3.

Field Value:

51

public static final int VK_4

The virtual key VK_4.

Field Value:

52

public static final int VK_5

The virtual key VK_5.

Field Value:

53

public static final int VK_6

The virtual key VK_6.

Field Value:

54

public static final int VK_7

The virtual key VK_7.

Field Value:

55

public static final int VK_8

The virtual key VK_8.

Field Value:

56

public static final int VK_9

The virtual key VK_9.

Field Value:

57

public static final int VK_A

The virtual key VK_A.

Field Value:

65

public static final int VK_ACCEPT

The virtual key VK_ACCEPT.

Field Value:

30

public static final int VK_ADD

The virtual key VK_ADD.

Field Value:

107

public static final int VK_AGAIN

The virtual key VK_AGAIN.

Field Value:

65481

Since:

1.2

public static final int VK_ALL_CANDIDATES

The virtual key VK_ALL_CANDIDATES.

Field Value:

256

Since:

1.2

public static final int VK_ALPHANUMERIC

The virtual key VK_ALPHANUMERIC.

Field Value:

240

Since:

1.2

public static final int VK_ALT

The virtual key VK_ALT.

Field Value:

18

public static final int VK_ALT_GRAPH

The virtual key VK_ALT_GRAPH.

Field Value:

65406

Since:

1.2

public static final int VK_AMPERSAND

The virtual key VK_AMPERSAND.

Field Value:

150

Since:

1.2

public static final int VK_ASTERISK

The virtual key VK_ASTERISK.

Field Value:

151

Since:

1.2

public static final int VK_AT

The virtual key VK_AT.

Field Value:

512

Since:

1.2

public static final int VK_B

The virtual key VK_B.

Field Value:

66

public static final int VK_BACK_QUOTE

The virtual key VK_BACK_QUOTE.

Field Value:

192

public static final int VK_BACK_SLASH

The virtual key VK_BACK_SLASH.

Field Value:

92

public static final int VK_BACK_SPACE

The virtual key Backspace, which will always map to '\b'.

Field Value:

8

public static final int VK_BEGIN

The 'begin' key VK_BEGIN

Field Value:

65368

Since:

1.5

public static final int VK_BRACELEFT

The virtual key VK_BRACELEFT.

Field Value:

161

Since:

1.2

public static final int VK_BRACERIGHT

The virtual key VK_BRACERIGHT.

Field Value:

162

Since:

1.2

public static final int VK_C

The virtual key VK_C.

Field Value:

67

public static final int VK_CANCEL

The virtual key Cancel.

Field Value:

3

public static final int VK_CAPS_LOCK

The virtual key VK_CAPS_LOCK.

Field Value:

20

public static final int VK_CIRCUMFLEX

The virtual key VK_CIRCUMFLEX.

Field Value:

514

Since:

1.2

public static final int VK_CLEAR

The virtual key VK_CLEAR.

Field Value:

12

public static final int VK_CLOSE_BRACKET

The virtual key VK_CLOSE_BRACKET.

Field Value:

93

public static final int VK_CODE_INPUT

The virtual key VK_CODE_INPUT.

Field Value:

258

Since:

1.2

public static final int VK_COLON

The virtual key VK_COLON.

Field Value:

513

Since:

1.2

public static final int VK_COMMA

The virtual key VK_COMMA.

Field Value:

44

public static final int VK_COMPOSE

The virtual key VK_COMPOSE.

Field Value:

65312

Since:

1.2

public static final int VK_CONTEXT_MENU

The context-menu key VK_CONTEXT_MENU

Field Value:

525

Since:

1.5

public static final int VK_CONTROL

The virtual key VK_CONTROL.

Field Value:

17

public static final int VK_CONVERT

The virtual key VK_CONVERT.

Field Value:

28

public static final int VK_COPY

The virtual key VK_COPY.

Field Value:

65485

Since:

1.2

public static final int VK_CUT

The virtual key VK_CUT.

Field Value:

65489

Since:

1.2

public static final int VK_D

The virtual key VK_D.

Field Value:

68

public static final int VK_DEAD_ABOVEDOT

The virtual key VK_DEAD_ABOVEDOT.

Field Value:

134

Since:

1.2

public static final int VK_DEAD_ABOVERING

The virtual key VK_DEAD_ABOVERING.

Field Value:

136

Since:

1.2

public static final int VK_DEAD_ACUTE

The virtual key VK_DEAD_ACUTE.

Field Value:

129

Since:

1.2

public static final int VK_DEAD_BREVE

The virtual key VK_DEAD_BREVE.

Field Value:

133

Since:

1.2

public static final int VK_DEAD_CARON

The virtual key VK_DEAD_CARON.

Field Value:

138

Since:

1.2

public static final int VK_DEAD_CEDILLA

The virtual key VK_DEAD_CEDILLA.

Field Value:

139

Since:

1.2

public static final int VK_DEAD_CIRCUMFLEX

The virtual key VK_DEAD_CIRCUMFLEX.

Field Value:

130

Since:

1.2

public static final int VK_DEAD_DIAERESIS

The virtual key VK_DEAD_DIAERESIS.

Field Value:

135

Since:

1.2

public static final int VK_DEAD_DOUBLEACUTE

The virtual key VK_DEAD_DOUBLEACUTE.

Field Value:

137

Since:

1.2

public static final int VK_DEAD_GRAVE

The virtual key VK_DEAD_GRAVE.

Field Value:

128

Since:

1.2

public static final int VK_DEAD_IOTA

The virtual key VK_DEAD_IOTA.

Field Value:

141

Since:

1.2

public static final int VK_DEAD_MACRON

The virtual key VK_DEAD_MACRON.

Field Value:

132

Since:

1.2

public static final int VK_DEAD_OGONEK

The virtual key VK_DEAD_OGONEK.

Field Value:

140

Since:

1.2

public static final int VK_DEAD_SEMIVOICED_SOUND

The virtual key VK_DEAD_SEMIVOICED_SOUND.

Field Value:

143

Since:

1.2

public static final int VK_DEAD_TILDE

The virtual key VK_DEAD_TILDE.

Field Value:

131

Since:

1.2

public static final int VK_DEAD_VOICED_SOUND

The virtual key VK_DEAD_VOICED_SOUND.

Field Value:

142

Since:

1.2

public static final int VK_DECIMAL

The virtual key VK_DECIMAL.

Field Value:

110

public static final int VK_DELETE

The virtual key VK_DELETE.

Field Value:

127

public static final int VK_DIVIDE

The virtual key VK_DIVIDE.

Field Value:

111

public static final int VK_DOLLAR

The virtual key VK_DOLLAR.

Field Value:

515

Since:

1.2

public static final int VK_DOWN

The virtual key for the non-numpad VK_DOWN.

Field Value:

40

See Also:

VK_KP_DOWN

public static final int VK_E

The virtual key VK_E.

Field Value:

69

public static final int VK_END

The virtual key VK_END.

Field Value:

35

public static final int VK_ENTER

The virtual key Enter, which will always map to '\n'.

Field Value:

10

public static final int VK_EQUALS

The virtual key VK_EQUALS.

Field Value:

61

public static final int VK_ESCAPE

The virtual key VK_ESCAPE.

Field Value:

27

public static final int VK_EURO_SIGN

The virtual key VK_EURO_SIGN.

Field Value:

516

Since:

1.2

public static final int VK_EXCLAMATION_MARK

The virtual key VK_EXCLAMATION_MARK.

Field Value:

517

Since:

1.2

public static final int VK_F

The virtual key VK_F.

Field Value:

70

public static final int VK_F1

The virtual key VK_F1.

Field Value:

112

public static final int VK_F10

The virtual key VK_F10.

Field Value:

121

public static final int VK_F11

The virtual key VK_F11.

Field Value:

122

public static final int VK_F12

The virtual key VK_F12.

Field Value:

123

public static final int VK_F13

The virtual key VK_F13.

Field Value:

61440

Since:

1.2

public static final int VK_F14

The virtual key VK_F14.

Field Value:

61441

Since:

1.2

public static final int VK_F15

The virtual key VK_F15.

Field Value:

61442

Since:

1.2

public static final int VK_F16

The virtual key VK_F16.

Field Value:

61443

Since:

1.2

public static final int VK_F17

The virtual key VK_F17.

Field Value:

61444

Since:

1.2

public static final int VK_F18

The virtual key VK_F18.

Field Value:

61445

Since:

1.2

public static final int VK_F19

The virtual key VK_F19.

Field Value:

61446

Since:

1.2

public static final int VK_F2

The virtual key VK_F2.

Field Value:

113

public static final int VK_F20

The virtual key VK_F20.

Field Value:

61447

Since:

1.2

public static final int VK_F21

The virtual key VK_F21.

Field Value:

61448

Since:

1.2

public static final int VK_F22

The virtual key VK_F22.

Field Value:

61449

Since:

1.2

public static final int VK_F23

The virtual key VK_F23.

Field Value:

61450

Since:

1.2

public static final int VK_F24

The virtual key VK_F24.

Field Value:

61451

Since:

1.2

public static final int VK_F3

The virtual key VK_F3.

Field Value:

114

public static final int VK_F4

The virtual key VK_F4.

Field Value:

115

public static final int VK_F5

The virtual key VK_F5.

Field Value:

116

public static final int VK_F6

The virtual key VK_F6.

Field Value:

117

public static final int VK_F7

The virtual key VK_F7.

Field Value:

118

public static final int VK_F8

The virtual key VK_F8.

Field Value:

119

public static final int VK_F9

The virtual key VK_F9.

Field Value:

120

public static final int VK_FINAL

The virtual key VK_FINAL.

Field Value:

24

public static final int VK_FIND

The virtual key VK_FIND.

Field Value:

65488

Since:

1.2

public static final int VK_FULL_WIDTH

The virtual key VK_FULL_WIDTH.

Field Value:

243

Since:

1.2

public static final int VK_G

The virtual key VK_G.

Field Value:

71

public static final int VK_GREATER

The virtual key VK_GREATER.

Field Value:

160

Since:

1.2

public static final int VK_H

The virtual key VK_H.

Field Value:

72

public static final int VK_HALF_WIDTH

The virtual key VK_HALF_WIDTH.

Field Value:

244

Since:

1.2

public static final int VK_HELP

The virtual key VK_HELP.

Field Value:

156

public static final int VK_HIRAGANA

The virtual key VK_HIRAGANA.

Field Value:

242

Since:

1.2

public static final int VK_HOME

The virtual key VK_HOME.

Field Value:

36

public static final int VK_I

The virtual key VK_I.

Field Value:

73

public static final int VK_INPUT_METHOD_ON_OFF

The virtual key VK_INPUT_METHOD_ON_OFF.

Field Value:

263

Since:

1.3

public static final int VK_INSERT

The virtual key VK_INSERT.

Field Value:

155

public static final int VK_INVERTED_EXCLAMATION_MARK

The virtual key VK_INVERTED_EXCLAMATION_MARK.

Field Value:

518

Since:

1.2

public static final int VK_J

The virtual key VK_J.

Field Value:

74

public static final int VK_JAPANESE_HIRAGANA

The virtual key VK_JAPANESE_HIRAGANA.

Field Value:

260

Since:

1.2

public static final int VK_JAPANESE_KATAKANA

The virtual key VK_JAPANESE_KATAKANA.

Field Value:

259

Since:

1.2

public static final int VK_JAPANESE_ROMAN

The virtual key VK_JAPANESE_ROMAN.

Field Value:

261

Since:

1.2

public static final int VK_K

The virtual key VK_K.

Field Value:

75

public static final int VK_KANA

The virtual key VK_KANA.

Field Value:

21

public static final int VK_KANA_LOCK

The virtual key VK_KANA_LOCK.

Field Value:

262

Since:

1.3

public static final int VK_KANJI

The virtual key VK_KANJI.

Field Value:

25

public static final int VK_KATAKANA

The virtual key VK_KATAKANA.

Field Value:

241

Since:

1.2

public static final int VK_KP_DOWN

The virtual key for the numpad VK_KP_DOWN.

Field Value:

225

Since:

1.2

See Also:

VK_DOWN

public static final int VK_KP_LEFT

The virtual key for the numpad VK_KP_LEFT.

Field Value:

226

Since:

1.2

See Also:

VK_LEFT

public static final int VK_KP_RIGHT

The virtual key for the numpad VK_KP_RIGHT.

Field Value:

227

Since:

1.2

See Also:

VK_RIGHT

public static final int VK_KP_UP

The virtual key for the numpad VK_KP_UP.

Field Value:

224

Since:

1.2

See Also:

VK_UP

public static final int VK_L

The virtual key VK_L.

Field Value:

76

public static final int VK_LEFT

The virtual key for the non-numpad VK_LEFT.

Field Value:

37

See Also:

VK_KP_LEFT

public static final int VK_LEFT_PARENTHESIS

The virtual key VK_LEFT_PARENTHESIS.

Field Value:

519

Since:

1.2

public static final int VK_LESS

The virtual key VK_LESS.

Field Value:

153

Since:

1.2

public static final int VK_M

The virtual key VK_M.

Field Value:

77

public static final int VK_META

The virtual key VK_META.

Field Value:

157

public static final int VK_MINUS

The virtual key VK_MINUS.

Field Value:

45

Since:

1.2

public static final int VK_MODECHANGE

The virtual key VK_MODECHANGE.

Field Value:

31

public static final int VK_MULTIPLY

The virtual key VK_MULTIPLY.

Field Value:

106

public static final int VK_N

The virtual key VK_N.

Field Value:

78

public static final int VK_NONCONVERT

The virtual key VK_NONCONVERT.

Field Value:

29

public static final int VK_NUMBER_SIGN

The virtual key VK_NUMBER_SIGN.

Field Value:

520

Since:

1.2

public static final int VK_NUMPAD0

The virtual key VK_NUMPAD0.

Field Value:

96

public static final int VK_NUMPAD1

The virtual key VK_NUMPAD1.

Field Value:

97

public static final int VK_NUMPAD2

The virtual key VK_NUMPAD2.

Field Value:

98

public static final int VK_NUMPAD3

The virtual key VK_NUMPAD3.

Field Value:

99

public static final int VK_NUMPAD4

The virtual key VK_NUMPAD4.

Field Value:

100

public static final int VK_NUMPAD5

The virtual key VK_NUMPAD5.

Field Value:

101

public static final int VK_NUMPAD6

The virtual key VK_NUMPAD6.

Field Value:

102

public static final int VK_NUMPAD7

The virtual key VK_NUMPAD7.

Field Value:

103

public static final int VK_NUMPAD8

The virtual key VK_NUMPAD8.

Field Value:

104

public static final int VK_NUMPAD9

The virtual key VK_NUMPAD9.

Field Value:

105

public static final int VK_NUM_LOCK

The virtual key VK_NUM_LOCK.

Field Value:

144

public static final int VK_O

The virtual key VK_O.

Field Value:

79

public static final int VK_OPEN_BRACKET

The virtual key VK_OPEN_BRACKET.

Field Value:

91

public static final int VK_P

The virtual key VK_P.

Field Value:

80

public static final int VK_PAGE_DOWN

The virtual key VK_PAGE_DOWN.

Field Value:

34

public static final int VK_PAGE_UP

The virtual key VK_PAGE_UP.

Field Value:

33

public static final int VK_PASTE

The virtual key VK_PASTE.

Field Value:

65487

Since:

1.2

public static final int VK_PAUSE

The virtual key VK_PAUSE.

Field Value:

19

public static final int VK_PERIOD

The virtual key VK_PERIOD.

Field Value:

46

public static final int VK_PLUS

The virtual key VK_PLUS.

Field Value:

521

Since:

1.2

public static final int VK_PREVIOUS_CANDIDATE

The virtual key VK_PREVIOUS_CANDIDATE.

Field Value:

257

Since:

1.2

public static final int VK_PRINTSCREEN

The virtual key VK_PRINTSCREEN.

Field Value:

154

public static final int VK_PROPS

The virtual key VK_PROPS.

Field Value:

65482

Since:

1.2

public static final int VK_Q

The virtual key VK_Q.

Field Value:

81

public static final int VK_QUOTE

The virtual key VK_QUOTE.

Field Value:

222

public static final int VK_QUOTEDBL

The virtual key VK_QUOTEDBL.

Field Value:

152

Since:

1.2

public static final int VK_R

The virtual key VK_R.

Field Value:

82

public static final int VK_RIGHT

The virtual key for the non-numpad VK_RIGHT.

Field Value:

39

See Also:

VK_KP_RIGHT

public static final int VK_RIGHT_PARENTHESIS

The virtual key VK_RIGHT_PARENTHESIS.

Field Value:

522

Since:

1.2

public static final int VK_ROMAN_CHARACTERS

The virtual key VK_ROMAN_CHARACTERS.

Field Value:

245

Since:

1.2

public static final int VK_S

The virtual key VK_S.

Field Value:

83

public static final int VK_SCROLL_LOCK

The virtual key VK_SCROLL_LOCK.

Field Value:

145

public static final int VK_SEMICOLON

The virtual key VK_SEMICOLON.

Field Value:

59

public static final int VK_SEPARATER

Deprecated. use VK_SEPARATOR

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

Field Value:

108

public static final int VK_SEPARATOR

The virtual key VK_SEPARATOR.

Field Value:

108

Since:

1.4

public static final int VK_SHIFT

The virtual key VK_SHIFT.

Field Value:

16

public static final int VK_SLASH

The virtual key VK_SLASH.

Field Value:

47

public static final int VK_SPACE

The virtual key VK_SPACE.

Field Value:

32

public static final int VK_STOP

The virtual key VK_STOP.

Field Value:

65480

Since:

1.2

public static final int VK_SUBTRACT

The virtual key VK_SUBTRACT.

Field Value:

109

public static final int VK_T

The virtual key VK_T.

Field Value:

84

public static final int VK_TAB

The virtual key Tab, which will always map to '\t'.

Field Value:

9

public static final int VK_U

The virtual key VK_U.

Field Value:

85

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.

Field Value:

0

public static final int VK_UNDERSCORE

The virtual key VK_UNDERSCORE.

Field Value:

523

Since:

1.2

public static final int VK_UNDO

The virtual key VK_UNDO.

Field Value:

65483

Since:

1.2

public static final int VK_UP

The virtual key for the non-numpad VK_UP.

Field Value:

38

See Also:

VK_KP_UP

public static final int VK_V

The virtual key VK_V.

Field Value:

86

public static final int VK_W

The virtual key VK_W.

Field Value:

87

public static final int VK_WINDOWS

The 'Windows' key VK_WINDOWS

Field Value:

524

Since:

1.5

public static final int VK_X

The virtual key VK_X.

Field Value:

88

public static final int VK_Y

The virtual key VK_Y.

Field Value:

89

public static final int VK_Z

The virtual key VK_Z.

Field Value:

90

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

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

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

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

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

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 KEY_LOCATION_UNKNOWN, KEY_LOCATION_STANDARD, KEY_LOCATION_LEFT, KEY_LOCATION_RIGHT, or KEY_LOCATION_NUMPAD.

Returns:

the key location

Since:

1.4

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

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

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

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.

Overrides:

paramString in interface ComponentEvent

Returns:

a string identifying the event

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

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

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:

InputEvent