org.w3c.dom.events
Interface MouseEvent

All Superinterfaces:
Event, UIEvent

public interface MouseEvent
extends 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.

Since:
DOM Level 2

Field Summary
 
Fields inherited from interface org.w3c.dom.events.Event
AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE
 
Method Summary
 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.
 
Methods inherited from interface org.w3c.dom.events.UIEvent
getDetail, getView, initUIEvent
 
Methods inherited from interface org.w3c.dom.events.Event
getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation
 

Method Detail

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.
Since:
JDE 4.6.0

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.
Since:
JDE 4.6.0

getClientX

public int getClientX()
The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.
Since:
JDE 4.6.0

getClientY

public int getClientY()
The vertical coordinate at which the event occurred relative to the DOM implementation's client area.
Since:
JDE 4.6.0

getCtrlKey

public boolean getCtrlKey()
Used to indicate whether the 'ctrl' key was depressed during the firing of the event.
Since:
JDE 4.6.0

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.
Since:
JDE 4.6.0

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.
Since:
JDE 4.6.0

getScreenX

public int getScreenX()
The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
Since:
JDE 4.6.0

getScreenY

public int getScreenY()
The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.
Since:
JDE 4.6.0

getShiftKey

public boolean getShiftKey()
Used to indicate whether the 'shift' key was depressed during the firing of the event.
Since:
JDE 4.6.0

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.
Parameters:
typeArgSpecifies - the event type.
canBubbleArgSpecifies - whether or not the event can bubble.
cancelableArgSpecifies - whether or not the event's default action can be prevented.
viewArgSpecifies - the Event's AbstractView.
detailArgSpecifies - the Event's mouse click count.
screenXArgSpecifies - the Event's screen x coordinate
screenYArgSpecifies - the Event's screen y coordinate
clientXArgSpecifies - the Event's client x coordinate
clientYArgSpecifies - the Event's client y coordinate
ctrlKeyArgSpecifies - whether or not control key was depressed during the Event.
altKeyArgSpecifies - whether or not alt key was depressed during the Event.
shiftKeyArgSpecifies - whether or not shift key was depressed during the Event.
metaKeyArgSpecifies - whether or not meta key was depressed during the Event.
buttonArgSpecifies - the Event's mouse button.
relatedTargetArgSpecifies - the Event's related EventTarget.
Since:
JDE 4.6.0



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.