org.apache.batik.dom.events

Class DOMKeyEvent

public class DOMKeyEvent extends DOMUIEvent

The KeyEvent interface provides specific contextual information associated with Key events.

Since: DOM Level 2 (Working Draft)

Field Summary
protected booleanaltKey
protected intcharCode
protected booleanctrlKey
static intCHAR_UNDEFINED
static intDOM_VK_0
static intDOM_VK_1
static intDOM_VK_2
static intDOM_VK_3
static intDOM_VK_4
static intDOM_VK_5
static intDOM_VK_6
static intDOM_VK_7
static intDOM_VK_8
static intDOM_VK_9
static intDOM_VK_A
static intDOM_VK_ACCEPT
static intDOM_VK_ADD
static intDOM_VK_AGAIN
static intDOM_VK_ALL_CANDIDATES
static intDOM_VK_ALPHANUMERIC
static intDOM_VK_ALT
static intDOM_VK_ALT_GRAPH
static intDOM_VK_AMPERSAND
static intDOM_VK_ASTERISK
static intDOM_VK_AT
static intDOM_VK_B
static intDOM_VK_BACK_QUOTE
static intDOM_VK_BACK_SLASH
static intDOM_VK_BACK_SPACE
static intDOM_VK_BRACELEFT
static intDOM_VK_BRACERIGHT
static intDOM_VK_C
static intDOM_VK_CANCEL
static intDOM_VK_CAPS_LOCK
static intDOM_VK_CIRCUMFLEX
static intDOM_VK_CLEAR
static intDOM_VK_CLOSE_BRACKET
static intDOM_VK_CODE_INPUT
static intDOM_VK_COLON
static intDOM_VK_COMMA
static intDOM_VK_COMPOSE
static intDOM_VK_CONTROL
static intDOM_VK_CONVERT
static intDOM_VK_COPY
static intDOM_VK_CUT
static intDOM_VK_D
static intDOM_VK_DEAD_ABOVEDOT
static intDOM_VK_DEAD_ABOVERING
static intDOM_VK_DEAD_ACUTE
static intDOM_VK_DEAD_BREVE
static intDOM_VK_DEAD_CARON
static intDOM_VK_DEAD_CEDILLA
static intDOM_VK_DEAD_CIRCUMFLEX
static intDOM_VK_DEAD_DIAERESIS
static intDOM_VK_DEAD_DOUBLEACUTE
static intDOM_VK_DEAD_GRAVE
static intDOM_VK_DEAD_IOTA
static intDOM_VK_DEAD_MACRON
static intDOM_VK_DEAD_OGONEK
static intDOM_VK_DEAD_SEMIVOICED_SOUND
static intDOM_VK_DEAD_TILDE
static intDOM_VK_DEAD_VOICED_SOUND
static intDOM_VK_DECIMAL
static intDOM_VK_DELETE
static intDOM_VK_DIVIDE
static intDOM_VK_DOLLAR
static intDOM_VK_DOWN
static intDOM_VK_E
static intDOM_VK_END
static intDOM_VK_ENTER
static intDOM_VK_EQUALS
static intDOM_VK_ESCAPE
static intDOM_VK_EURO_SIGN
static intDOM_VK_EXCLAMATION_MARK
static intDOM_VK_F
static intDOM_VK_F1
static intDOM_VK_F10
static intDOM_VK_F11
static intDOM_VK_F12
static intDOM_VK_F13
static intDOM_VK_F14
static intDOM_VK_F15
static intDOM_VK_F16
static intDOM_VK_F17
static intDOM_VK_F18
static intDOM_VK_F19
static intDOM_VK_F2
static intDOM_VK_F20
static intDOM_VK_F21
static intDOM_VK_F22
static intDOM_VK_F23
static intDOM_VK_F24
static intDOM_VK_F3
static intDOM_VK_F4
static intDOM_VK_F5
static intDOM_VK_F6
static intDOM_VK_F7
static intDOM_VK_F8
static intDOM_VK_F9
static intDOM_VK_FINAL
static intDOM_VK_FIND
static intDOM_VK_FULL_WIDTH
static intDOM_VK_G
static intDOM_VK_GREATER
static intDOM_VK_H
static intDOM_VK_HALF_WIDTH
static intDOM_VK_HELP
static intDOM_VK_HIRAGANA
static intDOM_VK_HOME
static intDOM_VK_I
static intDOM_VK_INSERT
static intDOM_VK_INVERTED_EXCLAMATION_MARK
static intDOM_VK_J
static intDOM_VK_JAPANESE_HIRAGANA
static intDOM_VK_JAPANESE_KATAKANA
static intDOM_VK_JAPANESE_ROMAN
static intDOM_VK_K
static intDOM_VK_KANA
static intDOM_VK_KANJI
static intDOM_VK_KATAKANA
static intDOM_VK_KP_DOWN
static intDOM_VK_KP_LEFT
static intDOM_VK_KP_RIGHT
static intDOM_VK_KP_UP
static intDOM_VK_L
static intDOM_VK_LEFT
static intDOM_VK_LEFT_PARENTHESIS
static intDOM_VK_LESS
static intDOM_VK_M
static intDOM_VK_META
static intDOM_VK_MINUS
static intDOM_VK_MODECHANGE
static intDOM_VK_MULTIPLY
static intDOM_VK_N
static intDOM_VK_NONCONVERT
static intDOM_VK_NUMBER_SIGN
static intDOM_VK_NUMPAD0
static intDOM_VK_NUMPAD1
static intDOM_VK_NUMPAD2
static intDOM_VK_NUMPAD3
static intDOM_VK_NUMPAD4
static intDOM_VK_NUMPAD5
static intDOM_VK_NUMPAD6
static intDOM_VK_NUMPAD7
static intDOM_VK_NUMPAD8
static intDOM_VK_NUMPAD9
static intDOM_VK_NUM_LOCK
static intDOM_VK_O
static intDOM_VK_OPEN_BRACKET
static intDOM_VK_P
static intDOM_VK_PAGE_DOWN
static intDOM_VK_PAGE_UP
static intDOM_VK_PASTE
static intDOM_VK_PAUSE
static intDOM_VK_PERIOD
static intDOM_VK_PLUS
static intDOM_VK_PREVIOUS_CANDIDATE
static intDOM_VK_PRINTSCREEN
static intDOM_VK_PROPS
static intDOM_VK_Q
static intDOM_VK_QUOTE
static intDOM_VK_QUOTEDBL
static intDOM_VK_R
static intDOM_VK_RIGHT
static intDOM_VK_RIGHT_PARENTHESIS
static intDOM_VK_ROMAN_CHARACTERS
static intDOM_VK_S
static intDOM_VK_SCROLL_LOCK
static intDOM_VK_SEMICOLON
static intDOM_VK_SEPARATER
static intDOM_VK_SHIFT
static intDOM_VK_SLASH
static intDOM_VK_SPACE
static intDOM_VK_STOP
static intDOM_VK_SUBTRACT
static intDOM_VK_T
static intDOM_VK_TAB
static intDOM_VK_U
static intDOM_VK_UNDEFINED
static intDOM_VK_UNDERSCORE
static intDOM_VK_UNDO
static intDOM_VK_UP
static intDOM_VK_V
static intDOM_VK_W
static intDOM_VK_X
static intDOM_VK_Y
static intDOM_VK_Z
protected intkeyCode
protected booleanmetaKey
protected booleanshiftKey
Method Summary
booleangetAltKey()
Returns whether the 'alt' key was depressed during the firing of the event.
intgetCharCode()
Returns the value of the Unicode character associated with the depressed key if the event is a key event.
booleangetCtrlKey()
Returns whether the 'ctrl' key was depressed during the firing of the event.
intgetKeyCode()
Returns the virtual key code value of the key which was depressed if the event is a key event.
booleangetMetaKey()
Returns whether the 'meta' key was depressed during the firing of the event.
booleangetShiftKey()
Returns whether the 'shift' key was depressed during the firing of the event.
voidinitKeyEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, int keyCodeArg, int charCodeArg, AbstractView viewArg)
Initializes this KeyEvent.

