APIdia Launch Partner
Top Description Methods
org.w3c.dom.events

public Interface MouseEvent

extends UIEvent
Imports
org.w3c.dom.views.AbstractView
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
1.5, DOM Level 2

Method Summary

Modifier and TypeMethod and Description
public boolean
getAltKey()

Used to indicate whether the 'alt' key was depressed during the firing of the event.

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.

public int
getClientX()

The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.

public int
getClientY()

The vertical coordinate at which the event occurred relative to the DOM implementation's client area.

public boolean
getCtrlKey()

Used to indicate whether the 'ctrl' key was depressed during the firing of the event.

public boolean
getMetaKey()

Used to indicate whether the 'meta' key was depressed during the firing of the event.

public EventTarget
getRelatedTarget()

Used to identify a secondary EventTarget related to a UI event.

public int
getScreenX()

The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.

public int
getScreenY()

The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

public boolean
getShiftKey()

Used to indicate whether the 'shift' key was depressed during the firing of the event.

public void
initMouseEvent(String
Specifies the event type.
typeArg, boolean
Specifies whether or not the event can bubble.
canBubbleArg, boolean
Specifies whether or not the event's default action can be prevented.
cancelableArg, AbstractView
Specifies the Event's AbstractView.
viewArg, int
Specifies the Event's mouse click count.
detailArg, int
Specifies the Event's screen x coordinate
screenXArg, int
Specifies the Event's screen y coordinate
screenYArg, int
Specifies the Event's client x coordinate
clientXArg, int
Specifies the Event's client y coordinate
clientYArg, boolean
Specifies whether or not control key was depressed during the Event.
ctrlKeyArg, boolean
Specifies whether or not alt key was depressed during the Event.
altKeyArg, boolean
Specifies whether or not shift key was depressed during the Event.
shiftKeyArg, boolean
Specifies whether or not meta key was depressed during the Event.
metaKeyArg, short
Specifies the Event's mouse button.
buttonArg, EventTarget
Specifies the Event's related EventTarget.
relatedTargetArg)

The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface.

Inherited from org.w3c.dom.events.UIEvent:
getDetailgetViewinitUIEvent

Method Detail

getAltKeyback to summary
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.

getButtonback to summary
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.

getClientXback to summary
public int getClientX()

The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.

getClientYback to summary
public int getClientY()

The vertical coordinate at which the event occurred relative to the DOM implementation's client area.

getCtrlKeyback to summary
public boolean getCtrlKey()

Used to indicate whether the 'ctrl' key was depressed during the firing of the event.

getMetaKeyback to summary
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.

getRelatedTargetback to summary
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.

getScreenXback to summary
public int getScreenX()

The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.

getScreenYback to summary
public int getScreenY()

The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

getShiftKeyback to summary
public boolean getShiftKey()

Used to indicate whether the 'shift' key was depressed during the firing of the event.

initMouseEventback to summary
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
typeArg:String

Specifies the event type.

canBubbleArg:boolean

Specifies whether or not the event can bubble.

cancelableArg:boolean

Specifies whether or not the event's default action can be prevented.

viewArg:AbstractView

Specifies the Event's AbstractView.

detailArg:int

Specifies the Event's mouse click count.

screenXArg:int

Specifies the Event's screen x coordinate

screenYArg:int

Specifies the Event's screen y coordinate

clientXArg:int

Specifies the Event's client x coordinate

clientYArg:int

Specifies the Event's client y coordinate

ctrlKeyArg:boolean

Specifies whether or not control key was depressed during the Event.

altKeyArg:boolean

Specifies whether or not alt key was depressed during the Event.

shiftKeyArg:boolean

Specifies whether or not shift key was depressed during the Event.

metaKeyArg:boolean

Specifies whether or not meta key was depressed during the Event.

buttonArg:short

Specifies the Event's mouse button.

relatedTargetArg:EventTarget

Specifies the Event's related EventTarget.