public class NativeKeyEvent extends NativeInputEvent
This low-level event is generated by the native system when a key is pressed
or released independent of Java component focus. The event is passed to every
NativeKeyListener object which has been registered to receive
global key events using the
GlobalScreen.addNativeKeyListener(NativeKeyListener) method. Each
NativeKeyListener object will receive a
NativeKeyEvent when the event occurs.
All NativeKeyEvent objects are dependent on the native platform
and keyboard layout. NATIVE_KEY_PRESSED and
NATIVE_KEY_RELEASED are generated for every key code received by
the native system. The key being pressed or released is indicated by the
getKeyCode method, which returns a virtual key code. Native virtual
keyCode constants maybe equivalent to their KeyEvent
counterparts, however this this not guaranteed.
NATIVE_KEY_TYPED events are produced for
NATIVE_KEY_PRESSED events that produce valid Unicode character
for the native keyboard layout. The getKeyChar method always returns a valid
Unicode character or CHAR_UNDEFINED. For
NATIVE_KEY_PRESSED and NATIVE_KEY_RELEASED events,
the getKeyCode method returns the event's keyCode. For
NATIVE_KEY_TYPED events, the getKeyCode method always returns
VK_UNDEFINED.
Virtual key codes only represent the physical key has been pressed and should
not be mistaken with the character mapped to that key by the operating
system. To determine the Unicode representation of the
NativeKeyEvent, please use the getKeyChar() method
for the NATIVE_KEY_TYPED event associated with that virtual key
codes.
GlobalScreen,
NativeKeyListener,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
static char |
CHAR_UNDEFINED
This is used to indicate that the keyCode is unknown.
|
static int |
KEY_LOCATION_LEFT |
static int |
KEY_LOCATION_NUMPAD |
static int |
KEY_LOCATION_RIGHT |
static int |
KEY_LOCATION_STANDARD |
static int |
KEY_LOCATION_UNKNOWN |
static int |
NATIVE_KEY_FIRST
The first number in the range of ID's used for native key events.
|
static int |
NATIVE_KEY_LAST
The last number in the range of ID's used for native key events.
|
static int |
NATIVE_KEY_PRESSED
The "native key pressed" event ID.
|
static int |
NATIVE_KEY_RELEASED
The "native key released" event ID.
|
static int |
NATIVE_KEY_TYPED
The "native key typed" event ID.
|
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 |
static int |
VK_ADD |
static int |
VK_AGAIN |
static int |
VK_ALL_CANDIDATES |
static int |
VK_ALPHANUMERIC |
static int |
VK_ALT |
static int |
VK_ALT_GRAPH |
static int |
VK_AMPERSAND |
static int |
VK_ASTERISK |
static int |
VK_AT |
static int |
VK_B |
static int |
VK_BACK_QUOTE |
static int |
VK_BACK_SLASH |
static int |
VK_BACK_SPACE |
static int |
VK_BEGIN |
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 |
static int |
VK_CLEAR |
static int |
VK_CLOSE_BRACKET |
static int |
VK_CODE_INPUT |
static int |
VK_COLON |
static int |
VK_COMMA |
static int |
VK_COMPOSE |
static int |
VK_CONTEXT_MENU
Constant for the Microsoft Windows Context Menu key.
|
static int |
VK_CONTROL |
static int |
VK_CONVERT |
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 |
static int |
VK_DOWN |
static int |
VK_E |
static int |
VK_END |
static int |
VK_ENTER |
static int |
VK_EQUALS |
static int |
VK_ESCAPE |
static int |
VK_EURO_SIGN |
static int |
VK_EXCLAMATION_MARK |
static int |
VK_F |
static int |
VK_F1
Constants for the F1 through F24 function keys.
|
static int |
VK_F10 |
static int |
VK_F11 |
static int |
VK_F12 |
static int |
VK_F13 |
static int |
VK_F14 |
static int |
VK_F15 |
static int |
VK_F16 |
static int |
VK_F17 |
static int |
VK_F18 |
static int |
VK_F19 |
static int |
VK_F2 |
static int |
VK_F20 |
static int |
VK_F21 |
static int |
VK_F22 |
static int |
VK_F23 |
static int |
VK_F24 |
static int |
VK_F3 |
static int |
VK_F4 |
static int |
VK_F5 |
static int |
VK_F6 |
static int |
VK_F7 |
static int |
VK_F8 |
static int |
VK_F9 |
static int |
VK_FINAL |
static int |
VK_FIND |
static int |
VK_FULL_WIDTH |
static int |
VK_G |
static int |
VK_GREATER |
static int |
VK_H |
static int |
VK_HALF_WIDTH |
static int |
VK_HELP |
static int |
VK_HIRAGANA |
static int |
VK_HOME |
static int |
VK_I |
static int |
VK_INPUT_METHOD_ON_OFF |
static int |
VK_INSERT |
static int |
VK_INVERTED_EXCLAMATION_MARK |
static int |
VK_J |
static int |
VK_JAPANESE_HIRAGANA |
static int |
VK_JAPANESE_KATAKANA |
static int |
VK_JAPANESE_ROMAN |
static int |
VK_K |
static int |
VK_KANA |
static int |
VK_KANA_LOCK |
static int |
VK_KANJI |
static int |
VK_KATAKANA |
static int |
VK_KP_DOWN |
static int |
VK_KP_LEFT |
static int |
VK_KP_RIGHT |
static int |
VK_KP_UP |
static int |
VK_L |
static int |
VK_LEFT |
static int |
VK_LEFT_PARENTHESIS |
static int |
VK_LESS |
static int |
VK_M |
static int |
VK_META
Constant for the Meta or Command key.
|
static int |
VK_MINUS |
static int |
VK_MODECHANGE |
static int |
VK_MULTIPLY |
static int |
VK_N |
static int |
VK_NONCONVERT |
static int |
VK_NUM_LOCK |
static int |
VK_NUMBER_SIGN |
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 |
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 |
static int |
VK_PLUS |
static int |
VK_PREVIOUS_CANDIDATE |
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 |
static int |
VK_RIGHT_PARENTHESIS |
static int |
VK_ROMAN_CHARACTERS |
static int |
VK_S |
static int |
VK_SCROLL_LOCK |
static int |
VK_SEMICOLON |
static int |
VK_SHIFT |
static int |
VK_SLASH |
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 |
static int |
VK_UNDO |
static int |
VK_UP |
static int |
VK_V |
static int |
VK_W |
static int |
VK_WINDOWS
Constant for the Microsoft Windows key.
|
static int |
VK_X |
static int |
VK_Y |
static int |
VK_Z |
ALT_MASK, BUTTON1_MASK, BUTTON2_MASK, BUTTON3_MASK, BUTTON4_MASK, BUTTON5_MASK, CTRL_MASK, META_MASK, SHIFT_MASKsource| Constructor and Description |
|---|
NativeKeyEvent(int id,
long when,
int modifiers,
int rawCode,
int keyCode,
char keyChar)
Instantiates a new native key event.
|
NativeKeyEvent(int id,
long when,
int modifiers,
int rawCode,
int keyCode,
char keyChar,
int keyLocation)
Instantiates a new native key event.
|
| Modifier and Type | Method and Description |
|---|---|
char |
getKeyChar()
Returns the native Unicode character associated with this event.
|
int |
getKeyCode()
Returns the keyCode associated with this event.
|
int |
getKeyLocation()
Returns the location of the virtual key for this event.
|
static String |
getKeyText(int keyCode)
Returns a String describing the keyCode, such as "HOME", "F1" or "A".
|
int |
getRawCode()
Returns the native code associated with the native key in this event.
|
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 in this event.
|
void |
setKeyCode(int keyCode)
Set the keyCode value in this event.
|
void |
setRawCode(int rawCode)
Set the rawCode value in this event.
|
getID, getModifiers, getModifiersText, getWhen, setModifiersgetSource, toStringpublic static final int NATIVE_KEY_FIRST
public static final int NATIVE_KEY_LAST
public static final int NATIVE_KEY_TYPED
public static final int NATIVE_KEY_PRESSED
public static final int NATIVE_KEY_RELEASED
public static final int KEY_LOCATION_UNKNOWN
public static final int KEY_LOCATION_STANDARD
public static final int KEY_LOCATION_LEFT
public static final int KEY_LOCATION_RIGHT
public static final int KEY_LOCATION_NUMPAD
public static final int VK_ENTER
public static final int VK_BACK_SPACE
public static final int VK_TAB
public static final int VK_CANCEL
public static final int VK_SHIFT
public static final int VK_CONTROL
public static final int VK_ALT
public static final int VK_META
public static final int VK_WINDOWS
public static final int VK_CONTEXT_MENU
public static final int VK_PAUSE
public static final int VK_CAPS_LOCK
public static final int VK_ESCAPE
public static final int VK_SPACE
public static final int VK_UP
public static final int VK_DOWN
public static final int VK_LEFT
public static final int VK_RIGHT
public static final int VK_COMMA
public static final int VK_MINUS
public static final int VK_PERIOD
public static final int VK_SLASH
public static final int VK_0
public static final int VK_1
public static final int VK_2
public static final int VK_3
public static final int VK_4
public static final int VK_5
public static final int VK_6
public static final int VK_7
public static final int VK_8
public static final int VK_9
public static final int VK_EQUALS
public static final int VK_SEMICOLON
public static final int VK_A
public static final int VK_B
public static final int VK_C
public static final int VK_D
public static final int VK_E
public static final int VK_F
public static final int VK_G
public static final int VK_H
public static final int VK_I
public static final int VK_J
public static final int VK_K
public static final int VK_L
public static final int VK_M
public static final int VK_N
public static final int VK_O
public static final int VK_P
public static final int VK_Q
public static final int VK_R
public static final int VK_S
public static final int VK_T
public static final int VK_U
public static final int VK_V
public static final int VK_W
public static final int VK_X
public static final int VK_Y
public static final int VK_Z
public static final int VK_OPEN_BRACKET
public static final int VK_BACK_SLASH
public static final int VK_CLOSE_BRACKET
public static final int VK_NUMPAD0
public static final int VK_NUMPAD1
public static final int VK_NUMPAD2
public static final int VK_NUMPAD3
public static final int VK_NUMPAD4
public static final int VK_NUMPAD5
public static final int VK_NUMPAD6
public static final int VK_NUMPAD7
public static final int VK_NUMPAD8
public static final int VK_NUMPAD9
public static final int VK_KP_UP
public static final int VK_KP_DOWN
public static final int VK_KP_LEFT
public static final int VK_KP_RIGHT
public static final int VK_MULTIPLY
public static final int VK_ADD
public static final int VK_SUBTRACT
public static final int VK_DECIMAL
public static final int VK_DIVIDE
public static final int VK_DELETE
public static final int VK_CLEAR
public static final int VK_NUM_LOCK
public static final int VK_SCROLL_LOCK
public static final int VK_F1
public static final int VK_F2
public static final int VK_F3
public static final int VK_F4
public static final int VK_F5
public static final int VK_F6
public static final int VK_F7
public static final int VK_F8
public static final int VK_F9
public static final int VK_F10
public static final int VK_F11
public static final int VK_F12
public static final int VK_F13
public static final int VK_F14
public static final int VK_F15
public static final int VK_F16
public static final int VK_F17
public static final int VK_F18
public static final int VK_F19
public static final int VK_F20
public static final int VK_F21
public static final int VK_F22
public static final int VK_F23
public static final int VK_F24
public static final int VK_PRINTSCREEN
public static final int VK_INSERT
public static final int VK_HELP
public static final int VK_PAGE_UP
public static final int VK_PAGE_DOWN
public static final int VK_HOME
public static final int VK_END
public static final int VK_QUOTE
public static final int VK_BACK_QUOTE
public static final int VK_DEAD_GRAVE
public static final int VK_DEAD_ACUTE
public static final int VK_DEAD_CIRCUMFLEX
public static final int VK_DEAD_TILDE
public static final int VK_DEAD_MACRON
public static final int VK_DEAD_BREVE
public static final int VK_DEAD_ABOVEDOT
public static final int VK_DEAD_DIAERESIS
public static final int VK_DEAD_ABOVERING
public static final int VK_DEAD_DOUBLEACUTE
public static final int VK_DEAD_CARON
public static final int VK_DEAD_CEDILLA
public static final int VK_DEAD_OGONEK
public static final int VK_DEAD_IOTA
public static final int VK_DEAD_VOICED_SOUND
public static final int VK_DEAD_SEMIVOICED_SOUND
public static final int VK_AMPERSAND
public static final int VK_ASTERISK
public static final int VK_QUOTEDBL
public static final int VK_LESS
public static final int VK_GREATER
public static final int VK_BRACELEFT
public static final int VK_BRACERIGHT
public static final int VK_AT
public static final int VK_COLON
public static final int VK_CIRCUMFLEX
public static final int VK_DOLLAR
public static final int VK_EURO_SIGN
public static final int VK_EXCLAMATION_MARK
public static final int VK_INVERTED_EXCLAMATION_MARK
public static final int VK_LEFT_PARENTHESIS
public static final int VK_NUMBER_SIGN
public static final int VK_PLUS
public static final int VK_RIGHT_PARENTHESIS
public static final int VK_UNDERSCORE
public static final int VK_FINAL
public static final int VK_CONVERT
public static final int VK_NONCONVERT
public static final int VK_ACCEPT
public static final int VK_MODECHANGE
public static final int VK_KANA
public static final int VK_KANJI
public static final int VK_ALPHANUMERIC
public static final int VK_KATAKANA
public static final int VK_HIRAGANA
public static final int VK_FULL_WIDTH
public static final int VK_HALF_WIDTH
public static final int VK_ROMAN_CHARACTERS
public static final int VK_ALL_CANDIDATES
public static final int VK_PREVIOUS_CANDIDATE
public static final int VK_CODE_INPUT
public static final int VK_JAPANESE_KATAKANA
public static final int VK_JAPANESE_HIRAGANA
public static final int VK_JAPANESE_ROMAN
public static final int VK_KANA_LOCK
public static final int VK_INPUT_METHOD_ON_OFF
public static final int VK_CUT
public static final int VK_COPY
public static final int VK_PASTE
public static final int VK_UNDO
public static final int VK_AGAIN
public static final int VK_FIND
public static final int VK_PROPS
public static final int VK_STOP
public static final int VK_COMPOSE
public static final int VK_ALT_GRAPH
public static final int VK_BEGIN
public static final char CHAR_UNDEFINED
public static final int VK_UNDEFINED
public NativeKeyEvent(int id,
long when,
int modifiers,
int rawCode,
int keyCode,
char keyChar,
int keyLocation)
Note that passing in an invalid ID results in unspecified behavior.
id - an integer that identifies the native event type.when - the timestamp for the native event.modifiers - the modifier mask for the native event.
NativeInputEvent _MASK modifiers should be used as they are
not compatible with AWT's InputEvent _DOWN_MASK or the older
_MASK modifiers.rawCode - the hardware code associated with the native key in this
event.keyCode - the virtual key code generated by this event, 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 - the location ID of the key generating this event.public NativeKeyEvent(int id,
long when,
int modifiers,
int rawCode,
int keyCode,
char keyChar)
Note that passing in an invalid ID results in unspecified behavior.
id - an integer that identifies the native event type.when - the timestamp for the native event.modifiers - the modifier mask for the native event.
NativeInputEvent _MASK modifiers should be used as they are
not compatible with AWT's InputEvent _DOWN_MASK or the older
_MASK modifiers.rawCode - the hardware code associated with the native key in this
event.keyCode - the virtual key code generated by this event, 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).public int getRawCode()
public void setRawCode(int rawCode)
getRawCode().rawCode - the native key code for this event.public int getKeyCode()
public void setKeyCode(int keyCode)
keyCode - the native virtual key code.public char getKeyChar()
CHAR_UNDEFINED
is returned.public void setKeyChar(char keyChar)
NATIVE_KEY_TYPED event for Shift + "a" returns the Unicode
value 'A'.keyChar - the keyboard character associated with this event.public int getKeyLocation()
public static String getKeyText(int keyCode)
keyCode - the native virtual key code generated by this eventpublic boolean isActionKey()
true if the key is an "action" key,
false otherwisepublic String paramString()
paramString in class NativeInputEventCopyright © 2006-2017 ${project.vendor}. All Rights Received.