Field Detail

altKey

protected boolean altKey

charCode

protected int charCode

ctrlKey

protected boolean ctrlKey

CHAR_UNDEFINED

public static final int CHAR_UNDEFINED

DOM_VK_0

public static final int DOM_VK_0

DOM_VK_1

public static final int DOM_VK_1

DOM_VK_2

public static final int DOM_VK_2

DOM_VK_3

public static final int DOM_VK_3

DOM_VK_4

public static final int DOM_VK_4

DOM_VK_5

public static final int DOM_VK_5

DOM_VK_6

public static final int DOM_VK_6

DOM_VK_7

public static final int DOM_VK_7

DOM_VK_8

public static final int DOM_VK_8

DOM_VK_9

public static final int DOM_VK_9

DOM_VK_A

public static final int DOM_VK_A

DOM_VK_ACCEPT

public static final int DOM_VK_ACCEPT

DOM_VK_ADD

public static final int DOM_VK_ADD

DOM_VK_AGAIN

public static final int DOM_VK_AGAIN

DOM_VK_ALL_CANDIDATES

public static final int DOM_VK_ALL_CANDIDATES

DOM_VK_ALPHANUMERIC

public static final int DOM_VK_ALPHANUMERIC

DOM_VK_ALT

public static final int DOM_VK_ALT

