Dart API Referencedart:htmlUIEvent

UIEvent class

A basic event interface for all user interface events
1.0
11.0
Inherits from: nsIDOMEvent Last changed in Gecko 9.0 (Firefox 9.0 / Thunderbird 9.0 / SeaMonkey 2.6)

The DOM UIEvent represents simple user interface events.

@DomName('UIEvent')
class UIEvent extends Event native "UIEvent" {
 // In JS, canBubble and cancelable are technically required parameters to
 // init*Event. In practice, though, if they aren't provided they simply
 // default to false (since that's Boolean(undefined)).
 //
 // Contrary to JS, we default canBubble and cancelable to true, since that's
 // what people want most of the time anyway.
 factory UIEvent(String type,
     {Window view, int detail: 0, bool canBubble: true,
     bool cancelable: true}) {
   if (view == null) {
     view = window;
   }
   final e = document.$dom_createEvent("UIEvent");
   e.$dom_initUIEvent(type, canBubble, cancelable, view, detail);
   return e;
 }

 @JSName('charCode')
 @DomName('UIEvent.charCode')
 @DocsEditable
 final int $dom_charCode;

 @DomName('UIEvent.detail')
 @DocsEditable
 final int detail;

 @JSName('keyCode')
 @DomName('UIEvent.keyCode')
 @DocsEditable
 final int $dom_keyCode;

 @JSName('layerX')
 @DomName('UIEvent.layerX')
 @DocsEditable
 final int $dom_layerX;

 @JSName('layerY')
 @DomName('UIEvent.layerY')
 @DocsEditable
 final int $dom_layerY;

 @JSName('pageX')
 @DomName('UIEvent.pageX')
 @DocsEditable
 final int $dom_pageX;

 @JSName('pageY')
 @DomName('UIEvent.pageY')
 @DocsEditable
 final int $dom_pageY;

 WindowBase get view => _convertNativeToDart_Window(this._get_view);
 @JSName('view')
 @DomName('UIEvent.view')
 @DocsEditable
 @Creates('Window|=Object')
 @Returns('Window|=Object')
 final dynamic _get_view;

 @DomName('UIEvent.which')
 @DocsEditable
 final int which;

 @JSName('initUIEvent')
 @DomName('UIEvent.initUIEvent')
 @DocsEditable
 void $dom_initUIEvent(String type, bool canBubble, bool cancelable, Window view, int detail) native;


 @deprecated
 int get layerX => layer.x;
 @deprecated
 int get layerY => layer.y;

 @deprecated
 int get pageX => page.x;
 @deprecated
 int get pageY => page.y;

 @DomName('UIEvent.layerX')
 @DomName('UIEvent.layerY')
 Point get layer => new Point($dom_layerX, $dom_layerY);

 @DomName('UIEvent.pageX')
 @DomName('UIEvent.pageY')
 Point get page => new Point($dom_pageX, $dom_pageY);
}

Extends

Interceptor > Event > UIEvent

Subclasses

CompositionEvent, FocusEvent, KeyboardEvent, MouseEvent, TextEvent, TouchEvent, ZoomEvent

Constructors

factory UIEvent(String type, {Window view, int detail: 0, bool canBubble: true, bool cancelable: true}) #

factory UIEvent(String type,
   {Window view, int detail: 0, bool canBubble: true,
   bool cancelable: true}) {
 if (view == null) {
   view = window;
 }
 final e = document.$dom_createEvent("UIEvent");
 e.$dom_initUIEvent(type, canBubble, cancelable, view, detail);
 return e;
}

Properties

final int $dom_charCode #

final int $dom_charCode

final int $dom_keyCode #

final int $dom_keyCode

final int $dom_layerX #

final int $dom_layerX

final int $dom_layerY #

final int $dom_layerY

final int $dom_pageX #

final int $dom_pageX

final int $dom_pageY #

final int $dom_pageY

final bool bubbles #

inherited from Event
A boolean indicating whether the event bubbles up through the DOM or not.
final bool bubbles

final bool cancelable #

