ReadonlydocumentA reference to the module:engine/view/document~ViewDocument object.
ReadonlydomIf set to true DOM events will be listened on the capturing phase.
Default value is false.
If set to true, indicates that the function specified by listener will never call preventDefault().
Default value is false.
ReadonlyviewAn instance of the view controller.
The state of the observer. If it is disabled, no events will be fired.
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.
The DOM event target to check (usually an element, sometimes a text node and potentially sometimes a document, too).
Whether this event should be ignored by the observer.
Disables and destroys the observer, among others removes event listeners created by the observer.
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.
Calls Document#fire() if observer #isEnabled is enabled.
The event type (name).
The DOM event.
OptionaladditionalData: KeystrokeInfo & { keystroke: number }
The additional data which should extend the module:engine/view/observer/domeventdata~ViewDocumentDomEventData event data object.
Starts observing given DOM element.
DOM element to observe.
Callback which should be called when the DOM event occurred. Note that the callback will not be called if observer #isEnabled is not enabled.
Observer for events connected with pressing keyboard keys.
Note that this observer is attached by the module:engine/view/view~EditingView and is available by default.