DOM_VK_ALT_GRAPH

public static final int DOM_VK_ALT_GRAPH

DOM_VK_AMPERSAND

public static final int DOM_VK_AMPERSAND

DOM_VK_ASTERISK

public static final int DOM_VK_ASTERISK

DOM_VK_AT

public static final int DOM_VK_AT

DOM_VK_B

public static final int DOM_VK_B

DOM_VK_BACK_QUOTE

public static final int DOM_VK_BACK_QUOTE

DOM_VK_BACK_SLASH

public static final int DOM_VK_BACK_SLASH

DOM_VK_BACK_SPACE

public static final int DOM_VK_BACK_SPACE

DOM_VK_BRACELEFT

public static final int DOM_VK_BRACELEFT

DOM_VK_BRACERIGHT

public static final int DOM_VK_BRACERIGHT

DOM_VK_C

public static final int DOM_VK_C

DOM_VK_CANCEL

public static final int DOM_VK_CANCEL

DOM_VK_CAPS_LOCK

public static final int DOM_VK_CAPS_LOCK

DOM_VK_CIRCUMFLEX

public static final int DOM_VK_CIRCUMFLEX

DOM_VK_CLEAR

public static final int DOM_VK_CLEAR

DOM_VK_CLOSE_BRACKET

public static final int DOM_VK_CLOSE_BRACKET

DOM_VK_CODE_INPUT

public static final int DOM_VK_CODE_INPUT

DOM_VK_COLON

public static final int DOM_VK_COLON

DOM_VK_COMMA

public static final int DOM_VK_COMMA

DOM_VK_COMPOSE

public static final int DOM_VK_COMPOSE

DOM_VK_CONTROL

public static final int DOM_VK_CONTROL

DOM_VK_CONVERT

public static final int DOM_VK_CONVERT

DOM_VK_COPY

public static final int DOM_VK_COPY

DOM_VK_CUT

public static final int DOM_VK_CUT

DOM_VK_D

public static final int DOM_VK_D

DOM_VK_DEAD_ABOVEDOT

public static final int DOM_VK_DEAD_ABOVEDOT

DOM_VK_DEAD_ABOVERING

public static final int DOM_VK_DEAD_ABOVERING

DOM_VK_DEAD_ACUTE

public static final int DOM_VK_DEAD_ACUTE

DOM_VK_DEAD_BREVE

public static final int DOM_VK_DEAD_BREVE

DOM_VK_DEAD_CARON

public static final int DOM_VK_DEAD_CARON

DOM_VK_DEAD_CEDILLA

