CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

FocusObserver (engine/view/observer)

@ckeditor/ckeditor5-engine/src/view/observer/focusobserver

class
See source

Focus and blur events observer. Focus observer handle also isFocused property of the root elements.

Note that this observer is attached by the View and is available by default.

Filtering

Properties

  • document : Document

    readonly inherited

    Reference to the Document object.

    See source

  • domEventType : String | Array.<String>

    readonly inherited

    Type of the DOM event the observer should listen on. Array of types can be defined if the obsever should listen to multiple DOM events.

    See source

  • isEnabled : Boolean

    readonly inherited

    State of the observer. If it is disabled events will not be fired.

    See source

  • useCapture : Boolean

    inherited

    If set to true DOM events will be listened on the capturing phase. Default value is false.

    See source

  • view : View

    readonly inherited

    Instance of the view controller.

    See source

  • _renderTimeoutId : Number

    private

    Identifier of the timeout currently used by focus listener to delay rendering execution.

    See source

Methods

  • constructor( view )

    inherited

    Creates an instance of the observer.

    See source

    Parameters

    view : View

  • destroy()

    inherited

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

    See source

  • disable()

    inherited

    Disables the observer. This method is called before rendering to prevent firing events during rendering.

    See source

    Related:

  • enable()

    inherited

    Enables the observer. This method is called when the observer is registered to the View and after rendering (all observers are disabled before rendering).

    See source

    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:

  • fire( eventType, domEvent, [ additionalData ] )

    inherited

    Calls Document#fire() if observer is enabled.

    See source

    Parameters

    eventType : String

    The event type (name).

    domEvent : Event

    The DOM event.

    [ additionalData ] : Object

    The additional data which should extend the event data object.

    Related:

  • observe( domElement, name )

    inherited

    Starts observing the given root element.

    See source

    Parameters

    domElement : HTMLElement
    name : String

    The name of the root element.

  • onDomEvent()

    inherited

    Callback which should be called when the DOM event occurred. Note that the callback will not be called if observer is not enabled.

    See source

    Related: