@mathjax/src
    Preparing search index...

    Interface KeyExplorer

    Interface for keyboard explorers. Adds the necessary keyboard events.

    interface KeyExplorer {
        active: boolean;
        pool: ExplorerPool;
        stoppable: boolean;
        AddEvents(): void;
        Attach(): void;
        Detach(): void;
        FocusIn(event: FocusEvent): void;
        FocusOut(event: FocusEvent): void;
        KeyDown(event: KeyboardEvent): void;
        NoMove(): void;
        RemoveEvents(): void;
        Start(): void;
        Stop(): void;
        Update(force?: boolean): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    active pool stoppable

    Methods

    AddEvents Attach Detach FocusIn FocusOut KeyDown NoMove RemoveEvents Start Stop Update

    Properties

    active: boolean

    Flag indicating if the explorer is active.

    pool: ExplorerPool

    The pool the explorer belongs to.

    stoppable: boolean

    Flag indicating if event bubbling is stopped.

    Methods

    • Function to be executed on focus in.

      Parameters

      • event: FocusEvent

        The keyboard event.

      Returns void

    • Function to be executed on focus out.

      Parameters

      • event: FocusEvent

        The keyboard event.

      Returns void

    • Function to be executed on key down.

      Parameters

      • event: KeyboardEvent

        The keyboard event.

      Returns void

    • Update the explorer after state changes.

      Parameters

      • Optionalforce: boolean

        Forces the update in any case. (E.g., even if explorer is inactive.)

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods