UIEvent class
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 bool bubbles #
final bool bubbles
final bool cancelable #
final bool cancelable
bool cancelBubble #
bool cancelBubble
final EventTarget currentTarget #
EventTarget get currentTarget => _convertNativeToDart_EventTarget(this._get_currentTarget);
final bool defaultPrevented #
event.preventDefault()
has been called on the event.
final bool defaultPrevented
final int detail #
final int detail
final int eventPhase #
final int eventPhase
final int hashCode #
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.
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 Point page #
@DomName('UIEvent.pageX')
@DomName('UIEvent.pageY')
Point get page => new Point($dom_pageX, $dom_pageY);
final Type runtimeType #
A representation of the runtime type of the object.
Type get runtimeType => getRuntimeType(this);
final EventTarget target #
EventTarget get target => _convertNativeToDart_EventTarget(this._get_target);
final String type #
final String type
final WindowBase view #
WindowBase get view => _convertNativeToDart_Window(this._get_view);
Operators
bool operator ==(other) #
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.
bool operator ==(other) => identical(this, other);
Methods
dynamic noSuchMethod(Invocation invocation) #
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.
dynamic noSuchMethod(Invocation invocation) {
throw new NoSuchMethodError(
this,
_symbolToString(invocation.memberName),
invocation.positionalArguments,
_symbolMapToStringMap(invocation.namedArguments));
}
void preventDefault() #
@DomName('Event.preventDefault')
@DocsEditable
void preventDefault() native;
void stopImmediatePropagation() #
@DomName('Event.stopImmediatePropagation')
@DocsEditable
void stopImmediatePropagation() native;
void stopPropagation() #
@DomName('Event.stopPropagation')
@DocsEditable
void stopPropagation() native;
String toString() #
Returns a string representation of this object.
String toString() => Primitives.objectToString(this);
void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) #
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
viewattribute value. This may benull. 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.