public static final int DOM_VK_DEAD_CEDILLA

DOM_VK_DEAD_CIRCUMFLEX

public static final int DOM_VK_DEAD_CIRCUMFLEX

DOM_VK_DEAD_DIAERESIS

public static final int DOM_VK_DEAD_DIAERESIS

DOM_VK_DEAD_DOUBLEACUTE

public static final int DOM_VK_DEAD_DOUBLEACUTE

DOM_VK_DEAD_GRAVE

public static final int DOM_VK_DEAD_GRAVE

DOM_VK_DEAD_IOTA

public static final int DOM_VK_DEAD_IOTA

DOM_VK_DEAD_MACRON

public static final int DOM_VK_DEAD_MACRON

DOM_VK_DEAD_OGONEK

public static final int DOM_VK_DEAD_OGONEK

DOM_VK_DEAD_SEMIVOICED_SOUND

public static final int DOM_VK_DEAD_SEMIVOICED_SOUND

DOM_VK_DEAD_TILDE

public static final int DOM_VK_DEAD_TILDE

DOM_VK_DEAD_VOICED_SOUND

public static final int DOM_VK_DEAD_VOICED_SOUND

DOM_VK_DECIMAL

public static final int DOM_VK_DECIMAL

DOM_VK_DELETE

public static final int DOM_VK_DELETE

DOM_VK_DIVIDE

public static final int DOM_VK_DIVIDE

DOM_VK_DOLLAR

public static final int DOM_VK_DOLLAR

DOM_VK_DOWN

public static final int DOM_VK_DOWN

DOM_VK_E

public static final int DOM_VK_E

DOM_VK_END

public static final int DOM_VK_END

DOM_VK_ENTER

public static final int DOM_VK_ENTER

DOM_VK_EQUALS

public static final int DOM_VK_EQUALS

DOM_VK_ESCAPE

public static final int DOM_VK_ESCAPE

DOM_VK_EURO_SIGN

public static final int DOM_VK_EURO_SIGN

DOM_VK_EXCLAMATION_MARK

public static final int DOM_VK_EXCLAMATION_MARK

DOM_VK_F

public static final int DOM_VK_F

DOM_VK_F1

public static final int DOM_VK_F1

DOM_VK_F10

public static final int DOM_VK_F10

DOM_VK_F11

public static final int DOM_VK_F11

DOM_VK_F12

public static final int DOM_VK_F12

DOM_VK_F13

public static final int DOM_VK_F13

DOM_VK_F14

public static final int DOM_VK_F14

DOM_VK_F15

public static final int DOM_VK_F15

DOM_VK_F16

public static final int DOM_VK_F16

DOM_VK_F17

public static final int DOM_VK_F17

DOM_VK_F18

public static final int DOM_VK_F18

DOM_VK_F19

public static final int DOM_VK_F19

DOM_VK_F2

public static final int DOM_VK_F2

DOM_VK_F20

public static final int DOM_VK_F20

DOM_VK_F21

public static final int DOM_VK_F21

DOM_VK_F22

public static final int DOM_VK_F22

DOM_VK_F23

public static final int DOM_VK_F23

DOM_VK_F24

public static final int DOM_VK_F24

DOM_VK_F3

public static final int DOM_VK_F3

DOM_VK_F4

public static final int DOM_VK_F4

DOM_VK_F5

public static final int DOM_VK_F5

DOM_VK_F6

public static final int DOM_VK_F6

DOM_VK_F7

public static final int DOM_VK_F7

DOM_VK_F8

public static final int DOM_VK_F8

DOM_VK_F9

public static final int DOM_VK_F9

DOM_VK_FINAL

public static final int DOM_VK_FINAL

DOM_VK_FIND

public static final int DOM_VK_FIND

DOM_VK_FULL_WIDTH

public static final int DOM_VK_FULL_WIDTH

DOM_VK_G

public static final int DOM_VK_G

DOM_VK_GREATER

public static final int DOM_VK_GREATER

DOM_VK_H

public static final int DOM_VK_H

