Class DOMKeyboardEvent
java.lang.Object
org.apache.batik.dom.events.AbstractEvent
org.apache.batik.dom.events.DOMUIEvent
org.apache.batik.dom.events.DOMKeyboardEvent
- All Implemented Interfaces:
Cloneable, OriginalEvent, KeyboardEvent, Event, UIEvent
DOM 3 Keyboard event class.
- Version:
- $Id$
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected StringThe identifier string for the key.protected intThe location of the key.protected HashSetThe modifier keys in effect at the time of the event.Fields inherited from class AbstractEvent
bubbleLimit, cancelable, currentTarget, defaultActions, eventPhase, isBubbling, namespaceURI, originalEvent, preventDefault, stopImmediatePropagation, stopPropagation, target, timeStamp, typeFields inherited from interface Event
AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASEFields inherited from interface KeyboardEvent
DOM_KEY_LOCATION_LEFT, DOM_KEY_LOCATION_NUMPAD, DOM_KEY_LOCATION_RIGHT, DOM_KEY_LOCATION_STANDARD -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanDOM: Get whether the Alt key was pressed at the time of the event.booleanDOM: Get whether the Control key was pressed at the time of the event.DOM: Get the key identifier.intDOM: Get the key location.booleanDOM: 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.booleanDOM: 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: Initializes this KeyboardEvent object.Methods inherited from class DOMUIEvent
getDetail, getView, initUIEvent, initUIEventNS, splitMethods inherited from class AbstractEvent
addDefaultAction, clone, cloneEvent, getBubbleLimit, getBubbles, getCancelable, getCurrentTarget, getDefaultActions, getDefaultPrevented, getEventPhase, getNamespaceURI, getOriginalEvent, getStopImmediatePropagation, getStopPropagation, getTarget, getTimeStamp, getType, initEvent, initEventNS, preventDefault, preventDefault, setBubbleLimit, setCurrentTarget, setEventPhase, setTarget, stopImmediatePropagation, stopImmediatePropagation, stopPropagation, stopPropagationMethods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Event
getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagationMethods inherited from interface UIEvent
getDetail, getView, initUIEvent
-
Field Details
-
KEY_UNIDENTIFIED
- See Also:
-
KEY_ACCEPT
- See Also:
-
KEY_AGAIN
- See Also:
-
KEY_ALL_CANDIDATES
- See Also:
-
KEY_ALPHANUMERIC
- See Also:
-
KEY_ALT
- See Also:
-
KEY_ALT_GRAPH
- See Also:
-
KEY_APPS
- See Also:
-
KEY_ATTN
- See Also:
-
KEY_BROWSER_BACK
- See Also:
-
KEY_BROWSER_FAVORITES
- See Also:
-
KEY_BROWSER_FORWARD
- See Also:
-
KEY_BROWSER_HOME
- See Also:
-
KEY_BROWSER_REFRESH
- See Also:
-
KEY_BROWSER_SEARCH
- See Also:
-
KEY_BROWSER_STOP
- See Also:
-
KEY_CAPS_LOCK
- See Also:
-
KEY_CLEAR
- See Also:
-
KEY_CODE_INPUT
- See Also:
-
KEY_COMPOSE
- See Also:
-
KEY_CONTROL
- See Also:
-
KEY_CRSEL
- See Also:
-
KEY_CONVERT
- See Also:
-
KEY_COPY
- See Also:
-
KEY_CUT
- See Also:
-
KEY_DOWN
- See Also:
-
KEY_END
- See Also:
-
KEY_ENTER
- See Also:
-
KEY_ERASE_EOF
- See Also:
-
KEY_EXECUTE
- See Also:
-
KEY_EXSEL
- See Also:
-
KEY_F1
- See Also:
-
KEY_F2
- See Also:
-
KEY_F3
- See Also:
-
KEY_F4
- See Also:
-
KEY_F5
- See Also:
-
KEY_F6
- See Also:
-
KEY_F7
- See Also:
-
KEY_F8
- See Also:
-
KEY_F9
- See Also:
-
KEY_F10
- See Also:
-
KEY_F11
- See Also:
-
KEY_F12
- See Also:
-
KEY_F13
- See Also:
-
KEY_F14
- See Also:
-
KEY_F15
- See Also:
-
KEY_F16
- See Also:
-
KEY_F17
- See Also:
-
KEY_F18
- See Also:
-
KEY_F19
- See Also:
-
KEY_F20
- See Also:
-
KEY_F21
- See Also:
-
KEY_BACKSPACE
- See Also:
-
KEY_TAB
- See Also:
-
KEY_CANCEL
- See Also:
-
KEY_ESCAPE
- See Also:
-
KEY_SPACE
- See Also:
-
KEY_EXCLAMATION
- See Also:
-
KEY_QUOTE
- See Also:
-
KEY_HASH
- See Also:
-
KEY_DOLLAR
- See Also:
-
KEY_AMPERSAND
- See Also:
-
KEY_APOSTROPHE
- See Also:
-
KEY_LEFT_PARENTHESIS
- See Also:
-
KEY_RIGHT_PARENTHESIS
- See Also:
-
KEY_ASTERISK
- See Also:
-
KEY_PLUS
- See Also:
-
KEY_COMMA
- See Also:
-
KEY_MINUS
- See Also:
-
KEY_FULL_STOP
- See Also:
-
KEY_SLASH
- See Also:
-
KEY_0
- See Also:
-
KEY_1
- See Also:
-
KEY_2
- See Also:
-
KEY_3
- See Also:
-
KEY_4
- See Also:
-
KEY_5
- See Also:
-
KEY_6
- See Also:
-
KEY_7
- See Also:
-
KEY_8
- See Also:
-
KEY_9
- See Also:
-
KEY_COLON
- See Also:
-
KEY_SEMICOLON
- See Also:
-
KEY_LESS_THAN
- See Also:
-
KEY_EQUALS
- See Also:
-
KEY_GREATER_THAN
- See Also:
-
KEY_QUESTION
- See Also:
-
KEY_AT
- See Also:
-
KEY_A
- See Also:
-
KEY_B
- See Also:
-
KEY_C
- See Also:
-
KEY_D
- See Also:
-
KEY_E
- See Also:
-
KEY_F
- See Also:
-
KEY_G
- See Also:
-
KEY_H
- See Also:
-
KEY_I
- See Also:
-
KEY_J
- See Also:
-
KEY_K
- See Also:
-
KEY_L
- See Also:
-
KEY_M
- See Also:
-
KEY_N
- See Also:
-
KEY_O
- See Also:
-
KEY_P
- See Also:
-
KEY_Q
- See Also:
-
KEY_R
- See Also:
-
KEY_S
- See Also:
-
KEY_T
- See Also:
-
KEY_U
- See Also:
-
KEY_V
- See Also:
-
KEY_W
- See Also:
-
KEY_X
- See Also:
-
KEY_Y
- See Also:
-
KEY_Z
- See Also:
-
KEY_LEFT_SQUARE_BRACKET
- See Also:
-
KEY_BACKSLASH
- See Also:
-
KEY_RIGHT_SQUARE_BRACKET
- See Also:
-
KEY_CIRCUMFLEX
- See Also:
-
KEY_UNDERSCORE
- See Also:
-
KEY_GRAVE
- See Also:
-
KEY_LEFT_BRACE
- See Also:
-
KEY_VERTICAL_BAR
- See Also:
-
KEY_RIGHT_BRACE
- See Also:
-
KEY_DELETE
- See Also:
-
KEY_INVERTED_EXCLAMATION
- See Also:
-
KEY_COMBINING_GRAVE
- See Also:
-
KEY_COMBINING_ACUTE
- See Also:
-
KEY_COMBINING_CIRCUMFLEX
- See Also:
-
KEY_COMBINING_TILDE
- See Also:
-
KEY_COMBINING_MACRON
- See Also:
-
KEY_COMBINING_BREVE
- See Also:
-
KEY_COMBINING_DOT_ABOVE
- See Also:
-
KEY_COMBINING_DIERESIS
- See Also:
-
KEY_COMBINING_RING_ABOVE
- See Also:
-
KEY_COMBINING_DOUBLE_ACUTE
- See Also:
-
KEY_COMBINING_CARON
- See Also:
-
KEY_COMBINING_CEDILLA
- See Also:
-
KEY_COMBINING_OGONEK
- See Also:
-
KEY_COMBINING_IOTA
- See Also:
-
KEY_EURO
- See Also:
-
KEY_VOICED_SOUND
- See Also:
-
KEY_SEMIVOICED_SOUND
- See Also:
-
KEY_F22
- See Also:
-
KEY_F23
- See Also:
-
KEY_F24
- See Also:
-
KEY_FINAL_MODE
- See Also:
-
KEY_FIND
- See Also:
-
KEY_FULL_WIDTH
- See Also:
-
KEY_HALF_WIDTH
- See Also:
-
KEY_HANGUL_MODE
- See Also:
-
KEY_HANJA_MODE
- See Also:
-
KEY_HELP
- See Also:
-
KEY_HIRAGANA
- See Also:
-
KEY_HOME
- See Also:
-
KEY_INSERT
- See Also:
-
KEY_JAPANESE_HIRAGANA
- See Also:
-
KEY_JAPANESE_KATAKANA
- See Also:
-
KEY_JAPANESE_ROMAJI
- See Also:
-
KEY_JUNJA_MODE
- See Also:
-
KEY_KANA_MODE
- See Also:
-
KEY_KANJI_MODE
- See Also:
-
KEY_KATAKANA
- See Also:
-
KEY_LAUNCH_APPLICATION1
- See Also:
-
KEY_LAUNCH_APPLICATION2
- See Also:
-
KEY_LAUNCH_MAIL
- See Also:
-
KEY_LEFT
- See Also:
-
KEY_META
- See Also:
-
KEY_MEDIA_NEXT_TRACK
- See Also:
-
KEY_MEDIA_PLAY_PAUSE
- See Also:
-
KEY_MEDIA_PREVIOUS_TRACK
- See Also:
-
KEY_MEDIA_STOP
- See Also:
-
KEY_MODE_CHANGE
- See Also:
-
KEY_NONCONVERT
- See Also:
-
KEY_NUM_LOCK
- See Also:
-
KEY_PAGE_DOWN
- See Also:
-
KEY_PAGE_UP
- See Also:
-
KEY_PASTE
- See Also:
-
KEY_PAUSE
- See Also:
-
KEY_PLAY
- See Also:
-
KEY_PREVIOUS_CANDIDATE
- See Also:
-
KEY_PRINT_SCREEN
- See Also:
-
KEY_PROCESS
- See Also:
-
KEY_PROPS
- See Also:
-
KEY_RIGHT
- See Also:
-
KEY_ROMAN_CHARACTERS
- See Also:
-
KEY_SCROLL
- See Also:
-
KEY_SELECT
- See Also:
-
KEY_SELECT_MEDIA
- See Also:
-
KEY_SHIFT
- See Also:
-
KEY_STOP
- See Also:
-
KEY_UP
- See Also:
-
KEY_UNDO
- See Also:
-
KEY_VOLUME_DOWN
- See Also:
-
KEY_VOLUME_MUTE
- See Also:
-
KEY_VOLUME_UP
- See Also:
-
KEY_WIN
- See Also:
-
KEY_ZOOM
- See Also:
-
modifierKeys
The modifier keys in effect at the time of the event. -
keyIdentifier
The identifier string for the key. -
keyLocation
protected int keyLocationThe location of the key.
-
-
Constructor Details
-
DOMKeyboardEvent
public DOMKeyboardEvent()
-
-
Method Details
-
getCtrlKey
public boolean getCtrlKey()DOM: Get whether the Control key was pressed at the time of the event.- Specified by:
getCtrlKeyin interfaceKeyboardEvent
-
getShiftKey
public boolean getShiftKey()DOM: Get whether the Shift key was pressed at the time of the event.- Specified by:
getShiftKeyin interfaceKeyboardEvent
-
getAltKey
public boolean getAltKey()DOM: Get whether the Alt key was pressed at the time of the event.- Specified by:
getAltKeyin interfaceKeyboardEvent
-
getMetaKey
public boolean getMetaKey()DOM: Get whether the Meta key was pressed at the time of the event.- Specified by:
getMetaKeyin interfaceKeyboardEvent
-
getKeyIdentifier
DOM: Get the key identifier.- Specified by:
getKeyIdentifierin interfaceKeyboardEvent
-
getKeyLocation
public int getKeyLocation()DOM: Get the key location.- Specified by:
getKeyLocationin interfaceKeyboardEvent
-
getModifierState
DOM: Returns whether the given modifier key was pressed at the time of the event.- Specified by:
getModifierStatein interfaceKeyboardEvent- Parameters:
keyIdentifierArg- A modifier key identifier. Common modifier keys are"Alt","AltGraph","CapsLock","Control","Meta","NumLock","Scroll", or"Shift".Note: If an application wishes to distinguish between right and left modifiers, this information could be deduced using keyboard events and
KeyboardEvent.keyLocation.- Returns:
trueif it is modifier key and the modifier is activated,falseotherwise.
-
initKeyboardEvent
public void initKeyboardEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, String keyIdentifierArg, int keyLocationArg, String modifiersList) DOM: Initializes this KeyboardEvent object.- Specified by:
initKeyboardEventin interfaceKeyboardEvent- 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 theEvent'sAbstractView.keyIdentifierArg- Specifies theEvent'skeyIdentifier.keyLocationArg- Specifies theEvent'skeyLocation.modifiersList- Specifies which modifiers were in effect for thisEvent.
-
initKeyboardEventNS
public void initKeyboardEventNS(String namespaceURIArg, String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, String keyIdentifierArg, int keyLocationArg, String modifiersList) DOM: Initializes this KeyboardEvent object.- Specified by:
initKeyboardEventNSin interfaceKeyboardEvent- Parameters:
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 theEvent'sAbstractView.keyIdentifierArg- Specifies theEvent'skeyIdentifier.keyLocationArg- Specifies theEvent'skeyLocation.modifiersList- Specifies which modifiers were in effect for thisEvent.
-