PointerEvent#

Annotations: @Native.new("PointerEvent")

Constructors#

PointerEvent() factory#

factory PointerEvent(String type, [Map? eventInitDict]) {
  if (eventInitDict != null) {
    var eventInitDict_1 = convertDartToNative_Dictionary(eventInitDict);
    return PointerEvent._create_1(type, eventInitDict_1);
  }
  return PointerEvent._create_2(type);
}

Properties#

altKey no setter inherited#

Inherited from MouseEvent.

bool get altKey native;

bubbles no setter inherited#

Inherited from Event.

bool? get bubbles native;

button no setter inherited#

Inherited from MouseEvent.

int get button native;

buttons no setter inherited#

Inherited from MouseEvent.

int? get buttons native;

cancelable no setter inherited#

Inherited from Event.

bool? get cancelable native;

client no setter inherited#

Inherited from MouseEvent.

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

composed no setter inherited#

Inherited from Event.

bool? get composed native;

ctrlKey no setter inherited#

Inherited from MouseEvent.

bool get ctrlKey native;

currentTarget no setter inherited#

Inherited from Event.

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

dataTransfer no setter inherited#

Inherited from MouseEvent.

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

defaultPrevented no setter inherited#

Inherited from Event.

bool get defaultPrevented native;

detail no setter inherited#

Inherited from UIEvent.

int? get detail native;

eventPhase no setter inherited#

Inherited from Event.

int get eventPhase native;

deprecated fromElement no setter inherited#

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.

Inherited from MouseEvent.

@deprecated
Node? get fromElement native;

hashCode no setter inherited#

Inherited from Interceptor.

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

height no setter#

num? get height native;

isPrimary no setter#

bool? get isPrimary native;

isTrusted no setter inherited#

Inherited from Event.

bool? get isTrusted native;

layer no setter inherited#

Inherited from MouseEvent.

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

matchingTarget no setter inherited#

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.

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 inherited#

Inherited from MouseEvent.

bool get metaKey native;

movement no setter inherited#

Inherited from MouseEvent.

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

offset no setter inherited#

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.

Inherited from MouseEvent.

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 inherited#

Inherited from MouseEvent.

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

path no setter inherited#

Inherited from Event.

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

pointerId no setter#

int? get pointerId native;

pointerType no setter#

String? get pointerType native;

pressure no setter#

num? get pressure native;

region no setter inherited#

Inherited from MouseEvent.

String? get region native;

relatedTarget no setter inherited#

Inherited from MouseEvent.

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

runtimeType no setter inherited#

Inherited from Interceptor.

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

screen no setter inherited#

Inherited from MouseEvent.

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

shiftKey no setter inherited#

Inherited from MouseEvent.

bool get shiftKey native;

sourceCapabilities no setter inherited#

Inherited from UIEvent.

InputDeviceCapabilities? get sourceCapabilities native;

tangentialPressure no setter#

num? get tangentialPressure native;

target no setter inherited#

Inherited from Event.

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

tiltX no setter#

int? get tiltX native;

tiltY no setter#

int? get tiltY native;

timeStamp no setter inherited#

Inherited from Event.

num? get timeStamp native;

deprecated toElement no setter inherited#

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.

Inherited from MouseEvent.

@deprecated
Node? get toElement native;

twist no setter#

int? get twist native;

type no setter inherited#

Inherited from Event.

String get type native;

view no setter inherited#

Inherited from UIEvent.

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

width no setter#

num? get width native;

Methods#

composedPath() inherited#

Inherited from Event.

List<EventTarget> composedPath() native;

getCoalescedEvents()#

List<PointerEvent> getCoalescedEvents() native;

getModifierState() inherited#

Inherited from MouseEvent.

bool getModifierState(String keyArg) native;

noSuchMethod() inherited#

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.

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

preventDefault() inherited#

Inherited from Event.

void preventDefault() native;

stopImmediatePropagation() inherited#

Inherited from Event.

void stopImmediatePropagation() native;

stopPropagation() inherited#

Inherited from Event.

void stopPropagation() native;

toString() inherited#

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.

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

Operators#

operator ==() inherited#

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.

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

Static Properties#

supported no setter#

PointerEvent used for both touch and mouse. To check if touch is supported call the property TouchEvent.supported

static bool get supported {
  try {
    return PointerEvent('pointerover') is PointerEvent;
  } catch (_) {}
  return false;
}