- *-char-undefined
- *-key-first
- *-key-last
- *-key-location-left
- *-key-location-numpad
- *-key-location-right
- *-key-location-standard
- *-key-location-unknown
- *-key-pressed
- *-key-released
- *-key-typed
- *-vk-0
- *-vk-1
- *-vk-2
- *-vk-3
- *-vk-4
- *-vk-5
- *-vk-6
- *-vk-7
- *-vk-8
- *-vk-9
- *-vk-a
- *-vk-accept
- *-vk-add
- *-vk-again
- *-vk-all-candidates
- *-vk-alphanumeric
- *-vk-alt
- *-vk-alt-graph
- *-vk-ampersand
- *-vk-asterisk
- *-vk-at
- *-vk-b
- *-vk-back-quote
- *-vk-back-slash
- *-vk-back-space
- *-vk-begin
- *-vk-braceleft
- *-vk-braceright
- *-vk-c
- *-vk-cancel
- *-vk-caps-lock
- *-vk-circumflex
- *-vk-clear
- *-vk-close-bracket
- *-vk-code-input
- *-vk-colon
- *-vk-comma
- *-vk-compose
- *-vk-context-menu
- *-vk-control
- *-vk-convert
- *-vk-copy
- *-vk-cut
- *-vk-d
- *-vk-dead-abovedot
- *-vk-dead-abovering
- *-vk-dead-acute
- *-vk-dead-breve
- *-vk-dead-caron
- *-vk-dead-cedilla
- *-vk-dead-circumflex
- *-vk-dead-diaeresis
- *-vk-dead-doubleacute
- *-vk-dead-grave
- *-vk-dead-iota
- *-vk-dead-macron
- *-vk-dead-ogonek
- *-vk-dead-semivoiced-sound
- *-vk-dead-tilde
- *-vk-dead-voiced-sound
- *-vk-decimal
- *-vk-delete
- *-vk-divide
- *-vk-dollar
- *-vk-down
- *-vk-e
- *-vk-end
- *-vk-enter
- *-vk-equals
- *-vk-escape
- *-vk-euro-sign
- *-vk-exclamation-mark
- *-vk-f
- *-vk-f-1
- *-vk-f-10
- *-vk-f-11
- *-vk-f-12
- *-vk-f-13
- *-vk-f-14
- *-vk-f-15
- *-vk-f-16
- *-vk-f-17
- *-vk-f-18
- *-vk-f-19
- *-vk-f-2
- *-vk-f-20
- *-vk-f-21
- *-vk-f-22
- *-vk-f-23
- *-vk-f-24
- *-vk-f-3
- *-vk-f-4
- *-vk-f-5
- *-vk-f-6
- *-vk-f-7
- *-vk-f-8
- *-vk-f-9
- *-vk-final
- *-vk-find
- *-vk-full-width
- *-vk-g
- *-vk-greater
- *-vk-h
- *-vk-half-width
- *-vk-help
- *-vk-hiragana
- *-vk-home
- *-vk-i
- *-vk-input-method-on-off
- *-vk-insert
- *-vk-inverted-exclamation-mark
- *-vk-j
- *-vk-japanese-hiragana
- *-vk-japanese-katakana
- *-vk-japanese-roman
- *-vk-k
- *-vk-kana
- *-vk-kana-lock
- *-vk-kanji
- *-vk-katakana
- *-vk-kp-down
- *-vk-kp-left
- *-vk-kp-right
- *-vk-kp-up
- *-vk-l
- *-vk-left
- *-vk-left-parenthesis
- *-vk-less
- *-vk-m
- *-vk-meta
- *-vk-minus
- *-vk-modechange
- *-vk-multiply
- *-vk-n
- *-vk-nonconvert
- *-vk-num-lock
- *-vk-number-sign
- *-vk-numpad-0
- *-vk-numpad-1
- *-vk-numpad-2
- *-vk-numpad-3
- *-vk-numpad-4
- *-vk-numpad-5
- *-vk-numpad-6
- *-vk-numpad-7
- *-vk-numpad-8
- *-vk-numpad-9
- *-vk-o
- *-vk-open-bracket
- *-vk-p
- *-vk-page-down
- *-vk-page-up
- *-vk-paste
- *-vk-pause
- *-vk-period
- *-vk-plus
- *-vk-previous-candidate
- *-vk-printscreen
- *-vk-props
- *-vk-q
- *-vk-quote
- *-vk-quotedbl
- *-vk-r
- *-vk-right
- *-vk-right-parenthesis
- *-vk-roman-characters
- *-vk-s
- *-vk-scroll-lock
- *-vk-semicolon
- *-vk-separater
- *-vk-separator
- *-vk-shift
- *-vk-slash
- *-vk-space
- *-vk-stop
- *-vk-subtract
- *-vk-t
- *-vk-tab
- *-vk-u
- *-vk-undefined
- *-vk-underscore
- *-vk-undo
- *-vk-up
- *-vk-v
- *-vk-w
- *-vk-windows
- *-vk-x
- *-vk-y
- *-vk-z
- *get-extended-key-code-for-char
- *get-key-modifiers-text
- *get-key-text
- ->key-event
- action-key?
- get-extended-key-code
- get-key-char
- get-key-code
- get-key-location
- param-string
- set-key-char
- set-key-code
- set-modifiers
jdk.awt.event.KeyEvent
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 accommodate 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.
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 accommodate 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.*-char-undefinedclj
Static Constant.
KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value.
type: char
Static Constant. KEY_PRESSED and KEY_RELEASED events which do not map to a valid Unicode character use this for the keyChar value. type: char
*-key-firstclj
Static Constant.
The first number in the range of ids used for key events.
type: int
Static Constant. The first number in the range of ids used for key events. type: int
*-key-lastclj
Static Constant.
The last number in the range of ids used for key events.
type: int
Static Constant. The last number in the range of ids used for key events. type: int
*-key-location-leftclj
Static Constant.
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.
type: int
Static Constant. 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. type: int
*-key-location-numpadclj
Static Constant.
A constant indicating that the key event originated on the numeric keypad or with a virtual key corresponding to the numeric keypad.
type: int
Static Constant. A constant indicating that the key event originated on the numeric keypad or with a virtual key corresponding to the numeric keypad. type: int
*-key-location-rightclj
Static Constant.
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.
type: int
Static Constant. 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. type: int
*-key-location-standardclj
Static Constant.
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).
type: int
Static Constant. 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). type: int
*-key-location-unknownclj
Static Constant.
A constant indicating that the keyLocation is indeterminate or not relevant. KEY_TYPED events do not have a keyLocation; this value is used instead.
type: int
Static Constant. A constant indicating that the keyLocation is indeterminate or not relevant. KEY_TYPED events do not have a keyLocation; this value is used instead. type: int
*-key-pressedclj
Static Constant.
The "key pressed" event. This event is generated when a key is pushed down.
type: int
Static Constant. The "key pressed" event. This event is generated when a key is pushed down. type: int
*-key-releasedclj
Static Constant.
The "key released" event. This event is generated when a key is let up.
type: int
Static Constant. The "key released" event. This event is generated when a key is let up. type: int
*-key-typedclj
Static Constant.
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.
type: int
Static Constant. 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. type: int
*-vk-0clj
Static Constant.
VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39)
type: int
Static Constant. VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) type: int
*-vk-aclj
Static Constant.
VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A)
type: int
Static Constant. VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) type: int
*-vk-acceptclj
Static Constant.
Constant for the Accept or Commit function key.
type: int
Static Constant. Constant for the Accept or Commit function key. type: int
*-vk-all-candidatesclj
Static Constant.
Constant for the All Candidates function key.
type: int
Static Constant. Constant for the All Candidates function key. type: int
*-vk-alphanumericclj
Static Constant.
Constant for the Alphanumeric function key.
type: int
Static Constant. Constant for the Alphanumeric function key. type: int
*-vk-alt-graphclj
Static Constant.
Constant for the AltGraph function key.
type: int
Static Constant. Constant for the AltGraph function key. type: int
*-vk-atclj
Static Constant.
Constant for the "@" key.
type: int
Static Constant. Constant for the "@" key. type: int
*-vk-back-slashclj
Static Constant.
Constant for the back slash key, ""
type: int
Static Constant. Constant for the back slash key, "\" type: int
*-vk-beginclj
Static Constant.
Constant for the Begin key.
type: int
Static Constant. Constant for the Begin key. type: int
*-vk-circumflexclj
Static Constant.
Constant for the "^" key.
type: int
Static Constant. Constant for the "^" key. type: int
*-vk-close-bracketclj
Static Constant.
Constant for the close bracket key, "]"
type: int
Static Constant. Constant for the close bracket key, "]" type: int
*-vk-code-inputclj
Static Constant.
Constant for the Code Input function key.
type: int
Static Constant. Constant for the Code Input function key. type: int
*-vk-colonclj
Static Constant.
Constant for the ":" key.
type: int
Static Constant. Constant for the ":" key. type: int
*-vk-commaclj
Static Constant.
Constant for the comma key, ","
type: int
Static Constant. Constant for the comma key, "," type: int
*-vk-composeclj
Static Constant.
Constant for the Compose function key.
type: int
Static Constant. Constant for the Compose function key. type: int
*-vk-context-menuclj
Static Constant.
Constant for the Microsoft Windows Context Menu key.
type: int
Static Constant. Constant for the Microsoft Windows Context Menu key. type: int
*-vk-convertclj
Static Constant.
Constant for the Convert function key.
type: int
Static Constant. Constant for the Convert function key. type: int
*-vk-dollarclj
Static Constant.
Constant for the "$" key.
type: int
Static Constant. Constant for the "$" key. type: int
*-vk-downclj
Static Constant.
Constant for the non-numpad down arrow key.
type: int
Static Constant. Constant for the non-numpad down arrow key. type: int
*-vk-equalsclj
Static Constant.
Constant for the equals key, "="
type: int
Static Constant. Constant for the equals key, "=" type: int
*-vk-euro-signclj
Static Constant.
Constant for the Euro currency sign key.
type: int
Static Constant. Constant for the Euro currency sign key. type: int
*-vk-exclamation-markclj
Static Constant.
Constant for the "!" key.
type: int
Static Constant. Constant for the "!" key. type: int
*-vk-f-1clj
Static Constant.
Constant for the F1 function key.
type: int
Static Constant. Constant for the F1 function key. type: int
*-vk-f-10clj
Static Constant.
Constant for the F10 function key.
type: int
Static Constant. Constant for the F10 function key. type: int
*-vk-f-11clj
Static Constant.
Constant for the F11 function key.
type: int
Static Constant. Constant for the F11 function key. type: int
*-vk-f-12clj
Static Constant.
Constant for the F12 function key.
type: int
Static Constant. Constant for the F12 function key. type: int
*-vk-f-13clj
Static Constant.
Constant for the F13 function key.
type: int
Static Constant. Constant for the F13 function key. type: int
*-vk-f-14clj
Static Constant.
Constant for the F14 function key.
type: int
Static Constant. Constant for the F14 function key. type: int
*-vk-f-15clj
Static Constant.
Constant for the F15 function key.
type: int
Static Constant. Constant for the F15 function key. type: int
*-vk-f-16clj
Static Constant.
Constant for the F16 function key.
type: int
Static Constant. Constant for the F16 function key. type: int
*-vk-f-17clj
Static Constant.
Constant for the F17 function key.
type: int
Static Constant. Constant for the F17 function key. type: int
*-vk-f-18clj
Static Constant.
Constant for the F18 function key.
type: int
Static Constant. Constant for the F18 function key. type: int
*-vk-f-19clj
Static Constant.
Constant for the F19 function key.
type: int
Static Constant. Constant for the F19 function key. type: int
*-vk-f-2clj
Static Constant.
Constant for the F2 function key.
type: int
Static Constant. Constant for the F2 function key. type: int
*-vk-f-20clj
Static Constant.
Constant for the F20 function key.
type: int
Static Constant. Constant for the F20 function key. type: int
*-vk-f-21clj
Static Constant.
Constant for the F21 function key.
type: int
Static Constant. Constant for the F21 function key. type: int
*-vk-f-22clj
Static Constant.
Constant for the F22 function key.
type: int
Static Constant. Constant for the F22 function key. type: int
*-vk-f-23clj
Static Constant.
Constant for the F23 function key.
type: int
Static Constant. Constant for the F23 function key. type: int
*-vk-f-24clj
Static Constant.
Constant for the F24 function key.
type: int
Static Constant. Constant for the F24 function key. type: int
*-vk-f-3clj
Static Constant.
Constant for the F3 function key.
type: int
Static Constant. Constant for the F3 function key. type: int
*-vk-f-4clj
Static Constant.
Constant for the F4 function key.
type: int
Static Constant. Constant for the F4 function key. type: int
*-vk-f-5clj
Static Constant.
Constant for the F5 function key.
type: int
Static Constant. Constant for the F5 function key. type: int
*-vk-f-6clj
Static Constant.
Constant for the F6 function key.
type: int
Static Constant. Constant for the F6 function key. type: int
*-vk-f-7clj
Static Constant.
Constant for the F7 function key.
type: int
Static Constant. Constant for the F7 function key. type: int
*-vk-f-8clj
Static Constant.
Constant for the F8 function key.
type: int
Static Constant. Constant for the F8 function key. type: int
*-vk-f-9clj
Static Constant.
Constant for the F9 function key.
type: int
Static Constant. Constant for the F9 function key. type: int
*-vk-full-widthclj
Static Constant.
Constant for the Full-Width Characters function key.
type: int
Static Constant. Constant for the Full-Width Characters function key. type: int
*-vk-half-widthclj
Static Constant.
Constant for the Half-Width Characters function key.
type: int
Static Constant. Constant for the Half-Width Characters function key. type: int
*-vk-hiraganaclj
Static Constant.
Constant for the Hiragana function key.
type: int
Static Constant. Constant for the Hiragana function key. type: int
*-vk-input-method-on-offclj
Static Constant.
Constant for the input method on/off key.
type: int
Static Constant. Constant for the input method on/off key. type: int
*-vk-inverted-exclamation-markclj
Static Constant.
Constant for the inverted exclamation mark key.
type: int
Static Constant. Constant for the inverted exclamation mark key. type: int
*-vk-japanese-hiraganaclj
Static Constant.
Constant for the Japanese-Hiragana function key. This key switches to a Japanese input method and selects its Hiragana input mode.
type: int
Static Constant. Constant for the Japanese-Hiragana function key. This key switches to a Japanese input method and selects its Hiragana input mode. type: int
*-vk-japanese-katakanaclj
Static Constant.
Constant for the Japanese-Katakana function key. This key switches to a Japanese input method and selects its Katakana input mode.
type: int
Static Constant. Constant for the Japanese-Katakana function key. This key switches to a Japanese input method and selects its Katakana input mode. type: int
*-vk-japanese-romanclj
Static Constant.
Constant for the Japanese-Roman function key. This key switches to a Japanese input method and selects its Roman-Direct input mode.
type: int
Static Constant. Constant for the Japanese-Roman function key. This key switches to a Japanese input method and selects its Roman-Direct input mode. type: int
*-vk-kana-lockclj
Static Constant.
Constant for the locking Kana function key. This key locks the keyboard into a Kana layout.
type: int
Static Constant. Constant for the locking Kana function key. This key locks the keyboard into a Kana layout. type: int
*-vk-katakanaclj
Static Constant.
Constant for the Katakana function key.
type: int
Static Constant. Constant for the Katakana function key. type: int
*-vk-kp-downclj
Static Constant.
Constant for the numeric keypad down arrow key.
type: int
Static Constant. Constant for the numeric keypad down arrow key. type: int
*-vk-kp-leftclj
Static Constant.
Constant for the numeric keypad left arrow key.
type: int
Static Constant. Constant for the numeric keypad left arrow key. type: int
*-vk-kp-rightclj
Static Constant.
Constant for the numeric keypad right arrow key.
type: int
Static Constant. Constant for the numeric keypad right arrow key. type: int
*-vk-kp-upclj
Static Constant.
Constant for the numeric keypad up arrow key.
type: int
Static Constant. Constant for the numeric keypad up arrow key. type: int
*-vk-leftclj
Static Constant.
Constant for the non-numpad left arrow key.
type: int
Static Constant. Constant for the non-numpad left arrow key. type: int
*-vk-left-parenthesisclj
Static Constant.
Constant for the "(" key.
type: int
Static Constant.
Constant for the "(" key.
type: int*-vk-minusclj
Static Constant.
Constant for the minus key, "-"
type: int
Static Constant. Constant for the minus key, "-" type: int
*-vk-nonconvertclj
Static Constant.
Constant for the Don't Convert function key.
type: int
Static Constant. Constant for the Don't Convert function key. type: int
*-vk-number-signclj
Static Constant.
Constant for the "#" key.
type: int
Static Constant. Constant for the "#" key. type: int
*-vk-open-bracketclj
Static Constant.
Constant for the open bracket key, "["
type: int
Static Constant. Constant for the open bracket key, "[" type: int
*-vk-periodclj
Static Constant.
Constant for the period key, "."
type: int
Static Constant. Constant for the period key, "." type: int
*-vk-plusclj
Static Constant.
Constant for the "+" key.
type: int
Static Constant. Constant for the "+" key. type: int
*-vk-previous-candidateclj
Static Constant.
Constant for the Previous Candidate function key.
type: int
Static Constant. Constant for the Previous Candidate function key. type: int
*-vk-rightclj
Static Constant.
Constant for the non-numpad right arrow key.
type: int
Static Constant. Constant for the non-numpad right arrow key. type: int
*-vk-right-parenthesisclj
Static Constant.
Constant for the ")" key.
type: int
Static Constant. Constant for the ")" key. type: int
*-vk-roman-charactersclj
Static Constant.
Constant for the Roman Characters function key.
type: int
Static Constant. Constant for the Roman Characters function key. type: int
*-vk-semicolonclj
Static Constant.
Constant for the semicolon key, ";"
type: int
Static Constant. Constant for the semicolon key, ";" type: int
*-vk-separaterclj
Static Constant.
This constant is obsolete, and is included only for backwards compatibility.
type: int
Static Constant. This constant is obsolete, and is included only for backwards compatibility. type: int
*-vk-separatorclj
Static Constant.
Constant for the Numpad Separator key.
type: int
Static Constant. Constant for the Numpad Separator key. type: int
*-vk-slashclj
Static Constant.
Constant for the forward slash key, "/"
type: int
Static Constant. Constant for the forward slash key, "/" type: int
*-vk-undefinedclj
Static Constant.
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.
type: int
Static Constant. 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. type: int
*-vk-underscoreclj
Static Constant.
Constant for the "_" key.
type: int
Static Constant. Constant for the "_" key. type: int
*-vk-upclj
Static Constant.
Constant for the non-numpad up arrow key.
type: int
Static Constant. Constant for the non-numpad up arrow key. type: int
*-vk-windowsclj
Static Constant.
Constant for the Microsoft Windows "Windows" key. It is used for both the left and right version of the key.
type: int
Static Constant. Constant for the Microsoft Windows "Windows" key. It is used for both the left and right version of the key. type: int
*get-extended-key-code-for-charclj
(*get-extended-key-code-for-char c)Returns an extended key code for a unicode character.
c - int
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. - int
Returns an extended key code for a unicode character. c - `int` 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. - `int`
*get-key-modifiers-textclj
(*get-key-modifiers-text modifiers)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.
modifiers - int
returns: string a text description of the combination of modifier
keys that were held down during the event - java.lang.String
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.
modifiers - `int`
returns: string a text description of the combination of modifier
keys that were held down during the event - `java.lang.String`*get-key-textclj
(*get-key-text key-code)Returns a String describing the keyCode, such as "HOME", "F1" or "A". These strings can be localized by changing the awt.properties file.
key-code - int
returns: a string containing a text description for a physical key,
identified by its keyCode - java.lang.String
Returns a String describing the keyCode, such as "HOME", "F1" or "A".
These strings can be localized by changing the awt.properties file.
key-code - `int`
returns: a string containing a text description for a physical key,
identified by its keyCode - `java.lang.String`->key-eventclj
(->key-event source id when modifiers key-code)(->key-event source id when modifiers key-code key-char)(->key-event source id when modifiers key-code key-char key-location)Constructor.
Constructs a KeyEvent object. This method throws an IllegalArgumentException if source is null.
source - The Component that originated the event - java.awt.Component
id - An integer indicating the type of event. For information on allowable values, see the class description for KeyEvent - int
when - A long integer that specifies the time the event occurred. Passing negative or zero value is not recommended - long
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 - int
key-code - The integer code for an actual key, or VK_UNDEFINED (for a key-typed event) - int
key-char - 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) - char
key-location - 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. - int
throws: java.lang.IllegalArgumentException - if source is null
Constructor. Constructs a KeyEvent object. This method throws an IllegalArgumentException if source is null. source - The Component that originated the event - `java.awt.Component` id - An integer indicating the type of event. For information on allowable values, see the class description for KeyEvent - `int` when - A long integer that specifies the time the event occurred. Passing negative or zero value is not recommended - `long` 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 - `int` key-code - The integer code for an actual key, or VK_UNDEFINED (for a key-typed event) - `int` key-char - 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) - `char` key-location - 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. - `int` throws: java.lang.IllegalArgumentException - if source is null
action-key?clj
(action-key? this)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 - boolean
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 - `boolean`get-extended-key-codeclj
(get-extended-key-code this)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".
returns: int
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". returns: `int`
get-key-charclj
(get-key-char this)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. - char
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. - `char`get-key-codeclj
(get-key-code this)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.) - int
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.) - `int`get-key-locationclj
(get-key-location this)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. - int
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. - `int`param-stringclj
(param-string this)Returns a parameter string identifying this event. This method is useful for event logging and for debugging.
returns: a string identifying the event and its attributes - java.lang.String
Returns a parameter string identifying this event. This method is useful for event logging and for debugging. returns: a string identifying the event and its attributes - `java.lang.String`
set-key-charclj
(set-key-char this key-char)Set the keyChar value to indicate a logical character.
key-char - a char corresponding to to the combination of keystrokes that make up this event. - char
Set the keyChar value to indicate a logical character. key-char - a char corresponding to to the combination of keystrokes that make up this event. - `char`
set-key-codeclj
(set-key-code this key-code)Set the keyCode value to indicate a physical key.
key-code - an integer corresponding to an actual key on the keyboard. - int
Set the keyCode value to indicate a physical key. key-code - an integer corresponding to an actual key on the keyboard. - `int`
set-modifiersclj
(set-modifiers this modifiers)Deprecated. as of JDK1.1.4
modifiers - an integer combination of the modifier constants. - int
Deprecated. as of JDK1.1.4 modifiers - an integer combination of the modifier constants. - `int`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close