org.apache.batik.dom.events

Class DOMKeyboardEvent

public class DOMKeyboardEvent extends DOMUIEvent implements KeyboardEvent

DOM 3 Keyboard event class.
Field Summary
protected StringkeyIdentifier
The identifier string for the key.
protected intkeyLocation
The location of the key.
static StringKEY_0
static StringKEY_1
static StringKEY_2
static StringKEY_3
static StringKEY_4
static StringKEY_5
static StringKEY_6
static StringKEY_7
static StringKEY_8
static StringKEY_9
static StringKEY_A
static StringKEY_ACCEPT
static StringKEY_AGAIN
static StringKEY_ALL_CANDIDATES
static StringKEY_ALPHANUMERIC
static StringKEY_ALT
static StringKEY_ALT_GRAPH
static StringKEY_AMPERSAND
static StringKEY_APOSTROPHE
static StringKEY_APPS
static StringKEY_ASTERISK
static StringKEY_AT
static StringKEY_ATTN
static StringKEY_B
static StringKEY_BACKSLASH
static StringKEY_BACKSPACE
static StringKEY_BROWSER_BACK
static StringKEY_BROWSER_FAVORITES
static StringKEY_BROWSER_FORWARD
static StringKEY_BROWSER_HOME
static StringKEY_BROWSER_REFRESH
static StringKEY_BROWSER_SEARCH
static StringKEY_BROWSER_STOP
static StringKEY_C
static StringKEY_CANCEL
static StringKEY_CAPS_LOCK
static StringKEY_CIRCUMFLEX
static StringKEY_CLEAR
static StringKEY_CODE_INPUT
static StringKEY_COLON
static StringKEY_COMBINING_ACUTE
static StringKEY_COMBINING_BREVE
static StringKEY_COMBINING_CARON
static StringKEY_COMBINING_CEDILLA
static StringKEY_COMBINING_CIRCUMFLEX
static StringKEY_COMBINING_DIERESIS
static StringKEY_COMBINING_DOT_ABOVE
static StringKEY_COMBINING_DOUBLE_ACUTE
static StringKEY_COMBINING_GRAVE
static StringKEY_COMBINING_IOTA
static StringKEY_COMBINING_MACRON
static StringKEY_COMBINING_OGONEK
static StringKEY_COMBINING_RING_ABOVE
static StringKEY_COMBINING_TILDE
static StringKEY_COMMA
static StringKEY_COMPOSE
static StringKEY_CONTROL
static StringKEY_CONVERT
static StringKEY_COPY
static StringKEY_CRSEL
static StringKEY_CUT
static StringKEY_D
static StringKEY_DELETE
static StringKEY_DOLLAR
static StringKEY_DOWN
static StringKEY_E
static StringKEY_END
static StringKEY_ENTER
static StringKEY_EQUALS
static StringKEY_ERASE_EOF
static StringKEY_ESCAPE
static StringKEY_EURO
static StringKEY_EXCLAMATION
static StringKEY_EXECUTE
static StringKEY_EXSEL
static StringKEY_F
static StringKEY_F1
static StringKEY_F10
static StringKEY_F11
static StringKEY_F12
static StringKEY_F13
static StringKEY_F14
static StringKEY_F15
static StringKEY_F16
static StringKEY_F17
static StringKEY_F18
static StringKEY_F19
static StringKEY_F2
static StringKEY_F20
static StringKEY_F21
static StringKEY_F22
static StringKEY_F23
static StringKEY_F24
static StringKEY_F3
static StringKEY_F4
static StringKEY_F5
static StringKEY_F6
static StringKEY_F7
static StringKEY_F8
static StringKEY_F9
static StringKEY_FINAL_MODE
static StringKEY_FIND
static StringKEY_FULL_STOP
static StringKEY_FULL_WIDTH
static StringKEY_G
static StringKEY_GRAVE
static StringKEY_GREATER_THAN
static StringKEY_H
static StringKEY_HALF_WIDTH
static StringKEY_HANGUL_MODE
static StringKEY_HANJA_MODE
static StringKEY_HASH
static StringKEY_HELP
static StringKEY_HIRAGANA
static StringKEY_HOME
static StringKEY_I
static StringKEY_INSERT
static StringKEY_INVERTED_EXCLAMATION
static StringKEY_J
static StringKEY_JAPANESE_HIRAGANA
static StringKEY_JAPANESE_KATAKANA
static StringKEY_JAPANESE_ROMAJI
static StringKEY_JUNJA_MODE
static StringKEY_K
static StringKEY_KANA_MODE
static StringKEY_KANJI_MODE
static StringKEY_KATAKANA
static StringKEY_L
static StringKEY_LAUNCH_APPLICATION1
static StringKEY_LAUNCH_APPLICATION2
static StringKEY_LAUNCH_MAIL
static StringKEY_LEFT
static StringKEY_LEFT_BRACE
static StringKEY_LEFT_PARENTHESIS
static StringKEY_LEFT_SQUARE_BRACKET
static StringKEY_LESS_THAN
static StringKEY_M
static StringKEY_MEDIA_NEXT_TRACK
static StringKEY_MEDIA_PLAY_PAUSE
static StringKEY_MEDIA_PREVIOUS_TRACK
static StringKEY_MEDIA_STOP
static StringKEY_META
static StringKEY_MINUS
static StringKEY_MODE_CHANGE
static StringKEY_N
static StringKEY_NONCONVERT
static StringKEY_NUM_LOCK
static StringKEY_O
static StringKEY_P
static StringKEY_PAGE_DOWN
static StringKEY_PAGE_UP
static StringKEY_PASTE
static StringKEY_PAUSE
static StringKEY_PLAY
static StringKEY_PLUS
static StringKEY_PREVIOUS_CANDIDATE
static StringKEY_PRINT_SCREEN
static StringKEY_PROCESS
static StringKEY_PROPS
static StringKEY_Q
static StringKEY_QUESTION
static StringKEY_QUOTE
static StringKEY_R
static StringKEY_RIGHT
static StringKEY_RIGHT_BRACE
static StringKEY_RIGHT_PARENTHESIS
static StringKEY_RIGHT_SQUARE_BRACKET
static StringKEY_ROMAN_CHARACTERS
static StringKEY_S
static StringKEY_SCROLL
static StringKEY_SELECT
static StringKEY_SELECT_MEDIA
static StringKEY_SEMICOLON
static StringKEY_SEMIVOICED_SOUND
static StringKEY_SHIFT
static StringKEY_SLASH
static StringKEY_SPACE
static StringKEY_STOP
static StringKEY_T
static StringKEY_TAB
static StringKEY_U
static StringKEY_UNDERSCORE
static StringKEY_UNDO
static StringKEY_UNIDENTIFIED
static StringKEY_UP
static StringKEY_V
static StringKEY_VERTICAL_BAR
static StringKEY_VOICED_SOUND
static StringKEY_VOLUME_DOWN
static StringKEY_VOLUME_MUTE
static StringKEY_VOLUME_UP
static StringKEY_W
static StringKEY_WIN
static StringKEY_X
static StringKEY_Y
static StringKEY_Z
static StringKEY_ZOOM
protected HashSetmodifierKeys
The modifier keys in effect at the time of the event.
Method Summary
booleangetAltKey()
DOM: Get whether the Alt key was pressed at the time of the event.
booleangetCtrlKey()
DOM: Get whether the Control key was pressed at the time of the event.
StringgetKeyIdentifier()
DOM: Get the key identifier.
intgetKeyLocation()
DOM: Get the key location.
booleangetMetaKey()
DOM: Get whether the Meta key was pressed at the time of the event.
booleangetModifierState(String keyIdentifierArg)
DOM: Returns whether the given modifier key was pressed at the time of the event.
booleangetShiftKey()
DOM: Get whether the Shift key was pressed at the time of the event.
voidinitKeyboardEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, String keyIdentifierArg, int keyLocationArg, String modifiersList)
DOM: Initializes this KeyboardEvent object.
voidinitKeyboardEventNS(String namespaceURIArg, String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, String keyIdentifierArg, int keyLocationArg, String modifiersList)
DOM

