org.w3c.dom.events
Interface MouseEvent
- Event, UIEvent
The
MouseEvent
interface provides specific contextual
information associated with Mouse events.
The
detail
attribute inherited from
UIEvent
indicates the number of times a mouse button has been pressed and
released over the same screen location during a user action. The
attribute 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.
In the case of nested elements mouse events are always targeted at the
most deeply nested element. Ancestors of the targeted element may use
bubbling to obtain notification of mouse events which occur within its
descendent elements.
See also the
Document Object Model (DOM) Level 2 Events Specification.
boolean | getAltKey() - Used to indicate 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 | getClientX() - The horizontal coordinate at which the event occurred relative to the
DOM implementation's client area.
|
int | getClientY() - The vertical coordinate at which the event occurred relative to the DOM
implementation's client area.
|
boolean | getCtrlKey() - Used to indicate whether the 'ctrl' key was depressed during the firing
of the event.
|
boolean | getMetaKey() - Used to indicate whether the 'meta' key was depressed during the firing
of the event.
|
EventTarget | getRelatedTarget() - Used to identify a secondary
EventTarget related to a UI
event.
|
int | getScreenX() - The horizontal coordinate at which the event occurred relative to the
origin of the screen coordinate system.
|
int | getScreenY() - The vertical coordinate at which the event occurred relative to the
origin of the screen coordinate system.
|
boolean | getShiftKey() - Used to indicate whether the 'shift' key was depressed during the
firing of the event.
|
void | initMouseEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, short buttonArg, EventTarget relatedTargetArg) - The
initMouseEvent method is used to initialize the value
of a MouseEvent created through the
DocumentEvent interface.
|
getAltKey
public boolean getAltKey()
Used to indicate 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. The values for button
range from zero to
indicate the left button of the mouse, one to indicate the middle
button if present, and two to indicate the right button. For mice
configured for left handed use in which the button actions are
reversed the values are instead read from right to left.
getClientX
public int getClientX()
The horizontal coordinate at which the event occurred relative to the
DOM implementation's client area.
getClientY
public int getClientY()
The vertical coordinate at which the event occurred relative to the DOM
implementation's client area.
getCtrlKey
public boolean getCtrlKey()
Used to indicate whether the 'ctrl' key was depressed during the firing
of the event.
getMetaKey
public boolean getMetaKey()
Used to indicate whether the 'meta' key was depressed during the firing
of the event. On some platforms this key may map to an alternative
key name.
getRelatedTarget
public EventTarget getRelatedTarget()
Used to identify a secondary EventTarget
related to a UI
event. Currently this attribute is used with the mouseover event to
indicate the EventTarget
which the pointing device
exited and with the mouseout event to indicate the
EventTarget
which the pointing device entered.
getScreenX
public int getScreenX()
The horizontal coordinate at which the event occurred relative to the
origin of the screen coordinate system.
getScreenY
public int getScreenY()
The vertical coordinate at which the event occurred relative to the
origin of the screen coordinate system.
getShiftKey
public boolean getShiftKey()
Used to indicate whether the 'shift' key was depressed during the
firing of the event.
initMouseEvent
public void initMouseEvent(String typeArg,
boolean canBubbleArg,
boolean cancelableArg,
AbstractView viewArg,
int detailArg,
int screenXArg,
int screenYArg,
int clientXArg,
int clientYArg,
boolean ctrlKeyArg,
boolean altKeyArg,
boolean shiftKeyArg,
boolean metaKeyArg,
short buttonArg,
EventTarget relatedTargetArg)
The initMouseEvent
method is used to initialize the value
of a MouseEvent
created through the
DocumentEvent
interface. This method may only be called
before the MouseEvent
has been dispatched via the
dispatchEvent
method, though it may be called multiple
times during that phase if necessary. If called multiple times, the
final invocation takes precedence.
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
.detailArg
- Specifies the Event
's mouse click count.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
.buttonArg
- Specifies the Event
's mouse button.relatedTargetArg
- Specifies the Event
's related
EventTarget
.
* Copyright (c) 2000 World Wide Web Consortium,
* (Massachusetts Institute of Technology, Institut National de
* Recherche en Informatique et en Automatique, Keio University). All
* Rights Reserved. This program is distributed under the W3C's Software
* Intellectual Property License. This program is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY; without even
* the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE.
* See W3C License http://www.w3.org/Consortium/Legal/ for more details.