CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

FakeSelectionObserver (engine/view/observer)

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

class
See source

Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens on keydown events and handles moving fake view selection to the correct place if arrow keys are pressed. Fires selectionChange event simulating natural behaviour of SelectionObserver.

Filtering

Properties

  • document : Document

    readonly inherited

    A reference to the Document object.

    See source

  • isEnabled : Boolean

    readonly inherited

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

    See source

  • view : View

    readonly inherited

    An instance of the view controller.

    See source

Methods

  • constructor( view )

    Creates new FakeSelectionObserver instance.

    See source

    Parameters

    view : View

  • checkShouldIgnoreEventFromTarget( domTarget ) → Boolean

    inherited

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

    See source

    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 DowncastWriter#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.

  • 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:

  • observe( domElement, name )

    inherited

    Starts observing the given root element.

    See source

    Parameters

    domElement : HTMLElement
    name : String

    The name of the root element.

  • _fireSelectionChangeDoneDebounced( data )

    private

    Fires debounced event selectionChangeDone. It uses lodash#debounce method to delay function call.

    See source

    Parameters

    data : Object

    Selection change data.

  • _handleSelectionMove( keyCode )

    private

    Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be collapsed to left. If right or down key is pressed - new selection will be collapsed to right.

    See source

    This method fires event-selectionChange and event-selectionChangeDone events imitating behaviour of SelectionObserver.

    Parameters

    keyCode : Number

    Fires