Field Detail

keyIdentifier

protected String keyIdentifier
The identifier string for the key.

keyLocation

protected int keyLocation
The location of the key.

KEY_0

public static final String KEY_0

KEY_1

public static final String KEY_1

KEY_2

public static final String KEY_2

KEY_3

public static final String KEY_3

KEY_4

public static final String KEY_4

KEY_5

public static final String KEY_5

KEY_6

public static final String KEY_6

KEY_7

public static final String KEY_7

KEY_8

public static final String KEY_8

KEY_9

public static final String KEY_9

KEY_A

public static final String KEY_A

KEY_ACCEPT

public static final String KEY_ACCEPT

KEY_AGAIN

public static final String KEY_AGAIN

KEY_ALL_CANDIDATES

public static final String KEY_ALL_CANDIDATES

KEY_ALPHANUMERIC

public static final String KEY_ALPHANUMERIC

KEY_ALT

public static final String KEY_ALT

KEY_ALT_GRAPH

public static final String KEY_ALT_GRAPH

KEY_AMPERSAND

public static final String KEY_AMPERSAND

KEY_APOSTROPHE

public static final String KEY_APOSTROPHE

KEY_APPS

public static final String KEY_APPS

KEY_ASTERISK

public static final String KEY_ASTERISK

KEY_AT