DOM_VK_HALF_WIDTH

public static final int DOM_VK_HALF_WIDTH

DOM_VK_HELP

public static final int DOM_VK_HELP

DOM_VK_HIRAGANA

public static final int DOM_VK_HIRAGANA

DOM_VK_HOME

public static final int DOM_VK_HOME

DOM_VK_I

public static final int DOM_VK_I

DOM_VK_INSERT

public static final int DOM_VK_INSERT

DOM_VK_INVERTED_EXCLAMATION_MARK

public static final int DOM_VK_INVERTED_EXCLAMATION_MARK

DOM_VK_J

public static final int DOM_VK_J

DOM_VK_JAPANESE_HIRAGANA

public static final int DOM_VK_JAPANESE_HIRAGANA

DOM_VK_JAPANESE_KATAKANA

public static final int DOM_VK_JAPANESE_KATAKANA

DOM_VK_JAPANESE_ROMAN

public static final int DOM_VK_JAPANESE_ROMAN

DOM_VK_K

public static final int DOM_VK_K

DOM_VK_KANA

public static final int DOM_VK_KANA

DOM_VK_KANJI

public static final int DOM_VK_KANJI

DOM_VK_KATAKANA

public static final int DOM_VK_KATAKANA

DOM_VK_KP_DOWN

public static final int DOM_VK_KP_DOWN

DOM_VK_KP_LEFT

public static final int DOM_VK_KP_LEFT

DOM_VK_KP_RIGHT

public static final int DOM_VK_KP_RIGHT

DOM_VK_KP_UP

public static final int DOM_VK_KP_UP

DOM_VK_L

public static final int DOM_VK_L

DOM_VK_LEFT

public static final int DOM_VK_LEFT

DOM_VK_LEFT_PARENTHESIS

public static final int DOM_VK_LEFT_PARENTHESIS

DOM_VK_LESS

public static final int DOM_VK_LESS

DOM_VK_M

public static final int DOM_VK_M

DOM_VK_META

public static final int DOM_VK_META

DOM_VK_MINUS

public static final int DOM_VK_MINUS

DOM_VK_MODECHANGE

public static final int DOM_VK_MODECHANGE

DOM_VK_MULTIPLY

public static final int DOM_VK_MULTIPLY

DOM_VK_N

public static final int DOM_VK_N

DOM_VK_NONCONVERT

public static final int DOM_VK_NONCONVERT

DOM_VK_NUMBER_SIGN

public static final int DOM_VK_NUMBER_SIGN

DOM_VK_NUMPAD0

public static final int DOM_VK_NUMPAD0

DOM_VK_NUMPAD1

public static final int DOM_VK_NUMPAD1

DOM_VK_NUMPAD2

public static final int DOM_VK_NUMPAD2

DOM_VK_NUMPAD3

public static final int DOM_VK_NUMPAD3

DOM_VK_NUMPAD4

public static final int DOM_VK_NUMPAD4

DOM_VK_NUMPAD5

public static final int DOM_VK_NUMPAD5

DOM_VK_NUMPAD6

public static final int DOM_VK_NUMPAD6

DOM_VK_NUMPAD7

public static final int DOM_VK_NUMPAD7

DOM_VK_NUMPAD8

public static final int DOM_VK_NUMPAD8

DOM_VK_NUMPAD9

public static final int DOM_VK_NUMPAD9

DOM_VK_NUM_LOCK

public static final int DOM_VK_NUM_LOCK

DOM_VK_O

public static final int DOM_VK_O

DOM_VK_OPEN_BRACKET

public static final int DOM_VK_OPEN_BRACKET

DOM_VK_P

public static final int DOM_VK_P

DOM_VK_PAGE_DOWN

public static final int DOM_VK_PAGE_DOWN

DOM_VK_PAGE_UP

public static final int DOM_VK_PAGE_UP

DOM_VK_PASTE

public static final int DOM_VK_PASTE

DOM_VK_PAUSE

public static final int DOM_VK_PAUSE

DOM_VK_PERIOD

