Options
All
  • Public
  • Public/Protected
  • All
Menu

The Custom Event embeds a Event. When dispatched, the {@link EventForwarder} handles the Custom Event and forwards it to the messaging world.

Type parameters

  • E: Event = Event

Hierarchy

Index

Constructors

constructor

  • new DomEvent<E>(message: E): DomEvent<E>

Properties

Readonly AT_TARGET

AT_TARGET: number

Readonly BUBBLING_PHASE

BUBBLING_PHASE: number

Readonly CAPTURING_PHASE

CAPTURING_PHASE: number

Readonly NONE

NONE: number

Readonly bubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

cancelBubble

cancelBubble: boolean

Readonly cancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

Readonly composed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

Readonly currentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

Readonly defaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

Readonly detail

detail: E

Returns any custom data event was created with. Typically used for synthetic events.

Readonly eventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

Readonly isTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

returnValue

returnValue: boolean
deprecated

Readonly srcElement

srcElement: null | EventTarget
deprecated

Readonly target

target: null | EventTarget

Returns the object to which event is dispatched (its target).

Readonly timeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

Readonly type

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

Static MESSAGE_KIND

MESSAGE_KIND: "event" = "event"

The kind of the event.

Accessors

Static CUSTOM_EVENT_TYPE

  • get CUSTOM_EVENT_TYPE(): string

Methods

composedPath

  • composedPath(): EventTarget[]
  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    Returns EventTarget[]

initCustomEvent

  • initCustomEvent(type: string, bubbles?: boolean, cancelable?: boolean, detail?: E): void
  • deprecated

    Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean
    • Optional detail: E

    Returns void

initEvent

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void
  • deprecated

    Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

preventDefault

  • preventDefault(): void
  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void
  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    Returns void

stopPropagation

  • stopPropagation(): void
  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void

Static fromKindToType

  • fromKindToType(kind: MessageKind): string

Static when

  • when<E>(domEvent: DomEvent<E>, messageType: string, callback: (event: E) => void | Promise<void>): Promise<void>
  • Execute a callback when the type of the event bundled in a DomEvent matches the given one.

    Type parameters

    • E: Event<any, MessageHeaders, E>

    Parameters

    • domEvent: DomEvent<E>

      the DomEvent

    • messageType: string

      the type of the event

    • callback: (event: E) => void | Promise<void>

      the callback with the bundled event as argument

        • (event: E): void | Promise<void>
        • Parameters

          • event: E

          Returns void | Promise<void>

    Returns Promise<void>

Generated using TypeDoc