public static final String KEY_AT

KEY_ATTN

public static final String KEY_ATTN

KEY_B

public static final String KEY_B

KEY_BACKSLASH

public static final String KEY_BACKSLASH

KEY_BACKSPACE

public static final String KEY_BACKSPACE

KEY_BROWSER_BACK

public static final String KEY_BROWSER_BACK

KEY_BROWSER_FAVORITES

public static final String KEY_BROWSER_FAVORITES

KEY_BROWSER_FORWARD

public static final String KEY_BROWSER_FORWARD

KEY_BROWSER_HOME

public static final String KEY_BROWSER_HOME

KEY_BROWSER_REFRESH

public static final String KEY_BROWSER_REFRESH

KEY_BROWSER_SEARCH

public static final String KEY_BROWSER_SEARCH

KEY_BROWSER_STOP

public static final String KEY_BROWSER_STOP

KEY_C

public static final String KEY_C

KEY_CANCEL

public static final String KEY_CANCEL

KEY_CAPS_LOCK

public static final String KEY_CAPS_LOCK

KEY_CIRCUMFLEX

public static final String KEY_CIRCUMFLEX

KEY_CLEAR

public static final String KEY_CLEAR

KEY_CODE_INPUT

public static final String KEY_CODE_INPUT

KEY_COLON

public static final String KEY_COLON

KEY_COMBINING_ACUTE

public static final String KEY_COMBINING_ACUTE

KEY_COMBINING_BREVE

public static final String KEY_COMBINING_BREVE

KEY_COMBINING_CARON

public static final String KEY_COMBINING_CARON

KEY_COMBINING_CEDILLA

public static final String KEY_COMBINING_CEDILLA

KEY_COMBINING_CIRCUMFLEX

public static final String KEY_COMBINING_CIRCUMFLEX

KEY_COMBINING_DIERESIS

public static final String KEY_COMBINING_DIERESIS

KEY_COMBINING_DOT_ABOVE

public static final String KEY_COMBINING_DOT_ABOVE

KEY_COMBINING_DOUBLE_ACUTE

public static final String KEY_COMBINING_DOUBLE_ACUTE

KEY_COMBINING_GRAVE

public static final String KEY_COMBINING_GRAVE

KEY_COMBINING_IOTA

public static final String KEY_COMBINING_IOTA

KEY_COMBINING_MACRON

public static final String KEY_COMBINING_MACRON

KEY_COMBINING_OGONEK

public static final String KEY_COMBINING_OGONEK

KEY_COMBINING_RING_ABOVE

public static final String KEY_COMBINING_RING_ABOVE

KEY_COMBINING_TILDE

public static final String KEY_COMBINING_TILDE

KEY_COMMA

public static final String KEY_COMMA

KEY_COMPOSE

public static final String KEY_COMPOSE

KEY_CONTROL

public static final String KEY_CONTROL

KEY_CONVERT

public static final String KEY_CONVERT

KEY_COPY

public static final String KEY_COPY

KEY_CRSEL

public static final String KEY_CRSEL

KEY_CUT

public static final String KEY_CUT

KEY_D

public static final String KEY_D

KEY_DELETE

public static final String KEY_DELETE

KEY_DOLLAR

public static final String KEY_DOLLAR

KEY_DOWN

public static final String KEY_DOWN

KEY_E

public static final String KEY_E

KEY_END

public static final String KEY_END

KEY_ENTER

public static final String KEY_ENTER

KEY_EQUALS

public static final String KEY_EQUALS

KEY_ERASE_EOF

public static final String KEY_ERASE_EOF

KEY_ESCAPE

public static final String KEY_ESCAPE

KEY_EURO

public static final String KEY_EURO

KEY_EXCLAMATION

public static final String KEY_EXCLAMATION

KEY_EXECUTE

public static final String KEY_EXECUTE

KEY_EXSEL

public static final String KEY_EXSEL

KEY_F

public static final String KEY_F

KEY_F1

public static final String KEY_F1

KEY_F10

public static final String KEY_F10

KEY_F11

public static final String KEY_F11

KEY_F12

public static final String KEY_F12

KEY_F13

public static final String KEY_F13

KEY_F14

public static final String KEY_F14

KEY_F15

public static final String KEY_F15

