OracleJavaScript API Reference for Oracle ADF Faces

 

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom.events
Class MouseEvent

org.ecmascript.object.Object
   |
   +--org.w3c.dom.events.Event
         |
         +--org.w3c.dom.events.UIEvent
               |
               +--org.w3c.dom.events.MouseEvent

public abstract class 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.

Introduced in DOM Level 2.

Note that this object is implemented and supported by the web browser and results of its use may vary.



Field Summary

public Boolean
altKey
Used to indicate whether the 'alt' key was depressed during the firing of the event.
public Number
button
During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state.
public Number
clientX
The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.
public Number
clientY
The vertical coordinate at which the event occurred relative to the DOM implementation's client area.
public Boolean
ctrlKey
Used to indicate whether the 'ctrl' key was depressed during the firing of the event.
public Boolean
metaKey
Used to indicate whether the 'meta' key was depressed during the firing of the event.
public EventTarget
relatedTarget
Used to identify a secondary EventTarget related to a UI event.
public Number
screenX
The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
public Number
screenY
The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.
public Boolean
shiftKey
Used to indicate whether the 'shift' key was depressed during the firing of the event.


Fields inherited from org.w3c.dom.events.UIEvent

detail, view


Fields inherited from org.w3c.dom.events.Event

AT_TARGET, bubbles, BUBBLING_PHASE, cancelable, CAPTURING_PHASE, currentTarget, eventPhase, target, timeStamp, type


Fields inherited from org.ecmascript.object.Object

constructor, prototype


Method Summary

public void
initMouseEvent(String typeArg, Boolean canBubbleArg, Boolean cancelableArg, AbstractView viewArg, Number detailArg, Number screenXArg, Number screenYArg, Number clientXArg, Number clientYArg, Boolean ctrlKeyArg, Boolean altKeyArg, Boolean shiftKeyArg, Boolean metaKeyArg, Number buttonArg, EventTarget relatedTargetArg)
The initUIEvent() method is used to initialize the value of a UIEvent created through the DocumentEvent interface.


Methods inherited from org.w3c.dom.events.UIEvent

initUIEvent


Methods inherited from org.w3c.dom.events.Event

initEvent, preventDefault, stopPropagation


Field Detail


altKey

public Boolean altKey

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.

This is a readonly attribute

button

public Number button

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.

This is a readonly attribute

clientX

public Number clientX

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

This is a readonly attribute

clientY

public Number clientY

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

This is a readonly attribute

ctrlKey

public Boolean ctrlKey

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

This is a readonly attribute

metaKey

public Boolean metaKey

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.

This is a readonly attribute

relatedTarget

public EventTarget relatedTarget

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.

This is a readonly attribute

screenX

public Number screenX

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

This is a readonly attribute

screenY

public Number screenY

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

This is a readonly attribute

shiftKey

public Boolean shiftKey

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

This is a readonly attribute

Method Detail


initMouseEvent

public void initMouseEvent(String typeArg,
                           Boolean canBubbleArg,
                           Boolean cancelableArg,
                           AbstractView viewArg,
                           Number detailArg,
                           Number screenXArg,
                           Number screenYArg,
                           Number clientXArg,
                           Number clientYArg,
                           Boolean ctrlKeyArg,
                           Boolean altKeyArg,
                           Boolean shiftKeyArg,
                           Boolean metaKeyArg,
                           Number buttonArg,
                           EventTarget relatedTargetArg)

The initUIEvent() method is used to initialize the value of a UIEvent created through the DocumentEvent interface. This method may only be called before the UIEvent has been dispatched via the {@link EventTarget#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  -  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 coordinate.
screenYArg  -  Specifies the Event's screen y coordinate.
clientXArg  -  Specifies the Event's client x coordinate.
clientYArg  -  Specifies the Event's client y coordinate.
ctrlKeyArg  -  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.
Return:
void - null

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

 

Generated on 2011.08.31 02:41 UTC
Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.