Observer (engine/view/observer)
@ckeditor/ckeditor5-engine/src/view/observer/observer
Abstract base observer class. Observers are classes which listen to DOM events, do the preliminary
processing and fire events on the Document 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.
Filtering
Properties
-
A reference to the
Documentobject. -
isEnabled : Booleanmodule:engine/view/observer/observer~Observer#isEnabledreadonly
The state of the observer. If it is disabled, no events will be fired.
-
An instance of the view controller.
Methods
-
constructor( view )module:engine/view/observer/observer~Observer#constructorCreates an instance of the observer.
Parameters
view : View
-
checkShouldIgnoreEventFromTarget( domTarget ) → Booleanmodule:engine/view/observer/observer~Observer#checkShouldIgnoreEventFromTargetChecks 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-eventsattribute. This attribute can be used inside the structures generated byDowncastWriter#createUIElement()to ignore events fired within a UI that should be excluded from CKEditor 5's realms.Parameters
domTarget : NodeThe DOM event target to check (usually an element, sometimes a text node and potentially sometimes a document, too).
Returns
BooleanWhether this event should be ignored by the observer.
-
destroy()module:engine/view/observer/observer~Observer#destroyDisables and destroys the observer, among others removes event listeners created by the observer.
-
disable()module:engine/view/observer/observer~Observer#disableDisables the observer. This method is called before rendering to prevent firing events during rendering.
Related:
-
enable()module:engine/view/observer/observer~Observer#enableEnables the observer. This method is called when the observer is registered to the
Viewand after rendering (all observers are 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.
Related:
-
observe( domElement, name )module:engine/view/observer/observer~Observer#observeStarts observing the given root element.
Parameters
domElement : HTMLElementname : StringThe name of the root element.
Every day, we work hard to keep our documentation complete. Have you spotted an outdated information? Is something missing? Please report it via our issue tracker.