Class LeaveEvent

A leave TricklingEvent. Dispatched when a pointer is no longer over a specific widget (other libraries may call this an unhover event).

If a pointer event never visits a widget, even when the event is in the bounds of the widget, then the widget will never get a leave event dispatched to it. This is done by tracking the list of widgets that get visited by a pointer event every time a pointer event is dispatched. This is done automatically by the Widget and Root classes.

Has a focus type of FocusType.Pointer and needs focus.

Hierarchy (view full)

Constructors

Properties

focusType: Pointer

The focus type of this event. Can be null.

If null, this event cannot be focused, since events are focused by their FocusType as a group.

needsFocus

Can this event be dispatched without a target?

propagation: Trickling

Which event propagation model is this event type using?

reversed: boolean

Is this event dispatched in reverse-order?

target: null | Widget

The target of this event. Can be null

type

The type of this event instance. Compare this against the static WidgetEvent."type" in the class or a known string value. Comparing this value and doing an instanceof check must be equivalent.

userCapturable

Is this event capturable by user event handlers?

Note that if the event does not propagate, capturing the event still has an effect; events are handled in the order for which the handlers were added, meaning that if a handler captures the event, the other handlers won't be called.

type: "leave" = 'leave'

The type of this event class. Each event type should be unique, and have a unique class.

Due to Typescript limitations, no compile error is thrown when this static field is not set at a sub-class. Despite this, the type must be set to a unique string value.

Methods

  • Check if the type of this event instance matches the type of a given event class, asserting that the instance is of the class' type.

    Type Parameters

    Parameters

    • clazz: (new (...args: any[]) => E)
        • new (...args): E
        • Parameters

          • Rest...args: any[]

          Returns E

    Returns this is E