public static final int DOM_VK_PERIOD

DOM_VK_PLUS

public static final int DOM_VK_PLUS

DOM_VK_PREVIOUS_CANDIDATE

public static final int DOM_VK_PREVIOUS_CANDIDATE

DOM_VK_PRINTSCREEN

public static final int DOM_VK_PRINTSCREEN

DOM_VK_PROPS

public static final int DOM_VK_PROPS

DOM_VK_Q

public static final int DOM_VK_Q

DOM_VK_QUOTE

public static final int DOM_VK_QUOTE

DOM_VK_QUOTEDBL

public static final int DOM_VK_QUOTEDBL

DOM_VK_R

public static final int DOM_VK_R

DOM_VK_RIGHT

public static final int DOM_VK_RIGHT

DOM_VK_RIGHT_PARENTHESIS

public static final int DOM_VK_RIGHT_PARENTHESIS

DOM_VK_ROMAN_CHARACTERS

public static final int DOM_VK_ROMAN_CHARACTERS

DOM_VK_S

public static final int DOM_VK_S

DOM_VK_SCROLL_LOCK

public static final int DOM_VK_SCROLL_LOCK

DOM_VK_SEMICOLON

public static final int DOM_VK_SEMICOLON

DOM_VK_SEPARATER

public static final int DOM_VK_SEPARATER

DOM_VK_SHIFT

public static final int DOM_VK_SHIFT

DOM_VK_SLASH

public static final int DOM_VK_SLASH

DOM_VK_SPACE

public static final int DOM_VK_SPACE

DOM_VK_STOP

public static final int DOM_VK_STOP

DOM_VK_SUBTRACT

public static final int DOM_VK_SUBTRACT

DOM_VK_T

public static final int DOM_VK_T

DOM_VK_TAB

public static final int DOM_VK_TAB

DOM_VK_U

public static final int DOM_VK_U

DOM_VK_UNDEFINED

public static final int DOM_VK_UNDEFINED

DOM_VK_UNDERSCORE

public static final int DOM_VK_UNDERSCORE

DOM_VK_UNDO

public static final int DOM_VK_UNDO

DOM_VK_UP

public static final int DOM_VK_UP

DOM_VK_V

public static final int DOM_VK_V

DOM_VK_W

public static final int DOM_VK_W

DOM_VK_X

public static final int DOM_VK_X

DOM_VK_Y

public static final int DOM_VK_Y

DOM_VK_Z

public static final int DOM_VK_Z

keyCode

protected int keyCode

metaKey

protected boolean metaKey

shiftKey

protected boolean shiftKey

Method Detail

getAltKey

public boolean getAltKey()
Returns whether the 'alt' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.

getCharCode

public int getCharCode()
Returns the value of the Unicode character associated with the depressed key if the event is a key event. Otherwise, the value returned is zero.

getCtrlKey

public boolean getCtrlKey()
Returns whether the 'ctrl' key was depressed during the firing of the event.

getKeyCode

public int getKeyCode()
Returns the virtual key code value of the key which was depressed if the event is a key event. Otherwise, the value returned is zero.

getMetaKey

public boolean getMetaKey()
Returns whether the 'meta' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.

getShiftKey

public boolean getShiftKey()
Returns whether the 'shift' key was depressed during the firing of the event.

initKeyEvent

public void initKeyEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, int keyCodeArg, int charCodeArg, AbstractView viewArg)
Initializes this KeyEvent.

Parameters: typeArg Specifies the event type. canBubbleArg Specifies whether or not the event can bubble. cancelableArg Specifies whether or not the event's default action can be prevent. ctrlKeyArg Specifies whether or not control key was depressed during the Event. altKeyArg Specifies whether or not alt key was depressed during the Event. shiftKeyArg Specifies whether or not shift key was depressed during the Event. metaKeyArg Specifies whether or not meta key was depressed during the Event. keyCodeArg Specifies the Event's keyCode charCodeArg Specifies the Event's charCode viewArg Specifies the Event's AbstractView.

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.