Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TransitionEvent<TDataType, TEventType>

TransitionEvent

The transitionController uses the seng-event module to dispatch events to notify parent classes about certain events. The following events can be listened to.

Type parameters

  • TDataType

  • TEventType: string

Hierarchy

  • BaseEvent
    • TransitionEvent

Index

Constructors

constructor

  • new TransitionEvent(type: TEventType, data: TDataType, bubbles?: boolean, cancelable?: boolean, setTimeStamp?: boolean): TransitionEvent
  • Parameters

    • type: TEventType

      The event type

    • data: TDataType

      The data to attach to the event

    • Optional bubbles: boolean

      see [[AbstractEvent]]

    • Optional cancelable: boolean

      see [[AbstractEvent]]

    • Optional setTimeStamp: boolean

      see [[AbstractEvent]]

    Returns TransitionEvent

Properties

bubbles

bubbles: boolean

If true, the event will also go through a bubbling phase. See [[EventDispatcher.dispatchEvent]] for more information on the event phases.

cancelable

cancelable: boolean

Indicates if preventDefault can be called on this event. This will prevent the 'default action' of the event from being executed. It is up to the [[EventDispatcher]] instance that dispatches the event to stop the default action from executing when the [[EventDispatcher.dispatchEvent|dispatchEvent]] method returns false

currentTarget

currentTarget: EventDispatcher | null

Will be updated by [[EventDispatcher]] during the dispatch of an event to the target that listeners are currently being called on. After completion of an event dispatch this value will be reset to null.

data

data: TDataType

defaultPrevented

defaultPrevented: boolean

true if cancelable is true and preventDefault has been called on this event.

eventPhase

eventPhase: EventPhase

The current event phase of this event. During event dispatch, this value will be either [[EventPhase.CAPTURING_PHASE|CAPTURING_PHASE]], [[EventPhase.AT_TARGET|AT_TARGET]] or [[EventPhase.BUBBLING_PHASE|BUBBLING_PHASE]]. If this event is not currently being dispatched this will be set to [[EventPhase.NONE|NONE]].

target

target: EventDispatcher | null

Will be updated by [[EventDispatcher]] when [[EventDispatcher.dispatchEvent|dispatchEvent]] is called with this event. The value will be set to the EventDispatcher instance that dispatched the event.

timeStamp

timeStamp: number

Indicates the time this event is dispatched in the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC. This value will only be set if the setTimestamp parameter in the constructor is set to true. Otherwise, this value will be 0.

type

type: TEventType

Methods

callListener

  • callListener(handler: EventHandlerForEvent<this>): CallListenerResult
  • Calls the given event handler, and returns an enum value that indicates if stopPropagation or stopImmediatePropagation have been called on this event during the execution of that handler.

    Parameters

    • handler: EventHandlerForEvent<this>

      The event handler to execute

    Returns CallListenerResult

    An enum value, see [[CallListenerResult]]

clone

  • clone(): BaseEvent<TDataType, TEventType>
  • Returns BaseEvent<TDataType, TEventType>

preventDefault

  • preventDefault(): void
  • May only be called when the cancelable property of an event is set to true. Indicates to the instance that dispatched the event that the default action for the event should not be executed.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void
  • When called during the dispatch of an event, will prevent any other event listener from being called for this event.

    see

    [[EventDispatcher.dispatchEvent]]

    Returns void

stopPropagation

  • stopPropagation(): void
  • When called during the dispatch of an event, will prevent any targets further in the event chain from being processed. All listeners on the current target will still be executed.

    see

    [[EventDispatcher.dispatchEvent]]

    Returns void

Generated using TypeDoc