KEY_F16

public static final String KEY_F16

KEY_F17

public static final String KEY_F17

KEY_F18

public static final String KEY_F18

KEY_F19

public static final String KEY_F19

KEY_F2

public static final String KEY_F2

KEY_F20

public static final String KEY_F20

KEY_F21

public static final String KEY_F21

KEY_F22

public static final String KEY_F22

KEY_F23

public static final String KEY_F23

KEY_F24

public static final String KEY_F24

KEY_F3

public static final String KEY_F3

KEY_F4

public static final String KEY_F4

KEY_F5

public static final String KEY_F5

KEY_F6

public static final String KEY_F6

KEY_F7

public static final String KEY_F7

KEY_F8

public static final String KEY_F8

KEY_F9

public static final String KEY_F9

KEY_FINAL_MODE

public static final String KEY_FINAL_MODE

KEY_FIND

public static final String KEY_FIND

KEY_FULL_STOP

public static final String KEY_FULL_STOP

KEY_FULL_WIDTH

public static final String KEY_FULL_WIDTH

KEY_G

public static final String KEY_G

KEY_GRAVE

public static final String KEY_GRAVE

KEY_GREATER_THAN

public static final String KEY_GREATER_THAN

KEY_H

public static final String KEY_H

KEY_HALF_WIDTH

public static final String KEY_HALF_WIDTH

KEY_HANGUL_MODE

public static final String KEY_HANGUL_MODE

KEY_HANJA_MODE

public static final String KEY_HANJA_MODE

KEY_HASH

public static final String KEY_HASH

KEY_HELP

public static final String KEY_HELP

KEY_HIRAGANA

public static final String KEY_HIRAGANA

KEY_HOME

public static final String KEY_HOME

KEY_I

public static final String KEY_I

KEY_INSERT

public static final String KEY_INSERT

KEY_INVERTED_EXCLAMATION

public static final String KEY_INVERTED_EXCLAMATION

KEY_J

public static final String KEY_J

KEY_JAPANESE_HIRAGANA

public static final String KEY_JAPANESE_HIRAGANA

KEY_JAPANESE_KATAKANA

public static final String KEY_JAPANESE_KATAKANA

KEY_JAPANESE_ROMAJI

public static final String KEY_JAPANESE_ROMAJI

KEY_JUNJA_MODE

public static final String KEY_JUNJA_MODE

KEY_K

public static final String KEY_K

KEY_KANA_MODE

public static final String KEY_KANA_MODE

KEY_KANJI_MODE

public static final String KEY_KANJI_MODE

KEY_KATAKANA

public static final String KEY_KATAKANA

KEY_L

public static final String KEY_L

KEY_LAUNCH_APPLICATION1

public static final String KEY_LAUNCH_APPLICATION1

KEY_LAUNCH_APPLICATION2

public static final String KEY_LAUNCH_APPLICATION2

KEY_LAUNCH_MAIL

public static final String KEY_LAUNCH_MAIL

KEY_LEFT

public static final String KEY_LEFT

KEY_LEFT_BRACE

public static final String KEY_LEFT_BRACE

KEY_LEFT_PARENTHESIS

public static final String KEY_LEFT_PARENTHESIS

KEY_LEFT_SQUARE_BRACKET

public static final String KEY_LEFT_SQUARE_BRACKET

KEY_LESS_THAN

public static final String KEY_LESS_THAN

KEY_M

public static final String KEY_M

KEY_MEDIA_NEXT_TRACK

public static final String KEY_MEDIA_NEXT_TRACK

KEY_MEDIA_PLAY_PAUSE

public static final String KEY_MEDIA_PLAY_PAUSE

KEY_MEDIA_PREVIOUS_TRACK

public static final String KEY_MEDIA_PREVIOUS_TRACK

KEY_MEDIA_STOP

public static final String KEY_MEDIA_STOP

KEY_META

public static final String KEY_META

KEY_MINUS

public static final String KEY_MINUS

KEY_MODE_CHANGE

public static final String KEY_MODE_CHANGE

KEY_N

public static final String KEY_N

KEY_NONCONVERT

public static final String KEY_NONCONVERT

KEY_NUM_LOCK

public static final String KEY_NUM_LOCK

KEY_O

public static final String KEY_O

KEY_P

public static final String KEY_P

KEY_PAGE_DOWN

public static final String KEY_PAGE_DOWN

KEY_PAGE_UP

public static final String KEY_PAGE_UP

KEY_PASTE

public static final String KEY_PASTE

KEY_PAUSE

public static final String KEY_PAUSE

KEY_PLAY

