akasha

Class MouseEvent

java.lang.Object

akasha.core.JsObject

akasha.Event

akasha.UIEvent

akasha.MouseEvent

Direct Known Subclasses:

DragEvent, PointerEvent, WheelEvent

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="MouseEvent")
public class MouseEvent
extends UIEvent

The MouseEvent interface represents events that occur due to the user interacting with a pointing device (such as a mouse). Common events using this interface include click, dblclick, mouseup, mousedown.

See Also:

MouseEvent - MDN, # interface-mouseevent, (CSSOM View) # extensions-to-the-mouseevent-interface, # extensions-to-the-mouseevent-interface

Field Summary

Fields inherited from class akasha.Event

AT_TARGET, BUBBLING_PHASE, cancelBubble, CAPTURING_PHASE, NONE, returnValue

Constructor Summary

Constructors

Constructor and Description
MouseEvent(java.lang.String type) The MouseEvent() constructor creates a new MouseEvent.
MouseEvent(java.lang.String type, MouseEventInit eventInitDict) The MouseEvent() constructor creates a new MouseEvent.

Method Summary

Modifier and Type	Method and Description
boolean	altKey() The MouseEvent.altKey read-only property is a Boolean that indicates whether the alt key was pressed or not when a given mouse event occurs.
short	button() The MouseEvent.button read-only property indicates which button was pressed on the mouse to trigger the event.
int	buttons() The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.
double	clientX() The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).
double	clientY() The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).
boolean	ctrlKey() The MouseEvent.ctrlKey read-only property is a Boolean that indicates whether the ctrl key was pressed or not when a given mouse event occurs.
boolean	getModifierState(java.lang.String keyArg) The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.
boolean	metaKey() The MouseEvent.metaKey read-only property is a Boolean that indicates whether the meta key was pressed or not when a given mouse event occurs.
int	movementX() The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse pointer between the given event and the previous mousemove event.
int	movementY() The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous mousemove event.
double	offsetX() The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.
double	offsetY() The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.
double	pageX() The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document.
double	pageY() The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate in pixels of the event relative to the whole document.
EventTarget	relatedTarget() The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one.
double	screenX() The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in global (screen) coordinates.
double	screenY() The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in global (screen) coordinates.
boolean	shiftKey() The MouseEvent.shiftKey read-only property is a Boolean that indicates whether the shift key was pressed or not when a given mouse event occurs.
double	x() The MouseEvent.x property is an alias for the MouseEvent.clientX property.
double	y() The MouseEvent.y property is an alias for the MouseEvent.clientY property.

Methods inherited from class akasha.UIEvent

detail, view, which

Methods inherited from class akasha.Event

bubbles, cancelable, composed, composedPath, currentTarget, defaultPrevented, eventPhase, initEvent, initEvent, initEvent, isTrusted, preventDefault, srcElement, stopImmediatePropagation, stopPropagation, target, timeStamp, type

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MouseEvent

public MouseEvent(@Nonnull
                  java.lang.String type,
                  @Nonnull
                  MouseEventInit eventInitDict)

The MouseEvent() constructor creates a new MouseEvent.

See Also:

MouseEvent.MouseEvent - MDN, MouseEvent - CSS Object Model (CSSOM) View Module, MouseEvent() - Document Object Model (DOM) Level 3 Events Specification

MouseEvent

public MouseEvent(@Nonnull
                  java.lang.String type)

The MouseEvent() constructor creates a new MouseEvent.

See Also:

MouseEvent.MouseEvent - MDN, MouseEvent - CSS Object Model (CSSOM) View Module, MouseEvent() - Document Object Model (DOM) Level 3 Events Specification

Method Detail

altKey

@JsProperty(name="altKey")
public boolean altKey()

The MouseEvent.altKey read-only property is a Boolean that indicates whether the alt key was pressed or not when a given mouse event occurs.

See Also:

MouseEvent.altKey - MDN, MouseEvent.altkey - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.altkey - Document Object Model (DOM) Level 2 Events Specification

button

@JsProperty(name="button")
public short button()

The MouseEvent.button read-only property indicates which button was pressed on the mouse to trigger the event.

See Also:

MouseEvent.button - MDN, MouseEvent.button - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.button - Document Object Model (DOM) Level 2 Events Specification

buttons

@JsProperty(name="buttons")
public int buttons()

The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.

See Also:

MouseEvent.buttons - MDN, MouseEvent.buttons - UI Events, MouseEvent.buttons - Document Object Model (DOM) Level 3 Events Specification

clientX

@JsProperty(name="clientX")
public double clientX()

The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

See Also:

MouseEvent.clientX - MDN, clientX - CSS Object Model (CSSOM) View Module, MouseEvent.clientX - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.clientX - Document Object Model (DOM) Level 2 Events Specification

