MouseEvent

class MouseEvent extends UIEvent

Annotations: @Native.new("MouseEvent,DragEvent")

Inheritance

Object → Event → UIEvent → MouseEvent

Implementers

• PointerEvent
• WheelEvent

Constructors

MouseEvent() factory

factory MouseEvent(
  String type, {
  Window? view,
  int detail = 0,
  int screenX = 0,
  int screenY = 0,
  int clientX = 0,
  int clientY = 0,
  int button = 0,
  bool canBubble = true,
  bool cancelable = true,
  bool ctrlKey = false,
  bool altKey = false,
  bool shiftKey = false,
  bool metaKey = false,
  EventTarget? relatedTarget,
})

Implementation

factory MouseEvent(
  String type, {
  Window? view,
  int detail = 0,
  int screenX = 0,
  int screenY = 0,
  int clientX = 0,
  int clientY = 0,
  int button = 0,
  bool canBubble = true,
  bool cancelable = true,
  bool ctrlKey = false,
  bool altKey = false,
  bool shiftKey = false,
  bool metaKey = false,
  EventTarget? relatedTarget,
}) {
  if (view == null) {
    view = window;
  }
  MouseEvent event = document._createEvent('MouseEvent') as MouseEvent;
  event._initMouseEvent(
    type,
    canBubble,
    cancelable,
    view,
    detail,
    screenX,
    screenY,
    clientX,
    clientY,
    ctrlKey,
    altKey,
    shiftKey,
    metaKey,
    button,
    relatedTarget,
  );
  return event;
}

Properties

altKey no setter

bool get altKey

Implementation

bool get altKey native;

bubbles no setter inherited

bool? get bubbles

Inherited from Event.

Implementation

bool? get bubbles native;

button no setter

int get button

Implementation

int get button native;

buttons no setter

int? get buttons

Implementation

int? get buttons native;

cancelable no setter inherited

bool? get cancelable

Inherited from Event.

Implementation

bool? get cancelable native;

client no setter

Point<num> get client

Implementation

Point get client => new Point(_clientX, _clientY);

composed no setter inherited

bool? get composed

Inherited from Event.

Implementation

bool? get composed native;

ctrlKey no setter

bool get ctrlKey

Implementation

bool get ctrlKey native;

currentTarget no setter inherited

EventTarget? get currentTarget

Inherited from Event.

Implementation

EventTarget? get currentTarget =>
    _convertNativeToDart_EventTarget(this._get_currentTarget);

dataTransfer no setter

DataTransfer get dataTransfer

Implementation

DataTransfer get dataTransfer =>
    JS('DataTransfer', "#['dataTransfer']", this);

defaultPrevented no setter inherited

bool get defaultPrevented

Inherited from Event.

Implementation

bool get defaultPrevented native;

detail no setter inherited

int? get detail

Inherited from UIEvent.

Implementation

int? get detail native;

eventPhase no setter inherited

int get eventPhase

Inherited from Event.

Implementation

int get eventPhase native;

deprecated fromElement no setter

Node? get fromElement

DEPRECATED

The nonstandard way to access the element that the mouse comes from in the case of a mouseover event.

This member is deprecated and not cross-browser compatible; use relatedTarget to get the same information in the standard way.

Implementation

@deprecated
Node? get fromElement native;

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

Implementation

int get hashCode => Primitives.objectHashCode(this);

isTrusted no setter inherited

bool? get isTrusted

Inherited from Event.

Implementation

bool? get isTrusted native;

layer no setter

Point<num> get layer

Implementation

Point get layer => new Point(_layerX!, _layerY!);

matchingTarget no setter inherited

Element get matchingTarget

A pointer to the element whose CSS selector matched within which an event was fired. If this Event was not associated with any Event delegation, accessing this value will throw an UnsupportedError.

Inherited from Event.

Implementation

