Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IEngineEvent<T>

    The base interface for all IEngineEvents fired by the reading system.

    You can listen and react on events by adding a listener for the event type on a ReaderView or ReadingSystemEngine instance. When an event is "fired", all listeners on the related ReaderView instance are called first. If propagation wasn't stopped, all listeners on the related IReadingsystem instance are called.

    Some EngineEvents has specific default actions. These can be canceled/prevented by calling preventDefault() on the event.

    interface IEngineEvent<T extends string = keyof IEngineEventTypeMap> {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        propagationStopped: boolean;
        readerView: IReaderView;
        type: T;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): IEngineEventData;
    }

    Type Parameters

    Hierarchy (View Summary)

    Properties

    cancelable: boolean

    If this event's default action is cancelable. See respective engine event for its definition of default action.

    defaultPrevented: boolean

    If this event's default action has been canceled/prevented by a call to preventDefault()

    immediatePropagationStopped: boolean

    True if stopImmediatePropagation() was called on this event.

    isTrusted: boolean

    If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerView: IReaderView

    The ReaderView instance this event is related to, if any.

    type: T

    The type of event.

    Methods

    • Prevent the event's default action. See the respective engine event for its definition of default action.

      Returns void

    • Stops this event from propagating to anymore listener.

      Returns void

    • Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.

      Returns void

    Properties
    Methods