clientY

@JsProperty(name="clientY")
public double clientY()

The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

See Also:

MouseEvent.clientY - MDN, clientY - CSS Object Model (CSSOM) View Module, MouseEvent.clientY - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.clientY - Document Object Model (DOM) Level 2 Events Specification

ctrlKey

@JsProperty(name="ctrlKey")
public boolean ctrlKey()

The MouseEvent.ctrlKey read-only property is a Boolean that indicates whether the ctrl key was pressed or not when a given mouse event occurs.

See Also:

MouseEvent.ctrlKey - MDN, MouseEvent.ctrlKey - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.ctrlKey - Document Object Model (DOM) Level 2 Events Specification

metaKey

@JsProperty(name="metaKey")
public boolean metaKey()

The MouseEvent.metaKey read-only property is a Boolean that indicates whether the meta key was pressed or not when a given mouse event occurs.

See Also:

MouseEvent.metaKey - MDN, MouseEvent.metaKey - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.metaKey - Document Object Model (DOM) Level 2 Events Specification

movementX

@JsProperty(name="movementX")
public int movementX()

The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse pointer between the given event and the previous mousemove event. In other words, the value of the property is computed like this: currentEvent.movementX = currentEvent.screenX - previousEvent.screenX.

See Also:

MouseEvent.movementX - MDN, MouseEvent.movementX - Pointer Lock

movementY

@JsProperty(name="movementY")
public int movementY()

The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous mousemove event. In other words, the value of the property is computed like this: currentEvent.movementY = currentEvent.screenY - previousEvent.screenY.

See Also:

MouseEvent.movementY - MDN, MouseEvent.movementY - Pointer Lock

offsetX

@JsProperty(name="offsetX")
public double offsetX()

The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.

See Also:

MouseEvent.offsetX - MDN, MouseEvent - CSS Object Model (CSSOM) View Module

offsetY

@JsProperty(name="offsetY")
public double offsetY()

The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.

See Also:

MouseEvent.offsetY - MDN, MouseEvent - CSS Object Model (CSSOM) View Module

pageX

@JsProperty(name="pageX")
public double pageX()

The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document.

See Also:

MouseEvent.pageX - MDN, pageX - CSS Object Model (CSSOM) View Module, pageX - Touch Events

pageY

@JsProperty(name="pageY")
public double pageY()

The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate in pixels of the event relative to the whole document. This property takes into account any vertical scrolling of the page.

See Also:

MouseEvent.pageY - MDN, pageY - CSS Object Model (CSSOM) View Module, pageY - Touch Events

relatedTarget

@JsProperty(name="relatedTarget")
 @Nullable
public EventTarget relatedTarget()

The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one. That is:

See Also:

MouseEvent.relatedTarget - MDN, MouseEvent.relatedTarget - UI Events, MouseEvent.relatedTarget - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.altkey - Document Object Model (DOM) Level 2 Events Specification

screenX

@JsProperty(name="screenX")
public double screenX()

The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in global (screen) coordinates.

See Also:

MouseEvent.screenX - MDN, screenX - CSS Object Model (CSSOM) View Module, MouseEvent.screenX - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.sceenX - Document Object Model (DOM) Level 2 Events Specification

screenY

@JsProperty(name="screenY")
public double screenY()

The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in global (screen) coordinates.

See Also:

MouseEvent.screenY - MDN, screenY - CSS Object Model (CSSOM) View Module, MouseEvent.screenY - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.sceenY - Document Object Model (DOM) Level 2 Events Specification

shiftKey

@JsProperty(name="shiftKey")
public boolean shiftKey()

The MouseEvent.shiftKey read-only property is a Boolean that indicates whether the shift key was pressed or not when a given mouse event occurs.

See Also:

MouseEvent.shiftKey - MDN, MouseEvent.shiftKey - Document Object Model (DOM) Level 3 Events Specification, MouseEvent.shiftKey - Document Object Model (DOM) Level 2 Events Specification

x

@JsProperty(name="x")
public double x()

The MouseEvent.x property is an alias for the MouseEvent.clientX property.

See Also:

MouseEvent.x - MDN, MouseEvent.x - CSS Object Model (CSSOM) View Module

y

@JsProperty(name="y")
public double y()

The MouseEvent.y property is an alias for the MouseEvent.clientY property.

See Also:

MouseEvent.y - MDN, MouseEvent.y - CSS Object Model (CSSOM) View Module

getModifierState

public boolean getModifierState(@Nonnull
                                java.lang.String keyArg)

The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.

See Also:

MouseEvent.getModifierState - MDN, getModifierState() - Document Object Model (DOM) Level 3 Events Specification