/
mouseobserver.ts
99 lines (91 loc) · 3.69 KB
/
mouseobserver.ts
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
87
88
89
90
91
92
93
94
95
96
97
98
99
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module engine/view/observer/mouseobserver
*/
import DomEventObserver from './domeventobserver.js';
import type DomEventData from './domeventdata.js';
/**
* Mouse events observer.
*
* Note that this observer is not available by default. To make it available it needs to be added to
* {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
*/
export default class MouseObserver extends DomEventObserver<'mousedown' | 'mouseup' | 'mouseover' | 'mouseout'> {
/**
* @inheritDoc
*/
public readonly domEventType = [ 'mousedown', 'mouseup', 'mouseover', 'mouseout' ] as const;
/**
* @inheritDoc
*/
public onDomEvent( domEvent: MouseEvent ): void {
this.fire( domEvent.type, domEvent );
}
}
/**
* Fired when the mouse button is pressed down on one of the editing roots of the editor.
*
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
*
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
* needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:engine/view/observer/mouseobserver~MouseObserver
* @eventName module:engine/view/document~Document#mousedown
* @param data The event data.
*/
export type ViewDocumentMouseDownEvent = {
name: 'mousedown';
args: [ data: DomEventData<MouseEvent> ];
};
/**
* Fired when the mouse button is released over one of the editing roots of the editor.
*
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
*
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
* needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:engine/view/observer/mouseobserver~MouseObserver
* @eventName module:engine/view/document~Document#mouseup
* @param data The event data.
*/
export type ViewDocumentMouseUpEvent = {
name: 'mouseup';
args: [ data: DomEventData<MouseEvent> ];
};
/**
* Fired when the mouse is over one of the editing roots of the editor.
*
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
*
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
* needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:engine/view/observer/mouseobserver~MouseObserver
* @eventName module:engine/view/document~Document#mouseover
* @param data The event data.
*/
export type ViewDocumentMouseOverEvent = {
name: 'mouseover';
args: [ data: DomEventData<MouseEvent> ];
};
/**
* Fired when the mouse is moved out of the one of the editing roots of the editor.
*
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
*
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
* needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:engine/view/observer/mouseobserver~MouseObserver
* @eventName module:engine/view/document~Document#mouseout
* @param data The event data.
*/
export type ViewDocumentMouseOutEvent = {
name: 'mouseout';
args: [ data: DomEventData<MouseEvent> ];
};