Trilium Frontend API
    Preparing search index...

    Class ObserverAbstract

    Abstract base observer class. Observers are classes which listen to DOM events, do the preliminary processing and fire events on the module:engine/view/document~ViewDocument objects. Observers can also add features to the view, for instance by updating its status or marking elements which need a refresh on DOM events.

    Hierarchy (View Summary)

    Index
    • Creates an instance of the observer.

      Parameters

      Returns Observer

    document: ViewDocument

    A reference to the module:engine/view/document~ViewDocument object.

    An instance of the view controller.

    • get isEnabled(): boolean

      The state of the observer. If it is disabled, no events will be fired.

      Returns boolean

    • Checks whether a given DOM event should be ignored (should not be turned into a synthetic view document event).

      Currently, an event will be ignored only if its target or any of its ancestors has the data-cke-ignore-events attribute. This attribute can be used inside the structures generated by module:engine/view/downcastwriter~ViewDowncastWriter#createUIElement ViewDowncastWriter#createUIElement() to ignore events fired within a UI that should be excluded from CKEditor 5's realms.

      Parameters

      • domTarget: Node

        The DOM event target to check (usually an element, sometimes a text node and potentially sometimes a document, too).

      Returns boolean

      Whether this event should be ignored by the observer.

    • Disables and destroys the observer, among others removes event listeners created by the observer.

      Returns void

    • Disables the observer. This method is called before module:engine/view/view~EditingView#forceRender rendering to prevent firing events during rendering.

      Returns void

      module:engine/view/observer/observer~Observer#enable

    • Enables the observer. This method is called when the observer is registered to the module:engine/view/view~EditingView and after module:engine/view/view~EditingView#forceRender rendering (all observers are #disable disabled before rendering).

      A typical use case for disabling observers is that mutation observers need to be disabled for the rendering. However, a child class may not need to be disabled, so it can implement an empty method.

      Returns void

      module:engine/view/observer/observer~Observer#disable

    • Starts observing given DOM element.

      Parameters

      • domElement: HTMLElement

        DOM element to observe.

      • name: string

        The name of the related root element.

      Returns void

    • Stops observing given DOM element.

      Parameters

      Returns void