elemental.events

Interface MouseEvent

All Superinterfaces:

Event, UIEvent

All Known Implementing Classes:

JsMouseEvent

public interface MouseEvent
extends UIEvent

The DOM MouseEvent represents events that occur due to the user interacting with a pointing device (such as a mouse). It's represented by the nsINSDOMMouseEvent interface, which extends the nsIDOMMouseEvent interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MouseEvent.Button Contains the set of standard values returned by #button.

Field Summary

Fields inherited from interface elemental.events.Event

AT_TARGET, BEFORECOPY, BEFORECUT, BEFOREPASTE, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTEXTMENU, COPY, CUT, DBLCLICK, DRAG, DRAGEND, DRAGENTER, DRAGLEAVE, DRAGOVER, DRAGSTART, DROP, ERROR, FOCUS, FOCUSIN, FOCUSOUT, INPUT, INVALID, KEYDOWN, KEYPRESS, KEYUP, MOUSEDOWN, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, MOUSEWHEEL, NONE, PASTE, RESIZE, SCROLL, SELECTSTART, SUBMIT, TOUCHCANCEL, TOUCHEND, TOUCHMOVE, TOUCHSTART, WEBKITANIMATIONEND, WEBKITANIMATIONITERATION, WEBKITANIMATIONSTART, WEBKITTRANSITIONEND

Method Summary

Methods

Modifier and Type	Method and Description
int	getButton() The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2.
int	getClientX() The X coordinate of the mouse pointer in local (DOM content) coordinates.
int	getClientY() The Y coordinate of the mouse pointer in local (DOM content) coordinates.
Clipboard	getDataTransfer()
Node	getFromElement()
int	getOffsetX()
int	getOffsetY()
EventTarget	getRelatedTarget() The target to which the event applies.
int	getScreenX() The X coordinate of the mouse pointer in global (screen) coordinates.
int	getScreenY() The Y coordinate of the mouse pointer in global (screen) coordinates.
Node	getToElement()
int	getWebkitMovementX()
int	getWebkitMovementY()
int	getX()
int	getY()
void	initMouseEvent(String type, boolean canBubble, boolean cancelable, Window view, int detail, int screenX, int screenY, int clientX, int clientY, boolean ctrlKey, boolean altKey, boolean shiftKey, boolean metaKey, int button, EventTarget relatedTarget)
boolean	isAltKey() true if the alt key was down when the mouse event was fired.
boolean	isCtrlKey() true if the control key was down when the mouse event was fired.
boolean	isMetaKey() true if the meta key was down when the mouse event was fired.
boolean	isShiftKey() true if the shift key was down when the mouse event was fired.

Methods inherited from interface elemental.events.UIEvent

getCharCode, getDetail, getKeyCode, getLayerX, getLayerY, getPageX, getPageY, getView, getWhich, initUIEvent

Methods inherited from interface elemental.events.Event

getClipboardData, getCurrentTarget, getEventPhase, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isBubbles, isCancelable, isCancelBubble, isDefaultPrevented, isReturnValue, preventDefault, setCancelBubble, setReturnValue, stopImmediatePropagation, stopPropagation

Method Detail

isAltKey

boolean isAltKey()

true if the alt key was down when the mouse event was fired. Read only.

getButton

int getButton()

The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left. Read only.

getClientX

int getClientX()

The X coordinate of the mouse pointer in local (DOM content) coordinates. Read only.

getClientY

int getClientY()

The Y coordinate of the mouse pointer in local (DOM content) coordinates. Read only.

isCtrlKey

boolean isCtrlKey()

true if the control key was down when the mouse event was fired. Read only.

getDataTransfer

Clipboard getDataTransfer()

getFromElement

Node getFromElement()

isMetaKey

boolean isMetaKey()

true if the meta key was down when the mouse event was fired. Read only.

getOffsetX

int getOffsetX()

getOffsetY

int getOffsetY()

getRelatedTarget

EventTarget getRelatedTarget()

The target to which the event applies. Read only.

getScreenX

int getScreenX()

The X coordinate of the mouse pointer in global (screen) coordinates. Read only.

getScreenY

int getScreenY()

The Y coordinate of the mouse pointer in global (screen) coordinates. Read only.

isShiftKey

boolean isShiftKey()

true if the shift key was down when the mouse event was fired. Read only.

getToElement

Node getToElement()

getWebkitMovementX

int getWebkitMovementX()

getWebkitMovementY

int getWebkitMovementY()

getX

int getX()

getY

int getY()

initMouseEvent

void initMouseEvent(String type,
                  boolean canBubble,
                  boolean cancelable,
                  Window view,
                  int detail,
                  int screenX,
                  int screenY,
                  int clientX,
                  int clientY,
                  boolean ctrlKey,
                  boolean altKey,
                  boolean shiftKey,
                  boolean metaKey,
                  int button,
                  EventTarget relatedTarget)