/
mouseeventsobserver.js
86 lines (78 loc) · 3.15 KB
/
mouseeventsobserver.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module table/tableselection/mouseeventsobserver
*/
import DomEventObserver from '@ckeditor/ckeditor5-engine/src/view/observer/domeventobserver';
/**
* 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
* {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
*
* @extends module:engine/view/observer/domeventobserver~DomEventObserver
*/
export default class MouseEventsObserver extends DomEventObserver {
/**
* @inheritDoc
*/
constructor( view ) {
super( view );
this.domEventType = [ 'mousemove', 'mouseup', 'mouseleave' ];
}
/**
* @inheritDoc
*/
onDomEvent( domEvent ) {
this.fire( domEvent.type, domEvent );
}
}
/**
* Fired when the mouse button is released over one of the editables.
*
* Introduced by {@link module:table/tableselection/mouseeventsobserver~MouseEventsObserver}.
*
* Note that this event is not available by default. To make it available,
* {@link module:table/tableselection/mouseeventsobserver~MouseEventsObserver} needs to be added
* to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:table/tableselection/mouseeventsobserver~MouseEventsObserver
* @event module:engine/view/document~Document#event:mouseup
* @param {module:engine/view/observer/domeventdata~DomEventData} data Event data.
*/
/**
* Fired when the mouse is moved over one of the editables.
*
* Introduced by {@link module:table/tableselection/mouseeventsobserver~MouseEventsObserver}.
*
* Note that this event is not available by default. To make it available,
* {@link module:table/tableselection/mouseeventsobserver~MouseEventsObserver} needs to be added
* to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:table/tableselection/mouseeventsobserver~MouseEventsObserver
* @event module:engine/view/document~Document#event:mousemove
* @param {module:engine/view/observer/domeventdata~DomEventData} data Event data.
*/
/**
* Fired when the mouse is moved out of one of the editables.
*
* Introduced by {@link module:table/tableselection/mouseeventsobserver~MouseEventsObserver}.
*
* Note that this event is not available by default. To make it available,
* {@link module:table/tableselection/mouseeventsobserver~MouseEventsObserver} needs to be added
* to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:table/tableselection/mouseeventsobserver~MouseEventsObserver
* @event module:engine/view/document~Document#event:mouseleave
* @param {module:engine/view/observer/domeventdata~DomEventData} data Event data.
*/