inherited from Event
A boolean indicating whether the event is cancelable.
final bool cancelable

bool cancelBubble #

inherited from Event
A boolean indicating whether the bubbling of the event has been canceled or not.
bool cancelBubble

final DataTransfer clipboardData #

inherited from Event
final DataTransfer clipboardData

final EventTarget currentTarget #

inherited from Event
EventTarget get currentTarget => _convertNativeToDart_EventTarget(this._get_currentTarget);

final bool defaultPrevented #

inherited from Event
Indicates whether or not event.preventDefault() has been called on the event.
final bool defaultPrevented

final int detail #

Detail about the event, depending on the type of event. Read only.
final int detail

final int eventPhase #

inherited from Event
Indicates which phase of the event flow is being processed.
final int eventPhase

final int hashCode #

inherited from Interceptor

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

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

docs inherited from Object
int get hashCode => Primitives.objectHashCode(this);

final Point layer #

@DomName('UIEvent.layerX')
@DomName('UIEvent.layerY')
Point get layer => new Point($dom_layerX, $dom_layerY);

final int layerX #

@deprecated
int get layerX => layer.x;

final int layerY #

@deprecated
int get layerY => layer.y;

final Point page #

@DomName('UIEvent.pageX')
@DomName('UIEvent.pageY')
Point get page => new Point($dom_pageX, $dom_pageY);

final int pageX #

@deprecated
int get pageX => page.x;

final int pageY #

@deprecated
int get pageY => page.y;

final Type runtimeType #

inherited from Interceptor

A representation of the runtime type of the object.

docs inherited from Object
Type get runtimeType => getRuntimeType(this);

final EventTarget target #

inherited from Event
EventTarget get target => _convertNativeToDart_EventTarget(this._get_target);

final int timeStamp #

inherited from Event
The time that the event was created.
final int timeStamp

final String type #

inherited from Event
The name of the event (case-insensitive).
final String type

final WindowBase view #

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

final int which #

final int which

Operators

bool operator ==(other) #

inherited from Interceptor

The equality operator.

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

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

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

Methods

dynamic noSuchMethod(Invocation invocation) #

inherited from Interceptor

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod in an Invocation. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

docs inherited from Object
dynamic noSuchMethod(Invocation invocation) {
 throw new NoSuchMethodError(
     this,
     _symbolToString(invocation.memberName),
     invocation.positionalArguments,
     _symbolMapToStringMap(invocation.namedArguments));
}

void preventDefault() #

inherited from Event
Cancels the event (if it is cancelable).
@DomName('Event.preventDefault')
@DocsEditable
void preventDefault() native;

void stopImmediatePropagation() #

inherited from Event
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
@DomName('Event.stopImmediatePropagation')
@DocsEditable
void stopImmediatePropagation() native;

void stopPropagation() #

inherited from Event
Stops the propagation of events further along in the DOM.
@DomName('Event.stopPropagation')
@DocsEditable
void stopPropagation() native;

String toString() #

inherited from Interceptor

Returns a string representation of this object.

docs inherited from Object
String toString() => Primitives.objectToString(this);

void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) #

inherited from Event
Initializes the value of an Event created through the DocumentEvent interface.
@JSName('initEvent')
@DomName('Event.initEvent')
@DocsEditable
void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) native;

void $dom_initUIEvent(String type, bool canBubble, bool cancelable, Window view, int detail) #

Initializes the UIEvent object.

Parameters
typeArg
The type of UI event.
canBubbleArg
Whether or not the event can bubble.
cancelableArg
Whether or not the event can be canceled.
viewArg
Specifies the view attribute value. This may be null.
detailArg
Specifies the detail attribute value.
@JSName('initUIEvent')
@DomName('UIEvent.initUIEvent')
@DocsEditable
void $dom_initUIEvent(String type, bool canBubble, bool cancelable, Window view, int detail) native;

This page includes content from the Mozilla Foundation that is graciously licensed under a Creative Commons: Attribution-Sharealike license. Mozilla has no other association with Dart or dartlang.org. We encourage you to improve the web by contributing to The Mozilla Developer Network.