public static final String KEY_PLAY

KEY_PLUS

public static final String KEY_PLUS

KEY_PREVIOUS_CANDIDATE

public static final String KEY_PREVIOUS_CANDIDATE

KEY_PRINT_SCREEN

public static final String KEY_PRINT_SCREEN

KEY_PROCESS

public static final String KEY_PROCESS

KEY_PROPS

public static final String KEY_PROPS

KEY_Q

public static final String KEY_Q

KEY_QUESTION

public static final String KEY_QUESTION

KEY_QUOTE

public static final String KEY_QUOTE

KEY_R

public static final String KEY_R

KEY_RIGHT

public static final String KEY_RIGHT

KEY_RIGHT_BRACE

public static final String KEY_RIGHT_BRACE

KEY_RIGHT_PARENTHESIS

public static final String KEY_RIGHT_PARENTHESIS

KEY_RIGHT_SQUARE_BRACKET

public static final String KEY_RIGHT_SQUARE_BRACKET

KEY_ROMAN_CHARACTERS

public static final String KEY_ROMAN_CHARACTERS

KEY_S

public static final String KEY_S

KEY_SCROLL

public static final String KEY_SCROLL

KEY_SELECT

public static final String KEY_SELECT

KEY_SELECT_MEDIA

public static final String KEY_SELECT_MEDIA

KEY_SEMICOLON

public static final String KEY_SEMICOLON

KEY_SEMIVOICED_SOUND

public static final String KEY_SEMIVOICED_SOUND

KEY_SHIFT

public static final String KEY_SHIFT

KEY_SLASH

public static final String KEY_SLASH

KEY_SPACE

public static final String KEY_SPACE

KEY_STOP

public static final String KEY_STOP

KEY_T

public static final String KEY_T

KEY_TAB

public static final String KEY_TAB

KEY_U

public static final String KEY_U

KEY_UNDERSCORE

public static final String KEY_UNDERSCORE

KEY_UNDO

public static final String KEY_UNDO

KEY_UNIDENTIFIED

public static final String KEY_UNIDENTIFIED

KEY_UP

public static final String KEY_UP

KEY_V

public static final String KEY_V

KEY_VERTICAL_BAR

public static final String KEY_VERTICAL_BAR

KEY_VOICED_SOUND

public static final String KEY_VOICED_SOUND

KEY_VOLUME_DOWN

public static final String KEY_VOLUME_DOWN

KEY_VOLUME_MUTE

public static final String KEY_VOLUME_MUTE

KEY_VOLUME_UP

public static final String KEY_VOLUME_UP

KEY_W

public static final String KEY_W

KEY_WIN

public static final String KEY_WIN

KEY_X

public static final String KEY_X

KEY_Y

public static final String KEY_Y

KEY_Z

public static final String KEY_Z

KEY_ZOOM

public static final String KEY_ZOOM

modifierKeys

protected HashSet modifierKeys
The modifier keys in effect at the time of the event.

Method Detail

getAltKey

public boolean getAltKey()
DOM: Get whether the Alt key was pressed at the time of the event.

getCtrlKey

public boolean getCtrlKey()
DOM: Get whether the Control key was pressed at the time of the event.

getKeyIdentifier

public String getKeyIdentifier()
DOM: Get the key identifier.

getKeyLocation

public int getKeyLocation()
DOM: Get the key location.

getMetaKey

public boolean getMetaKey()
DOM: Get whether the Meta key was pressed at the time of the event.

getModifierState

public boolean getModifierState(String keyIdentifierArg)
DOM: Returns whether the given modifier key was pressed at the time of the event.

getShiftKey

public boolean getShiftKey()
DOM: Get whether the Shift key was pressed at the time of the event.

initKeyboardEvent

public void initKeyboardEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, String keyIdentifierArg, int keyLocationArg, String modifiersList)
DOM: Initializes this KeyboardEvent object.

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 prevented. viewArg Specifies the Event's AbstractView. keyIdentifierArg Specifies the Event's keyIdentifier. keyLocationArg Specifies the Event's keyLocation. modifiersList Specifies which modifiers were in effect for this Event.

initKeyboardEventNS

public void initKeyboardEventNS(String namespaceURIArg, String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, String keyIdentifierArg, int keyLocationArg, String modifiersList)
DOMParameters: namespaceURIArg Specifies the event namespace URI. 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 prevented. viewArg Specifies the Event's AbstractView. keyIdentifierArg Specifies the Event's keyIdentifier. keyLocationArg Specifies the Event's keyLocation. modifiersList Specifies which modifiers were in effect for this Event.

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