MouseEventsObserver (table/tableselection)
@ckeditor/ckeditor5-table/src/tableselection/mouseeventsobserver
The mouse selection event observer.
It registers listeners for the following DOM events:
'mousemove'
'mouseup'
'mouseleave'
Note that this observer is disabled by default. To enable this observer, it needs to be added to
View
using the addObserver
method.
The observer is registered by the TableSelection
plugin.
Filtering
Properties
-
readonly inherited
document : Document
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#document
A reference to the
Document
object. -
readonly inherited
domEventType : String | Array.<String>
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#domEventType
Type of the DOM event the observer should listen to. Array of types can be defined if the observer should listen to multiple DOM events.
-
readonly inherited
isEnabled : Boolean
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#isEnabled
The state of the observer. If it is disabled, no events will be fired.
-
inherited
useCapture : Boolean
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#useCapture
If set to
true
DOM events will be listened on the capturing phase. Default value isfalse
. -
readonly inherited
view : View
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#view
An instance of the view controller.
Methods
-
inherited
constructor( view )
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#constructor
-
inherited
checkShouldIgnoreEventFromTarget( domTarget ) → Boolean
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#checkShouldIgnoreEventFromTarget
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 byDowncastWriter#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.
-
Disables the observer. This method is called before rendering to prevent firing events during rendering.
Related:
-
Enables the observer. This method is called when the observer is registered to the
View
and 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:
-
inherited
fire( eventType, domEvent, [ additionalData ] )
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#fire
Calls
Document#fire()
if observer is enabled.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:
-
inherited
observe( domElement, name )
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#observe
Starts observing the given root element.
Parameters
domElement : HTMLElement
name : String
The name of the root element.
-
inherited
onDomEvent()
module:table/tableselection/mouseeventsobserver~MouseEventsObserver#onDomEvent
Callback which should be called when the DOM event occurred. Note that the callback will not be called if observer is not enabled.
Related:
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.