org.apache.xerces.domx.events
Interface UIEvent
- public interface UIEvent
- extends Event
The UIEvent
interface provides specific contextual
information associated with User Interface events. The values for the
keyCode constants are yet to be determined.
Method Summary |
boolean |
getAltKey()
altKey indicates whether the 'alt' key was depressed during
the firing of the event. |
short |
getButton()
During mouse events caused by the depression or release of a mouse
button, button is used to indicate which mouse button
changed state. |
int |
getCharCode()
charCode holds the value of the Unicode character
associated with the depressed key if the event is a key event. |
short |
getClickCount()
The clickCount property indicates the number of times a
mouse button has been pressed and released over the same screen location
during a user action. |
int |
getClientX()
clientX indicates the horizontal coordinate at which the
event occurred relative to the DOM implementation's client area. |
int |
getClientY()
clientY indicates the vertical coordinate at which the
event occurred relative to the DOM implementation's client area. |
boolean |
getCtrlKey()
ctrlKey indicates whether the 'ctrl' key was depressed
during the firing of the event. |
int |
getKeyCode()
The value of keyCode holds the virtual key code value of
the key which was depressed if the event is a key event. |
boolean |
getMetaKey()
metaKey indicates whether the 'meta' key was depressed
during the firing of the event. |
Node |
getRelatedNode()
relatedNode is used to identify a secondary node related to
a UI event. |
int |
getScreenX()
screenX indicates the horizontal coordinate at which the
event occurred in relative to the origin of the screen coordinate system. |
int |
getScreenY()
screenY indicates the vertical coordinate at which the
event occurred relative to the origin of the screen coordinate system. |
boolean |
getShiftKey()
shiftKey indicates whether the 'shift' key was depressed
during the firing of the event. |
void |
initUIEvent(java.lang.String typeArg,
boolean canBubbleArg,
boolean cancelableArg,
int screenXArg,
int screenYArg,
int clientXArg,
int clientYArg,
boolean ctrlKeyArg,
boolean altKeyArg,
boolean shiftKeyArg,
boolean metaKeyArg,
int keyCodeArg,
int charCodeArg,
short buttonArg,
short clickCountArg,
Node relatedNodeArg)
|
void |
setAltKey(boolean altKey)
|
void |
setButton(short button)
|
void |
setCharCode(int charCode)
|
void |
setClickCount(short clickCount)
|
void |
setClientX(int clientX)
|
void |
setClientY(int clientY)
|
void |
setCtrlKey(boolean ctrlKey)
|
void |
setKeyCode(int keyCode)
|
void |
setMetaKey(boolean metaKey)
|
void |
setRelatedNode(Node relatedNode)
|
void |
setScreenX(int screenX)
|
void |
setScreenY(int screenY)
|
void |
setShiftKey(boolean shiftKey)
|
CHAR_UNDEFINED
public static final int CHAR_UNDEFINED
KEY_FIRST
public static final int KEY_FIRST
KEY_LAST
public static final int KEY_LAST
VK_0
public static final int VK_0
VK_1
public static final int VK_1
VK_2
public static final int VK_2
VK_3
public static final int VK_3
VK_4
public static final int VK_4
VK_5
public static final int VK_5
VK_6
public static final int VK_6
VK_7
public static final int VK_7
VK_8
public static final int VK_8
VK_9
public static final int VK_9
VK_A
public static final int VK_A
VK_ACCEPT
public static final int VK_ACCEPT
VK_ADD
public static final int VK_ADD
VK_AGAIN
public static final int VK_AGAIN
VK_ALL_CANDIDATES
public static final int VK_ALL_CANDIDATES
VK_ALPHANUMERIC
public static final int VK_ALPHANUMERIC
VK_ALT
public static final int VK_ALT
VK_ALT_GRAPH
public static final int VK_ALT_GRAPH
VK_AMPERSAND
public static final int VK_AMPERSAND
VK_ASTERISK
public static final int VK_ASTERISK
VK_AT
public static final int VK_AT
VK_B
public static final int VK_B
VK_BACK_QUOTE
public static final int VK_BACK_QUOTE
VK_BACK_SLASH
public static final int VK_BACK_SLASH
VK_BACK_SPACE
public static final int VK_BACK_SPACE
VK_BRACELEFT
public static final int VK_BRACELEFT
VK_BRACERIGHT
public static final int VK_BRACERIGHT
VK_C
public static final int VK_C
VK_CANCEL
public static final int VK_CANCEL
VK_CAPS_LOCK
public static final int VK_CAPS_LOCK
VK_CIRCUMFLEX
public static final int VK_CIRCUMFLEX
VK_CLEAR
public static final int VK_CLEAR
VK_CLOSE_BRACKET
public static final int VK_CLOSE_BRACKET
VK_CODE_INPUT
public static final int VK_CODE_INPUT
VK_COLON
public static final int VK_COLON
VK_COMMA
public static final int VK_COMMA
VK_COMPOSE
public static final int VK_COMPOSE
VK_CONTROL
public static final int VK_CONTROL
VK_CONVERT
public static final int VK_CONVERT
VK_COPY
public static final int VK_COPY
VK_CUT
public static final int VK_CUT
VK_D
public static final int VK_D
VK_DEAD_ABOVEDOT
public static final int VK_DEAD_ABOVEDOT
VK_DEAD_ABOVERING
public static final int VK_DEAD_ABOVERING
VK_DEAD_ACUTE
public static final int VK_DEAD_ACUTE
VK_DEAD_BREVE
public static final int VK_DEAD_BREVE
VK_DEAD_CARON
public static final int VK_DEAD_CARON
VK_DEAD_CEDILLA
public static final int VK_DEAD_CEDILLA
VK_DEAD_CIRCUMFLEX
public static final int VK_DEAD_CIRCUMFLEX
VK_DEAD_DIAERESIS
public static final int VK_DEAD_DIAERESIS
VK_DEAD_DOUBLEACUTE
public static final int VK_DEAD_DOUBLEACUTE
VK_DEAD_GRAVE
public static final int VK_DEAD_GRAVE
VK_DEAD_IOTA
public static final int VK_DEAD_IOTA
VK_DEAD_MACRON
public static final int VK_DEAD_MACRON
VK_DEAD_OGONEK
public static final int VK_DEAD_OGONEK
VK_DEAD_SEMIVOICED_SOUND
public static final int VK_DEAD_SEMIVOICED_SOUND
VK_DEAD_TILDE
public static final int VK_DEAD_TILDE
VK_DEAD_VOICED_SOUND
public static final int VK_DEAD_VOICED_SOUND
VK_DECIMAL
public static final int VK_DECIMAL
VK_DELETE
public static final int VK_DELETE
VK_DIVIDE
public static final int VK_DIVIDE
VK_DOLLAR
public static final int VK_DOLLAR
VK_DOWN
public static final int VK_DOWN
VK_E
public static final int VK_E
VK_END
public static final int VK_END
VK_ENTER
public static final int VK_ENTER
VK_EQUALS
public static final int VK_EQUALS
VK_ESCAPE
public static final int VK_ESCAPE
VK_EURO_SIGN
public static final int VK_EURO_SIGN
VK_EXCLAMATION_MARK
public static final int VK_EXCLAMATION_MARK
VK_F
public static final int VK_F
VK_F1
public static final int VK_F1
VK_F10
public static final int VK_F10
VK_F11
public static final int VK_F11
VK_F12
public static final int VK_F12
VK_F13
public static final int VK_F13
VK_F14
public static final int VK_F14
VK_F15
public static final int VK_F15
VK_F16
public static final int VK_F16
VK_F17
public static final int VK_F17
VK_F18
public static final int VK_F18
VK_F19
public static final int VK_F19
VK_F2
public static final int VK_F2
VK_F20
public static final int VK_F20
VK_F21
public static final int VK_F21
VK_F22
public static final int VK_F22
VK_F23
public static final int VK_F23
VK_F24
public static final int VK_F24
VK_F3
public static final int VK_F3
VK_F4
public static final int VK_F4
VK_F5
public static final int VK_F5
VK_F6
public static final int VK_F6
VK_F7
public static final int VK_F7
VK_F8
public static final int VK_F8
VK_F9
public static final int VK_F9
VK_FINAL
public static final int VK_FINAL
VK_FIND
public static final int VK_FIND
VK_FULL_WIDTH
public static final int VK_FULL_WIDTH
VK_G
public static final int VK_G
VK_GREATER
public static final int VK_GREATER
VK_H
public static final int VK_H
VK_HALF_WIDTH
public static final int VK_HALF_WIDTH
VK_HELP
public static final int VK_HELP
VK_HIRAGANA
public static final int VK_HIRAGANA
VK_HOME
public static final int VK_HOME
VK_I
public static final int VK_I
VK_INSERT
public static final int VK_INSERT
VK_INVERTED_EXCLAMATION_MARK
public static final int VK_INVERTED_EXCLAMATION_MARK
VK_J
public static final int VK_J
VK_JAPANESE_HIRAGANA
public static final int VK_JAPANESE_HIRAGANA
VK_JAPANESE_KATAKANA
public static final int VK_JAPANESE_KATAKANA
VK_JAPANESE_ROMAN
public static final int VK_JAPANESE_ROMAN
VK_K
public static final int VK_K
VK_KANA
public static final int VK_KANA
VK_KANJI
public static final int VK_KANJI
VK_KATAKANA
public static final int VK_KATAKANA
VK_KP_DOWN
public static final int VK_KP_DOWN
VK_KP_LEFT
public static final int VK_KP_LEFT
VK_KP_RIGHT
public static final int VK_KP_RIGHT
VK_KP_UP
public static final int VK_KP_UP
VK_L
public static final int VK_L
VK_LEFT
public static final int VK_LEFT
VK_LEFT_PARENTHESIS
public static final int VK_LEFT_PARENTHESIS
VK_LESS
public static final int VK_LESS
VK_M
public static final int VK_M
VK_META
public static final int VK_META
VK_MINUS
public static final int VK_MINUS
VK_MODECHANGE
public static final int VK_MODECHANGE
VK_MULTIPLY
public static final int VK_MULTIPLY
VK_N
public static final int VK_N
VK_NONCONVERT
public static final int VK_NONCONVERT
VK_NUM_LOCK
public static final int VK_NUM_LOCK
VK_NUMBER_SIGN
public static final int VK_NUMBER_SIGN
VK_NUMPAD0
public static final int VK_NUMPAD0
VK_NUMPAD1
public static final int VK_NUMPAD1
VK_NUMPAD2
public static final int VK_NUMPAD2
VK_NUMPAD3
public static final int VK_NUMPAD3
VK_NUMPAD4
public static final int VK_NUMPAD4
VK_NUMPAD5
public static final int VK_NUMPAD5
VK_NUMPAD6
public static final int VK_NUMPAD6
VK_NUMPAD7
public static final int VK_NUMPAD7
VK_NUMPAD8
public static final int VK_NUMPAD8
VK_NUMPAD9
public static final int VK_NUMPAD9
VK_O
public static final int VK_O
VK_OPEN_BRACKET
public static final int VK_OPEN_BRACKET
VK_P
public static final int VK_P
VK_PAGE_DOWN
public static final int VK_PAGE_DOWN
VK_PAGE_UP
public static final int VK_PAGE_UP
VK_PASTE
public static final int VK_PASTE
VK_PAUSE
public static final int VK_PAUSE
VK_PERIOD
public static final int VK_PERIOD
VK_PLUS
public static final int VK_PLUS
VK_PREVIOUS_CANDIDATE
public static final int VK_PREVIOUS_CANDIDATE
VK_PRINTSCREEN
public static final int VK_PRINTSCREEN
VK_PROPS
public static final int VK_PROPS
VK_Q
public static final int VK_Q
VK_QUOTE
public static final int VK_QUOTE
VK_QUOTEDBL
public static final int VK_QUOTEDBL
VK_R
public static final int VK_R
VK_RIGHT
public static final int VK_RIGHT
VK_RIGHT_PARENTHESIS
public static final int VK_RIGHT_PARENTHESIS
VK_ROMAN_CHARACTERS
public static final int VK_ROMAN_CHARACTERS
VK_S
public static final int VK_S
VK_SCROLL_LOCK
public static final int VK_SCROLL_LOCK
VK_SEMICOLON
public static final int VK_SEMICOLON
VK_SEPARATER
public static final int VK_SEPARATER
VK_SHIFT
public static final int VK_SHIFT
VK_SLASH
public static final int VK_SLASH
VK_SPACE
public static final int VK_SPACE
VK_STOP
public static final int VK_STOP
VK_SUBTRACT
public static final int VK_SUBTRACT
VK_T
public static final int VK_T
VK_TAB
public static final int VK_TAB
VK_U
public static final int VK_U
VK_UNDEFINED
public static final int VK_UNDEFINED
VK_UNDERSCORE
public static final int VK_UNDERSCORE
VK_UNDO
public static final int VK_UNDO
VK_UP
public static final int VK_UP
VK_V
public static final int VK_V
VK_W
public static final int VK_W
VK_X
public static final int VK_X
VK_Y
public static final int VK_Y
VK_Z
public static final int VK_Z
getAltKey
public boolean getAltKey()
altKey
indicates whether the 'alt' key was depressed during
the firing of the event. On some platforms this key may map to an
alternative key name.
getButton
public short getButton()
- During mouse events caused by the depression or release of a mouse
button,
button
is used to indicate which mouse button
changed state.
getCharCode
public int getCharCode()
charCode
holds the value of the Unicode character
associated with the depressed key if the event is a key event.
Otherwise, the value is zero.
getClickCount
public short getClickCount()
- The
clickCount
property indicates the number of times a
mouse button has been pressed and released over the same screen location
during a user action. The property value is 1 when the user begins this
action and increments by 1 for each full sequence of pressing and
releasing. If the user moves the mouse between the mousedown and mouseup
the value will be set to 0, indicating that no click is occurring.
getClientX
public int getClientX()
clientX
indicates the horizontal coordinate at which the
event occurred relative to the DOM implementation's client area.
getClientY
public int getClientY()
clientY
indicates the vertical coordinate at which the
event occurred relative to the DOM implementation's client area.
getCtrlKey
public boolean getCtrlKey()
ctrlKey
indicates whether the 'ctrl' key was depressed
during the firing of the event.
getKeyCode
public int getKeyCode()
- The value of
keyCode
holds the virtual key code value of
the key which was depressed if the event is a key event. Otherwise, the
value is zero.
getMetaKey
public boolean getMetaKey()
metaKey
indicates whether the 'meta' key was depressed
during the firing of the event. On some platforms this key may map to
an alternative key name.
getRelatedNode
public Node getRelatedNode()
relatedNode
is used to identify a secondary node related to
a UI event.
getScreenX
public int getScreenX()
screenX
indicates the horizontal coordinate at which the
event occurred in relative to the origin of the screen coordinate system.
getScreenY
public int getScreenY()
screenY
indicates the vertical coordinate at which the
event occurred relative to the origin of the screen coordinate system.
getShiftKey
public boolean getShiftKey()
shiftKey
indicates whether the 'shift' key was depressed
during the firing of the event.
initUIEvent
public void initUIEvent(java.lang.String typeArg,
boolean canBubbleArg,
boolean cancelableArg,
int screenXArg,
int screenYArg,
int clientXArg,
int clientYArg,
boolean ctrlKeyArg,
boolean altKeyArg,
boolean shiftKeyArg,
boolean metaKeyArg,
int keyCodeArg,
int charCodeArg,
short buttonArg,
short clickCountArg,
Node relatedNodeArg)
- 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.screenXArg
- Specifies the Event
's screen x coordinatescreenYArg
- Specifies the Event
's screen y coordinateclientXArg
- Specifies the Event
's client x coordinateclientYArg
- Specifies the Event
's client y coordinatectrlKeyArg
- 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
buttonArg
- Specifies the Event
's mouse button.clickCountArg
- Specifies the Event
's mouse click count.relatedNodeArg
- Specifies the Event
's related Node.
setAltKey
public void setAltKey(boolean altKey)
setButton
public void setButton(short button)
setCharCode
public void setCharCode(int charCode)
setClickCount
public void setClickCount(short clickCount)
setClientX
public void setClientX(int clientX)
setClientY
public void setClientY(int clientY)
setCtrlKey
public void setCtrlKey(boolean ctrlKey)
setKeyCode
public void setKeyCode(int keyCode)
setMetaKey
public void setMetaKey(boolean metaKey)
setRelatedNode
public void setRelatedNode(Node relatedNode)
setScreenX
public void setScreenX(int screenX)
setScreenY
public void setScreenY(int screenY)
setShiftKey
public void setShiftKey(boolean shiftKey)