Element get matchingTarget {
  if (_selector == null) {
    throw new UnsupportedError(
      'Cannot call matchingTarget if this Event did'
      ' not arise as a result of event delegation.',
    );
  }
  Element? currentTarget = this.currentTarget as Element?;
  Element? target = this.target as Element?;
  var matchedTarget;
  do {
    if (target!.matches(_selector!)) return target;
    target = target.parent;
  } while (target != null && target != currentTarget!.parent);
  throw new StateError('No selector matched for populating matchedTarget.');
}

metaKey no setter

bool get metaKey

Implementation

bool get metaKey native;

movement no setter

Point<num> get movement

Implementation

@SupportedBrowser(SupportedBrowser.CHROME)
@SupportedBrowser(SupportedBrowser.FIREFOX)
Point get movement => new Point(_movementX!, _movementY!);

offset no setter

Point<num> get offset

The coordinates of the mouse pointer in target node coordinates.

This value may vary between platforms if the target node moves after the event has fired or if the element has CSS transforms affecting it.

Implementation

Point get offset {
  if (JS('bool', '!!#.offsetX', this)) {
    var x = JS('int', '#.offsetX', this);
    var y = JS('int', '#.offsetY', this);
    return new Point(x as num, y as num);
  } else {
    // Firefox does not support offsetX.
    if (!(this.target is Element)) {
      throw new UnsupportedError('offsetX is only supported on elements');
    }
    Element target = this.target as Element;
    var point = (this.client - target.getBoundingClientRect().topLeft);
    return new Point(point.x.toInt(), point.y.toInt());
  }
}

page no setter

Point<num> get page

Implementation

Point get page => new Point(_pageX!, _pageY!);

path no setter inherited

List<EventTarget> get path

Inherited from Event.

Implementation

List<EventTarget> get path =>
    JS<bool>('bool', '!!#.composedPath', this) ? composedPath() : [];

region no setter

String? get region

Implementation

String? get region native;

relatedTarget no setter

EventTarget? get relatedTarget

Implementation

EventTarget? get relatedTarget =>
    _convertNativeToDart_EventTarget(this._get_relatedTarget);

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

Implementation

Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

screen no setter

Point<num> get screen

Implementation

Point get screen => new Point(_screenX, _screenY);

shiftKey no setter

bool get shiftKey

Implementation

bool get shiftKey native;

sourceCapabilities no setter inherited

InputDeviceCapabilities? get sourceCapabilities

Inherited from UIEvent.

Implementation

InputDeviceCapabilities? get sourceCapabilities native;

target no setter inherited

EventTarget? get target

Inherited from Event.

Implementation

EventTarget? get target => _convertNativeToDart_EventTarget(this._get_target);

timeStamp no setter inherited

num? get timeStamp

Inherited from Event.

Implementation

num? get timeStamp native;

deprecated toElement no setter

Node? get toElement

DEPRECATED

The nonstandard way to access the element that the mouse goes to in the case of a mouseout event.

This member is deprecated and not cross-browser compatible; use relatedTarget to get the same information in the standard way.

Implementation

@deprecated
Node? get toElement native;

type no setter inherited

String get type

Inherited from Event.

Implementation

String get type native;

view no setter inherited

WindowBase? get view

Inherited from UIEvent.

Implementation

WindowBase? get view => _convertNativeToDart_Window(this._get_view);

Methods

composedPath() inherited

List<EventTarget> composedPath()

Inherited from Event.

Implementation

List<EventTarget> composedPath() native;

getModifierState()

bool getModifierState(String keyArg)

Implementation

bool getModifierState(String keyArg) native;

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation

dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

preventDefault() inherited

void preventDefault()

Inherited from Event.

Implementation

void preventDefault() native;

stopImmediatePropagation() inherited

void stopImmediatePropagation()

Inherited from Event.

Implementation

void stopImmediatePropagation() native;

stopPropagation() inherited

void stopPropagation()

Inherited from Event.

Implementation

void stopPropagation() native;

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation

String toString() => Primitives.objectToHumanReadableString(this);

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation

bool operator ==(Object other) => identical(this, other);