UIEvent extension type
The UIEvent
interface represents simple user interface events.
UIEvent
derives from Event. Although the UIEvent.initUIEvent method is
kept for backward compatibility, you should create a UIEvent
object using
the UIEvent.UIEvent
constructor.
Several interfaces are direct or indirect descendants of this one: MouseEvent, TouchEvent, FocusEvent, KeyboardEvent, WheelEvent, InputEvent, and CompositionEvent.
API documentation sourced from MDN Web Docs.
- on
- Implemented types
- Implementers
- Available extensions
Constructors
- UIEvent(String type, [UIEventInit eventInitDict])
-
factory
Properties
- bubbles → bool
-
The
bubbles
read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.no setterinherited - cancelable → bool
-
The
cancelable
read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.no setterinherited - cancelBubble ↔ bool
-
The
cancelBubble
property of the Event interface is deprecated. Use Event.stopPropagation instead. Setting its value totrue
before returning from an event handler prevents propagation of the event. In later implementations, setting this tofalse
does nothing. See Browser compatibility for details.getter/setter pairinherited - composed → bool
-
The read-only
composed
property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.no setterinherited - currentTarget → EventTarget?
-
The
currentTarget
read-only property of the Event interface identifies the element to which the event handler has been attached.no setterinherited - defaultPrevented → bool
-
The
defaultPrevented
read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault canceled the event.no setterinherited - detail → int
-
The
UIEvent.detail
read-only property, when non-zero, provides the current (or next, depending on the event) click count.no setter - eventPhase → int
-
The
eventPhase
read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- isTrusted → bool
-
The
isTrusted
read-only property of the Event interface is a boolean value that istrue
when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus), andfalse
when the event was dispatched via EventTarget.dispatchEvent. The only exception is theclick
event, which initializes theisTrusted
property tofalse
in user agents.no setterinherited - returnValue ↔ bool
-
The Event property
returnValue
indicates whether the default action for this event has been prevented or not.getter/setter pairinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- srcElement → EventTarget?
-
The deprecated
Event.srcElement
is an alias for the Event.target property. Use Event.target instead.no setterinherited - target → EventTarget?
-
The read-only
target
property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.no setterinherited - timeStamp → double
-
The
timeStamp
read-only property of the Event interface returns the time (in milliseconds) at which the event was created.no setterinherited - type → String
-
The
type
read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such asclick
,load
, orerror
.no setterinherited - view → Window?
-
The
UIEvent.view
read-only property returns the object from which the event was generated. In browsers, this is the Window object the event happened in.no setter - which → int
-
The
UIEvent.which
read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numerickeyCode
or the character code (charCode
) of the key pressed on the keyboard.no setter
Methods
-
composedPath(
) → JSArray< EventTarget> -
The
composedPath()
method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.inherited -
initEvent(
String type, [bool bubbles, bool cancelable]) → void -
The
Event.initEvent()
method is used to initialize the value of anevent
created using Document.createEvent.inherited -
initUIEvent(
String typeArg, [bool bubblesArg, bool cancelableArg, Window? viewArg, int detailArg]) → void -
The
UIEvent.initUIEvent()
method initializes a UI event once it's been created. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
preventDefault(
) → void -
The
preventDefault()
method of the Event interface tells the that if the event does not get explicitly handled, its default action should not be taken as it normally would be.inherited -
stopImmediatePropagation(
) → void -
The
stopImmediatePropagation()
method of the Event interface prevents other listeners of the same event from being called.inherited -
stopPropagation(
) → void -
The
stopPropagation()
method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the Event.preventDefault method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see Event.stopImmediatePropagation.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited