@ckeditor/ckeditor5-engine 39.0.2 → 40.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/src/controller/datacontroller.d.ts +334 -334
- package/src/controller/datacontroller.js +481 -481
- package/src/controller/editingcontroller.d.ts +98 -98
- package/src/controller/editingcontroller.js +191 -191
- package/src/conversion/conversion.d.ts +478 -478
- package/src/conversion/conversion.js +601 -601
- package/src/conversion/conversionhelpers.d.ts +26 -26
- package/src/conversion/conversionhelpers.js +32 -32
- package/src/conversion/downcastdispatcher.d.ts +562 -562
- package/src/conversion/downcastdispatcher.js +547 -547
- package/src/conversion/downcasthelpers.d.ts +1226 -1226
- package/src/conversion/downcasthelpers.js +2183 -2183
- package/src/conversion/mapper.d.ts +503 -503
- package/src/conversion/mapper.js +536 -536
- package/src/conversion/modelconsumable.d.ts +201 -201
- package/src/conversion/modelconsumable.js +333 -333
- package/src/conversion/upcastdispatcher.d.ts +492 -492
- package/src/conversion/upcastdispatcher.js +460 -460
- package/src/conversion/upcasthelpers.d.ts +499 -499
- package/src/conversion/upcasthelpers.js +950 -950
- package/src/conversion/viewconsumable.d.ts +369 -369
- package/src/conversion/viewconsumable.js +532 -532
- package/src/dataprocessor/basichtmlwriter.d.ts +18 -18
- package/src/dataprocessor/basichtmlwriter.js +19 -19
- package/src/dataprocessor/dataprocessor.d.ts +61 -61
- package/src/dataprocessor/dataprocessor.js +5 -5
- package/src/dataprocessor/htmldataprocessor.d.ts +76 -76
- package/src/dataprocessor/htmldataprocessor.js +96 -96
- package/src/dataprocessor/htmlwriter.d.ts +16 -16
- package/src/dataprocessor/htmlwriter.js +5 -5
- package/src/dataprocessor/xmldataprocessor.d.ts +90 -90
- package/src/dataprocessor/xmldataprocessor.js +108 -108
- package/src/dev-utils/model.d.ts +124 -124
- package/src/dev-utils/model.js +395 -395
- package/src/dev-utils/operationreplayer.d.ts +51 -51
- package/src/dev-utils/operationreplayer.js +112 -112
- package/src/dev-utils/utils.d.ts +37 -37
- package/src/dev-utils/utils.js +73 -73
- package/src/dev-utils/view.d.ts +319 -319
- package/src/dev-utils/view.js +967 -967
- package/src/index.d.ts +114 -114
- package/src/index.js +78 -78
- package/src/model/batch.d.ts +106 -106
- package/src/model/batch.js +96 -96
- package/src/model/differ.d.ts +387 -387
- package/src/model/differ.js +1149 -1149
- package/src/model/document.d.ts +272 -272
- package/src/model/document.js +361 -361
- package/src/model/documentfragment.d.ts +200 -200
- package/src/model/documentfragment.js +306 -306
- package/src/model/documentselection.d.ts +420 -420
- package/src/model/documentselection.js +993 -993
- package/src/model/element.d.ts +165 -165
- package/src/model/element.js +281 -281
- package/src/model/history.d.ts +114 -114
- package/src/model/history.js +207 -207
- package/src/model/item.d.ts +14 -14
- package/src/model/item.js +5 -5
- package/src/model/liveposition.d.ts +77 -77
- package/src/model/liveposition.js +93 -93
- package/src/model/liverange.d.ts +102 -102
- package/src/model/liverange.js +120 -120
- package/src/model/markercollection.d.ts +335 -335
- package/src/model/markercollection.js +403 -403
- package/src/model/model.d.ts +919 -919
- package/src/model/model.js +842 -842
- package/src/model/node.d.ts +256 -256
- package/src/model/node.js +375 -375
- package/src/model/nodelist.d.ts +91 -91
- package/src/model/nodelist.js +163 -163
- package/src/model/operation/attributeoperation.d.ts +103 -103
- package/src/model/operation/attributeoperation.js +148 -148
- package/src/model/operation/detachoperation.d.ts +60 -60
- package/src/model/operation/detachoperation.js +77 -77
- package/src/model/operation/insertoperation.d.ts +90 -90
- package/src/model/operation/insertoperation.js +135 -135
- package/src/model/operation/markeroperation.d.ts +91 -91
- package/src/model/operation/markeroperation.js +107 -107
- package/src/model/operation/mergeoperation.d.ts +100 -100
- package/src/model/operation/mergeoperation.js +167 -167
- package/src/model/operation/moveoperation.d.ts +96 -96
- package/src/model/operation/moveoperation.js +164 -164
- package/src/model/operation/nooperation.d.ts +38 -38
- package/src/model/operation/nooperation.js +48 -48
- package/src/model/operation/operation.d.ts +96 -96
- package/src/model/operation/operation.js +62 -62
- package/src/model/operation/operationfactory.d.ts +18 -18
- package/src/model/operation/operationfactory.js +44 -44
- package/src/model/operation/renameoperation.d.ts +83 -83
- package/src/model/operation/renameoperation.js +115 -115
- package/src/model/operation/rootattributeoperation.d.ts +98 -98
- package/src/model/operation/rootattributeoperation.js +155 -155
- package/src/model/operation/rootoperation.d.ts +76 -76
- package/src/model/operation/rootoperation.js +90 -90
- package/src/model/operation/splitoperation.d.ts +109 -109
- package/src/model/operation/splitoperation.js +194 -194
- package/src/model/operation/transform.d.ts +100 -100
- package/src/model/operation/transform.js +1985 -1985
- package/src/model/operation/utils.d.ts +71 -71
- package/src/model/operation/utils.js +213 -213
- package/src/model/position.d.ts +539 -539
- package/src/model/position.js +979 -979
- package/src/model/range.d.ts +458 -458
- package/src/model/range.js +875 -875
- package/src/model/rootelement.d.ts +60 -60
- package/src/model/rootelement.js +74 -74
- package/src/model/schema.d.ts +1186 -1186
- package/src/model/schema.js +1242 -1242
- package/src/model/selection.d.ts +482 -482
- package/src/model/selection.js +789 -789
- package/src/model/text.d.ts +66 -66
- package/src/model/text.js +85 -85
- package/src/model/textproxy.d.ts +144 -144
- package/src/model/textproxy.js +189 -189
- package/src/model/treewalker.d.ts +186 -186
- package/src/model/treewalker.js +244 -244
- package/src/model/typecheckable.d.ts +285 -285
- package/src/model/typecheckable.js +16 -16
- package/src/model/utils/autoparagraphing.d.ts +37 -37
- package/src/model/utils/autoparagraphing.js +63 -63
- package/src/model/utils/deletecontent.d.ts +58 -58
- package/src/model/utils/deletecontent.js +488 -488
- package/src/model/utils/findoptimalinsertionrange.d.ts +32 -32
- package/src/model/utils/findoptimalinsertionrange.js +57 -57
- package/src/model/utils/getselectedcontent.d.ts +30 -30
- package/src/model/utils/getselectedcontent.js +125 -125
- package/src/model/utils/insertcontent.d.ts +46 -46
- package/src/model/utils/insertcontent.js +705 -705
- package/src/model/utils/insertobject.d.ts +44 -44
- package/src/model/utils/insertobject.js +139 -139
- package/src/model/utils/modifyselection.d.ts +48 -48
- package/src/model/utils/modifyselection.js +186 -186
- package/src/model/utils/selection-post-fixer.d.ts +74 -74
- package/src/model/utils/selection-post-fixer.js +260 -260
- package/src/model/writer.d.ts +851 -851
- package/src/model/writer.js +1306 -1306
- package/src/view/attributeelement.d.ts +108 -108
- package/src/view/attributeelement.js +184 -184
- package/src/view/containerelement.d.ts +49 -49
- package/src/view/containerelement.js +80 -80
- package/src/view/datatransfer.d.ts +79 -79
- package/src/view/datatransfer.js +98 -98
- package/src/view/document.d.ts +184 -184
- package/src/view/document.js +120 -120
- package/src/view/documentfragment.d.ts +149 -149
- package/src/view/documentfragment.js +228 -228
- package/src/view/documentselection.d.ts +306 -306
- package/src/view/documentselection.js +256 -256
- package/src/view/domconverter.d.ts +640 -640
- package/src/view/domconverter.js +1450 -1425
- package/src/view/downcastwriter.d.ts +996 -996
- package/src/view/downcastwriter.js +1696 -1696
- package/src/view/editableelement.d.ts +62 -62
- package/src/view/editableelement.js +62 -62
- package/src/view/element.d.ts +468 -468
- package/src/view/element.js +724 -724
- package/src/view/elementdefinition.d.ts +87 -87
- package/src/view/elementdefinition.js +5 -5
- package/src/view/emptyelement.d.ts +41 -41
- package/src/view/emptyelement.js +73 -73
- package/src/view/filler.d.ts +111 -111
- package/src/view/filler.js +150 -150
- package/src/view/item.d.ts +14 -14
- package/src/view/item.js +5 -5
- package/src/view/matcher.d.ts +486 -486
- package/src/view/matcher.js +507 -507
- package/src/view/node.d.ts +163 -163
- package/src/view/node.js +228 -228
- package/src/view/observer/arrowkeysobserver.d.ts +45 -45
- package/src/view/observer/arrowkeysobserver.js +40 -40
- package/src/view/observer/bubblingemittermixin.d.ts +166 -166
- package/src/view/observer/bubblingemittermixin.js +172 -172
- package/src/view/observer/bubblingeventinfo.d.ts +47 -47
- package/src/view/observer/bubblingeventinfo.js +37 -37
- package/src/view/observer/clickobserver.d.ts +43 -43
- package/src/view/observer/clickobserver.js +29 -29
- package/src/view/observer/compositionobserver.d.ts +82 -82
- package/src/view/observer/compositionobserver.js +60 -60
- package/src/view/observer/domeventdata.d.ts +50 -50
- package/src/view/observer/domeventdata.js +47 -47
- package/src/view/observer/domeventobserver.d.ts +73 -73
- package/src/view/observer/domeventobserver.js +79 -79
- package/src/view/observer/fakeselectionobserver.d.ts +47 -47
- package/src/view/observer/fakeselectionobserver.js +91 -91
- package/src/view/observer/focusobserver.d.ts +82 -82
- package/src/view/observer/focusobserver.js +86 -86
- package/src/view/observer/inputobserver.d.ts +86 -86
- package/src/view/observer/inputobserver.js +164 -164
- package/src/view/observer/keyobserver.d.ts +66 -66
- package/src/view/observer/keyobserver.js +39 -39
- package/src/view/observer/mouseobserver.d.ts +89 -89
- package/src/view/observer/mouseobserver.js +29 -29
- package/src/view/observer/mutationobserver.d.ts +86 -86
- package/src/view/observer/mutationobserver.js +206 -206
- package/src/view/observer/observer.d.ts +89 -89
- package/src/view/observer/observer.js +84 -84
- package/src/view/observer/selectionobserver.d.ts +148 -148
- package/src/view/observer/selectionobserver.js +202 -202
- package/src/view/observer/tabobserver.d.ts +46 -46
- package/src/view/observer/tabobserver.js +42 -42
- package/src/view/placeholder.d.ts +96 -96
- package/src/view/placeholder.js +267 -267
- package/src/view/position.d.ts +189 -189
- package/src/view/position.js +324 -324
- package/src/view/range.d.ts +279 -279
- package/src/view/range.js +430 -430
- package/src/view/rawelement.d.ts +73 -73
- package/src/view/rawelement.js +105 -105
- package/src/view/renderer.d.ts +265 -265
- package/src/view/renderer.js +999 -999
- package/src/view/rooteditableelement.d.ts +41 -41
- package/src/view/rooteditableelement.js +69 -69
- package/src/view/selection.d.ts +375 -375
- package/src/view/selection.js +559 -559
- package/src/view/styles/background.d.ts +33 -33
- package/src/view/styles/background.js +74 -74
- package/src/view/styles/border.d.ts +43 -43
- package/src/view/styles/border.js +316 -316
- package/src/view/styles/margin.d.ts +29 -29
- package/src/view/styles/margin.js +34 -34
- package/src/view/styles/padding.d.ts +29 -29
- package/src/view/styles/padding.js +34 -34
- package/src/view/styles/utils.d.ts +93 -93
- package/src/view/styles/utils.js +219 -219
- package/src/view/stylesmap.d.ts +675 -675
- package/src/view/stylesmap.js +766 -766
- package/src/view/text.d.ts +74 -74
- package/src/view/text.js +93 -93
- package/src/view/textproxy.d.ts +97 -97
- package/src/view/textproxy.js +124 -124
- package/src/view/treewalker.d.ts +195 -195
- package/src/view/treewalker.js +327 -327
- package/src/view/typecheckable.d.ts +448 -448
- package/src/view/typecheckable.js +19 -19
- package/src/view/uielement.d.ts +96 -96
- package/src/view/uielement.js +182 -182
- package/src/view/upcastwriter.d.ts +417 -417
- package/src/view/upcastwriter.js +359 -359
- package/src/view/view.d.ts +487 -487
- package/src/view/view.js +546 -546
|
@@ -1,202 +1,202 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
-
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* @module engine/view/observer/selectionobserver
|
|
7
|
-
*/
|
|
8
|
-
/* global setInterval, clearInterval */
|
|
9
|
-
import Observer from './observer';
|
|
10
|
-
import MutationObserver from './mutationobserver';
|
|
11
|
-
import { env } from '@ckeditor/ckeditor5-utils';
|
|
12
|
-
import { debounce } from 'lodash-es';
|
|
13
|
-
import FocusObserver from './focusobserver';
|
|
14
|
-
/**
|
|
15
|
-
* Selection observer class observes selection changes in the document. If a selection changes on the document this
|
|
16
|
-
* observer checks if the DOM selection is different from the {@link module:engine/view/document~Document#selection view selection}.
|
|
17
|
-
* The selection observer fires {@link module:engine/view/document~Document#event:selectionChange} event only if
|
|
18
|
-
* a selection change was the only change in the document and the DOM selection is different from the view selection.
|
|
19
|
-
*
|
|
20
|
-
* This observer also manages the {@link module:engine/view/document~Document#isSelecting} property of the view document.
|
|
21
|
-
*
|
|
22
|
-
* Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
|
|
23
|
-
*/
|
|
24
|
-
export default class SelectionObserver extends Observer {
|
|
25
|
-
constructor(view) {
|
|
26
|
-
super(view);
|
|
27
|
-
this.mutationObserver = view.getObserver(MutationObserver);
|
|
28
|
-
this.focusObserver = view.getObserver(FocusObserver);
|
|
29
|
-
this.selection = this.document.selection;
|
|
30
|
-
this.domConverter = view.domConverter;
|
|
31
|
-
this._documents = new WeakSet();
|
|
32
|
-
this._fireSelectionChangeDoneDebounced = debounce(data => {
|
|
33
|
-
this.document.fire('selectionChangeDone', data);
|
|
34
|
-
}, 200);
|
|
35
|
-
this._clearInfiniteLoopInterval = setInterval(() => this._clearInfiniteLoop(), 1000);
|
|
36
|
-
this._documentIsSelectingInactivityTimeoutDebounced = debounce(() => (this.document.isSelecting = false), 5000);
|
|
37
|
-
this._loopbackCounter = 0;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* @inheritDoc
|
|
41
|
-
*/
|
|
42
|
-
observe(domElement) {
|
|
43
|
-
const domDocument = domElement.ownerDocument;
|
|
44
|
-
const startDocumentIsSelecting = () => {
|
|
45
|
-
this.document.isSelecting = true;
|
|
46
|
-
// Let's activate the safety timeout each time the document enters the "is selecting" state.
|
|
47
|
-
this._documentIsSelectingInactivityTimeoutDebounced();
|
|
48
|
-
};
|
|
49
|
-
const endDocumentIsSelecting = () => {
|
|
50
|
-
if (!this.document.isSelecting) {
|
|
51
|
-
return;
|
|
52
|
-
}
|
|
53
|
-
// Make sure that model selection is up-to-date at the end of selecting process.
|
|
54
|
-
// Sometimes `selectionchange` events could arrive after the `mouseup` event and that selection could be already outdated.
|
|
55
|
-
this._handleSelectionChange(null, domDocument);
|
|
56
|
-
this.document.isSelecting = false;
|
|
57
|
-
// The safety timeout can be canceled when the document leaves the "is selecting" state.
|
|
58
|
-
this._documentIsSelectingInactivityTimeoutDebounced.cancel();
|
|
59
|
-
};
|
|
60
|
-
// The document has the "is selecting" state while the user keeps making (extending) the selection
|
|
61
|
-
// (e.g. by holding the mouse button and moving the cursor). The state resets when they either released
|
|
62
|
-
// the mouse button or interrupted the process by pressing or releasing any key.
|
|
63
|
-
this.listenTo(domElement, 'selectstart', startDocumentIsSelecting, { priority: 'highest' });
|
|
64
|
-
this.listenTo(domElement, 'keydown', endDocumentIsSelecting, { priority: 'highest', useCapture: true });
|
|
65
|
-
this.listenTo(domElement, 'keyup', endDocumentIsSelecting, { priority: 'highest', useCapture: true });
|
|
66
|
-
// Add document-wide listeners only once. This method could be called for multiple editing roots.
|
|
67
|
-
if (this._documents.has(domDocument)) {
|
|
68
|
-
return;
|
|
69
|
-
}
|
|
70
|
-
// This listener is using capture mode to make sure that selection is upcasted before any other
|
|
71
|
-
// handler would like to check it and update (for example table multi cell selection).
|
|
72
|
-
this.listenTo(domDocument, 'mouseup', endDocumentIsSelecting, { priority: 'highest', useCapture: true });
|
|
73
|
-
this.listenTo(domDocument, 'selectionchange', (evt, domEvent) => {
|
|
74
|
-
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
75
|
-
// @if CK_DEBUG_TYPING // const domSelection = domDocument.defaultView!.getSelection();
|
|
76
|
-
// @if CK_DEBUG_TYPING // console.group( '%c[SelectionObserver]%c selectionchange', 'color:green', ''
|
|
77
|
-
// @if CK_DEBUG_TYPING // );
|
|
78
|
-
// @if CK_DEBUG_TYPING // console.info( '%c[SelectionObserver]%c DOM Selection:', 'font-weight:bold;color:green', '',
|
|
79
|
-
// @if CK_DEBUG_TYPING // { node: domSelection!.anchorNode, offset: domSelection!.anchorOffset },
|
|
80
|
-
// @if CK_DEBUG_TYPING // { node: domSelection!.focusNode, offset: domSelection!.focusOffset }
|
|
81
|
-
// @if CK_DEBUG_TYPING // );
|
|
82
|
-
// @if CK_DEBUG_TYPING // }
|
|
83
|
-
// The Renderer is disabled while composing on non-android browsers, so we can't update the view selection
|
|
84
|
-
// because the DOM and view tree drifted apart. Position mapping could fail because of it.
|
|
85
|
-
if (this.document.isComposing && !env.isAndroid) {
|
|
86
|
-
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
87
|
-
// @if CK_DEBUG_TYPING // console.info( '%c[SelectionObserver]%c Selection change ignored (isComposing)',
|
|
88
|
-
// @if CK_DEBUG_TYPING // 'font-weight:bold;color:green', ''
|
|
89
|
-
// @if CK_DEBUG_TYPING // );
|
|
90
|
-
// @if CK_DEBUG_TYPING // console.groupEnd();
|
|
91
|
-
// @if CK_DEBUG_TYPING // }
|
|
92
|
-
return;
|
|
93
|
-
}
|
|
94
|
-
this._handleSelectionChange(domEvent, domDocument);
|
|
95
|
-
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
96
|
-
// @if CK_DEBUG_TYPING // console.groupEnd();
|
|
97
|
-
// @if CK_DEBUG_TYPING // }
|
|
98
|
-
// Defer the safety timeout when the selection changes (e.g. the user keeps extending the selection
|
|
99
|
-
// using their mouse).
|
|
100
|
-
this._documentIsSelectingInactivityTimeoutDebounced();
|
|
101
|
-
});
|
|
102
|
-
this._documents.add(domDocument);
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* @inheritDoc
|
|
106
|
-
*/
|
|
107
|
-
stopObserving(domElement) {
|
|
108
|
-
this.stopListening(domElement);
|
|
109
|
-
}
|
|
110
|
-
/**
|
|
111
|
-
* @inheritDoc
|
|
112
|
-
*/
|
|
113
|
-
destroy() {
|
|
114
|
-
super.destroy();
|
|
115
|
-
clearInterval(this._clearInfiniteLoopInterval);
|
|
116
|
-
this._fireSelectionChangeDoneDebounced.cancel();
|
|
117
|
-
this._documentIsSelectingInactivityTimeoutDebounced.cancel();
|
|
118
|
-
}
|
|
119
|
-
/* istanbul ignore next -- @preserve */
|
|
120
|
-
_reportInfiniteLoop() {
|
|
121
|
-
// @if CK_DEBUG // throw new Error(
|
|
122
|
-
// @if CK_DEBUG // 'Selection change observer detected an infinite rendering loop.\n\n' +
|
|
123
|
-
// @if CK_DEBUG // '⚠️⚠️ Report this error on https://github.com/ckeditor/ckeditor5/issues/11658.'
|
|
124
|
-
// @if CK_DEBUG // );
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
* Selection change listener. {@link module:engine/view/observer/mutationobserver~MutationObserver#flush Flush} mutations, check if
|
|
128
|
-
* a selection changes and fires {@link module:engine/view/document~Document#event:selectionChange} event on every change
|
|
129
|
-
* and {@link module:engine/view/document~Document#event:selectionChangeDone} when a selection stop changing.
|
|
130
|
-
*
|
|
131
|
-
* @param domEvent DOM event.
|
|
132
|
-
* @param domDocument DOM document.
|
|
133
|
-
*/
|
|
134
|
-
_handleSelectionChange(domEvent, domDocument) {
|
|
135
|
-
if (!this.isEnabled) {
|
|
136
|
-
return;
|
|
137
|
-
}
|
|
138
|
-
const domSelection = domDocument.defaultView.getSelection();
|
|
139
|
-
if (this.checkShouldIgnoreEventFromTarget(domSelection.anchorNode)) {
|
|
140
|
-
return;
|
|
141
|
-
}
|
|
142
|
-
// Ensure the mutation event will be before selection event on all browsers.
|
|
143
|
-
this.mutationObserver.flush();
|
|
144
|
-
const newViewSelection = this.domConverter.domSelectionToView(domSelection);
|
|
145
|
-
// Do not convert selection change if the new view selection has no ranges in it.
|
|
146
|
-
//
|
|
147
|
-
// It means that the DOM selection is in some way incorrect. Ranges that were in the DOM selection could not be
|
|
148
|
-
// converted to the view. This happens when the DOM selection was moved outside of the editable element.
|
|
149
|
-
if (newViewSelection.rangeCount == 0) {
|
|
150
|
-
this.view.hasDomSelection = false;
|
|
151
|
-
return;
|
|
152
|
-
}
|
|
153
|
-
this.view.hasDomSelection = true;
|
|
154
|
-
// Mark the latest focus change as complete (we got new selection after the focus so the selection is in the focused element).
|
|
155
|
-
this.focusObserver.flush();
|
|
156
|
-
if (this.selection.isEqual(newViewSelection) && this.domConverter.isDomSelectionCorrect(domSelection)) {
|
|
157
|
-
return;
|
|
158
|
-
}
|
|
159
|
-
// Ensure we are not in the infinite loop (#400).
|
|
160
|
-
// This counter is reset each second. 60 selection changes in 1 second is enough high number
|
|
161
|
-
// to be very difficult (impossible) to achieve using just keyboard keys (during normal editor use).
|
|
162
|
-
if (++this._loopbackCounter > 60) {
|
|
163
|
-
// Selection change observer detected an infinite rendering loop.
|
|
164
|
-
// Most probably you try to put the selection in the position which is not allowed
|
|
165
|
-
// by the browser and browser fixes it automatically what causes `selectionchange` event on
|
|
166
|
-
// which a loopback through a model tries to re-render the wrong selection and again.
|
|
167
|
-
this._reportInfiniteLoop();
|
|
168
|
-
return;
|
|
169
|
-
}
|
|
170
|
-
if (this.selection.isSimilar(newViewSelection)) {
|
|
171
|
-
// If selection was equal and we are at this point of algorithm, it means that it was incorrect.
|
|
172
|
-
// Just re-render it, no need to fire any events, etc.
|
|
173
|
-
this.view.forceRender();
|
|
174
|
-
}
|
|
175
|
-
else {
|
|
176
|
-
const data = {
|
|
177
|
-
oldSelection: this.selection,
|
|
178
|
-
newSelection: newViewSelection,
|
|
179
|
-
domSelection
|
|
180
|
-
};
|
|
181
|
-
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
182
|
-
// @if CK_DEBUG_TYPING // console.info( '%c[SelectionObserver]%c Fire selection change:',
|
|
183
|
-
// @if CK_DEBUG_TYPING // 'font-weight:bold;color:green', '',
|
|
184
|
-
// @if CK_DEBUG_TYPING // newViewSelection.getFirstRange()
|
|
185
|
-
// @if CK_DEBUG_TYPING // );
|
|
186
|
-
// @if CK_DEBUG_TYPING // }
|
|
187
|
-
// Prepare data for new selection and fire appropriate events.
|
|
188
|
-
this.document.fire('selectionChange', data);
|
|
189
|
-
// Call `#_fireSelectionChangeDoneDebounced` every time when `selectionChange` event is fired.
|
|
190
|
-
// This function is debounced what means that `selectionChangeDone` event will be fired only when
|
|
191
|
-
// defined int the function time will elapse since the last time the function was called.
|
|
192
|
-
// So `selectionChangeDone` will be fired when selection will stop changing.
|
|
193
|
-
this._fireSelectionChangeDoneDebounced(data);
|
|
194
|
-
}
|
|
195
|
-
}
|
|
196
|
-
/**
|
|
197
|
-
* Clears `SelectionObserver` internal properties connected with preventing infinite loop.
|
|
198
|
-
*/
|
|
199
|
-
_clearInfiniteLoop() {
|
|
200
|
-
this._loopbackCounter = 0;
|
|
201
|
-
}
|
|
202
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* @module engine/view/observer/selectionobserver
|
|
7
|
+
*/
|
|
8
|
+
/* global setInterval, clearInterval */
|
|
9
|
+
import Observer from './observer';
|
|
10
|
+
import MutationObserver from './mutationobserver';
|
|
11
|
+
import { env } from '@ckeditor/ckeditor5-utils';
|
|
12
|
+
import { debounce } from 'lodash-es';
|
|
13
|
+
import FocusObserver from './focusobserver';
|
|
14
|
+
/**
|
|
15
|
+
* Selection observer class observes selection changes in the document. If a selection changes on the document this
|
|
16
|
+
* observer checks if the DOM selection is different from the {@link module:engine/view/document~Document#selection view selection}.
|
|
17
|
+
* The selection observer fires {@link module:engine/view/document~Document#event:selectionChange} event only if
|
|
18
|
+
* a selection change was the only change in the document and the DOM selection is different from the view selection.
|
|
19
|
+
*
|
|
20
|
+
* This observer also manages the {@link module:engine/view/document~Document#isSelecting} property of the view document.
|
|
21
|
+
*
|
|
22
|
+
* Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
|
|
23
|
+
*/
|
|
24
|
+
export default class SelectionObserver extends Observer {
|
|
25
|
+
constructor(view) {
|
|
26
|
+
super(view);
|
|
27
|
+
this.mutationObserver = view.getObserver(MutationObserver);
|
|
28
|
+
this.focusObserver = view.getObserver(FocusObserver);
|
|
29
|
+
this.selection = this.document.selection;
|
|
30
|
+
this.domConverter = view.domConverter;
|
|
31
|
+
this._documents = new WeakSet();
|
|
32
|
+
this._fireSelectionChangeDoneDebounced = debounce(data => {
|
|
33
|
+
this.document.fire('selectionChangeDone', data);
|
|
34
|
+
}, 200);
|
|
35
|
+
this._clearInfiniteLoopInterval = setInterval(() => this._clearInfiniteLoop(), 1000);
|
|
36
|
+
this._documentIsSelectingInactivityTimeoutDebounced = debounce(() => (this.document.isSelecting = false), 5000);
|
|
37
|
+
this._loopbackCounter = 0;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* @inheritDoc
|
|
41
|
+
*/
|
|
42
|
+
observe(domElement) {
|
|
43
|
+
const domDocument = domElement.ownerDocument;
|
|
44
|
+
const startDocumentIsSelecting = () => {
|
|
45
|
+
this.document.isSelecting = true;
|
|
46
|
+
// Let's activate the safety timeout each time the document enters the "is selecting" state.
|
|
47
|
+
this._documentIsSelectingInactivityTimeoutDebounced();
|
|
48
|
+
};
|
|
49
|
+
const endDocumentIsSelecting = () => {
|
|
50
|
+
if (!this.document.isSelecting) {
|
|
51
|
+
return;
|
|
52
|
+
}
|
|
53
|
+
// Make sure that model selection is up-to-date at the end of selecting process.
|
|
54
|
+
// Sometimes `selectionchange` events could arrive after the `mouseup` event and that selection could be already outdated.
|
|
55
|
+
this._handleSelectionChange(null, domDocument);
|
|
56
|
+
this.document.isSelecting = false;
|
|
57
|
+
// The safety timeout can be canceled when the document leaves the "is selecting" state.
|
|
58
|
+
this._documentIsSelectingInactivityTimeoutDebounced.cancel();
|
|
59
|
+
};
|
|
60
|
+
// The document has the "is selecting" state while the user keeps making (extending) the selection
|
|
61
|
+
// (e.g. by holding the mouse button and moving the cursor). The state resets when they either released
|
|
62
|
+
// the mouse button or interrupted the process by pressing or releasing any key.
|
|
63
|
+
this.listenTo(domElement, 'selectstart', startDocumentIsSelecting, { priority: 'highest' });
|
|
64
|
+
this.listenTo(domElement, 'keydown', endDocumentIsSelecting, { priority: 'highest', useCapture: true });
|
|
65
|
+
this.listenTo(domElement, 'keyup', endDocumentIsSelecting, { priority: 'highest', useCapture: true });
|
|
66
|
+
// Add document-wide listeners only once. This method could be called for multiple editing roots.
|
|
67
|
+
if (this._documents.has(domDocument)) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
// This listener is using capture mode to make sure that selection is upcasted before any other
|
|
71
|
+
// handler would like to check it and update (for example table multi cell selection).
|
|
72
|
+
this.listenTo(domDocument, 'mouseup', endDocumentIsSelecting, { priority: 'highest', useCapture: true });
|
|
73
|
+
this.listenTo(domDocument, 'selectionchange', (evt, domEvent) => {
|
|
74
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
75
|
+
// @if CK_DEBUG_TYPING // const domSelection = domDocument.defaultView!.getSelection();
|
|
76
|
+
// @if CK_DEBUG_TYPING // console.group( '%c[SelectionObserver]%c selectionchange', 'color:green', ''
|
|
77
|
+
// @if CK_DEBUG_TYPING // );
|
|
78
|
+
// @if CK_DEBUG_TYPING // console.info( '%c[SelectionObserver]%c DOM Selection:', 'font-weight:bold;color:green', '',
|
|
79
|
+
// @if CK_DEBUG_TYPING // { node: domSelection!.anchorNode, offset: domSelection!.anchorOffset },
|
|
80
|
+
// @if CK_DEBUG_TYPING // { node: domSelection!.focusNode, offset: domSelection!.focusOffset }
|
|
81
|
+
// @if CK_DEBUG_TYPING // );
|
|
82
|
+
// @if CK_DEBUG_TYPING // }
|
|
83
|
+
// The Renderer is disabled while composing on non-android browsers, so we can't update the view selection
|
|
84
|
+
// because the DOM and view tree drifted apart. Position mapping could fail because of it.
|
|
85
|
+
if (this.document.isComposing && !env.isAndroid) {
|
|
86
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
87
|
+
// @if CK_DEBUG_TYPING // console.info( '%c[SelectionObserver]%c Selection change ignored (isComposing)',
|
|
88
|
+
// @if CK_DEBUG_TYPING // 'font-weight:bold;color:green', ''
|
|
89
|
+
// @if CK_DEBUG_TYPING // );
|
|
90
|
+
// @if CK_DEBUG_TYPING // console.groupEnd();
|
|
91
|
+
// @if CK_DEBUG_TYPING // }
|
|
92
|
+
return;
|
|
93
|
+
}
|
|
94
|
+
this._handleSelectionChange(domEvent, domDocument);
|
|
95
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
96
|
+
// @if CK_DEBUG_TYPING // console.groupEnd();
|
|
97
|
+
// @if CK_DEBUG_TYPING // }
|
|
98
|
+
// Defer the safety timeout when the selection changes (e.g. the user keeps extending the selection
|
|
99
|
+
// using their mouse).
|
|
100
|
+
this._documentIsSelectingInactivityTimeoutDebounced();
|
|
101
|
+
});
|
|
102
|
+
this._documents.add(domDocument);
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* @inheritDoc
|
|
106
|
+
*/
|
|
107
|
+
stopObserving(domElement) {
|
|
108
|
+
this.stopListening(domElement);
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* @inheritDoc
|
|
112
|
+
*/
|
|
113
|
+
destroy() {
|
|
114
|
+
super.destroy();
|
|
115
|
+
clearInterval(this._clearInfiniteLoopInterval);
|
|
116
|
+
this._fireSelectionChangeDoneDebounced.cancel();
|
|
117
|
+
this._documentIsSelectingInactivityTimeoutDebounced.cancel();
|
|
118
|
+
}
|
|
119
|
+
/* istanbul ignore next -- @preserve */
|
|
120
|
+
_reportInfiniteLoop() {
|
|
121
|
+
// @if CK_DEBUG // throw new Error(
|
|
122
|
+
// @if CK_DEBUG // 'Selection change observer detected an infinite rendering loop.\n\n' +
|
|
123
|
+
// @if CK_DEBUG // '⚠️⚠️ Report this error on https://github.com/ckeditor/ckeditor5/issues/11658.'
|
|
124
|
+
// @if CK_DEBUG // );
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Selection change listener. {@link module:engine/view/observer/mutationobserver~MutationObserver#flush Flush} mutations, check if
|
|
128
|
+
* a selection changes and fires {@link module:engine/view/document~Document#event:selectionChange} event on every change
|
|
129
|
+
* and {@link module:engine/view/document~Document#event:selectionChangeDone} when a selection stop changing.
|
|
130
|
+
*
|
|
131
|
+
* @param domEvent DOM event.
|
|
132
|
+
* @param domDocument DOM document.
|
|
133
|
+
*/
|
|
134
|
+
_handleSelectionChange(domEvent, domDocument) {
|
|
135
|
+
if (!this.isEnabled) {
|
|
136
|
+
return;
|
|
137
|
+
}
|
|
138
|
+
const domSelection = domDocument.defaultView.getSelection();
|
|
139
|
+
if (this.checkShouldIgnoreEventFromTarget(domSelection.anchorNode)) {
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
// Ensure the mutation event will be before selection event on all browsers.
|
|
143
|
+
this.mutationObserver.flush();
|
|
144
|
+
const newViewSelection = this.domConverter.domSelectionToView(domSelection);
|
|
145
|
+
// Do not convert selection change if the new view selection has no ranges in it.
|
|
146
|
+
//
|
|
147
|
+
// It means that the DOM selection is in some way incorrect. Ranges that were in the DOM selection could not be
|
|
148
|
+
// converted to the view. This happens when the DOM selection was moved outside of the editable element.
|
|
149
|
+
if (newViewSelection.rangeCount == 0) {
|
|
150
|
+
this.view.hasDomSelection = false;
|
|
151
|
+
return;
|
|
152
|
+
}
|
|
153
|
+
this.view.hasDomSelection = true;
|
|
154
|
+
// Mark the latest focus change as complete (we got new selection after the focus so the selection is in the focused element).
|
|
155
|
+
this.focusObserver.flush();
|
|
156
|
+
if (this.selection.isEqual(newViewSelection) && this.domConverter.isDomSelectionCorrect(domSelection)) {
|
|
157
|
+
return;
|
|
158
|
+
}
|
|
159
|
+
// Ensure we are not in the infinite loop (#400).
|
|
160
|
+
// This counter is reset each second. 60 selection changes in 1 second is enough high number
|
|
161
|
+
// to be very difficult (impossible) to achieve using just keyboard keys (during normal editor use).
|
|
162
|
+
if (++this._loopbackCounter > 60) {
|
|
163
|
+
// Selection change observer detected an infinite rendering loop.
|
|
164
|
+
// Most probably you try to put the selection in the position which is not allowed
|
|
165
|
+
// by the browser and browser fixes it automatically what causes `selectionchange` event on
|
|
166
|
+
// which a loopback through a model tries to re-render the wrong selection and again.
|
|
167
|
+
this._reportInfiniteLoop();
|
|
168
|
+
return;
|
|
169
|
+
}
|
|
170
|
+
if (this.selection.isSimilar(newViewSelection)) {
|
|
171
|
+
// If selection was equal and we are at this point of algorithm, it means that it was incorrect.
|
|
172
|
+
// Just re-render it, no need to fire any events, etc.
|
|
173
|
+
this.view.forceRender();
|
|
174
|
+
}
|
|
175
|
+
else {
|
|
176
|
+
const data = {
|
|
177
|
+
oldSelection: this.selection,
|
|
178
|
+
newSelection: newViewSelection,
|
|
179
|
+
domSelection
|
|
180
|
+
};
|
|
181
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
182
|
+
// @if CK_DEBUG_TYPING // console.info( '%c[SelectionObserver]%c Fire selection change:',
|
|
183
|
+
// @if CK_DEBUG_TYPING // 'font-weight:bold;color:green', '',
|
|
184
|
+
// @if CK_DEBUG_TYPING // newViewSelection.getFirstRange()
|
|
185
|
+
// @if CK_DEBUG_TYPING // );
|
|
186
|
+
// @if CK_DEBUG_TYPING // }
|
|
187
|
+
// Prepare data for new selection and fire appropriate events.
|
|
188
|
+
this.document.fire('selectionChange', data);
|
|
189
|
+
// Call `#_fireSelectionChangeDoneDebounced` every time when `selectionChange` event is fired.
|
|
190
|
+
// This function is debounced what means that `selectionChangeDone` event will be fired only when
|
|
191
|
+
// defined int the function time will elapse since the last time the function was called.
|
|
192
|
+
// So `selectionChangeDone` will be fired when selection will stop changing.
|
|
193
|
+
this._fireSelectionChangeDoneDebounced(data);
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Clears `SelectionObserver` internal properties connected with preventing infinite loop.
|
|
198
|
+
*/
|
|
199
|
+
_clearInfiniteLoop() {
|
|
200
|
+
this._loopbackCounter = 0;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
-
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* @module engine/view/observer/tabobserver
|
|
7
|
-
*/
|
|
8
|
-
import type View from '../view';
|
|
9
|
-
import Observer from './observer';
|
|
10
|
-
import type { KeyEventData } from './keyobserver';
|
|
11
|
-
import type { BubblingEvent } from './bubblingemittermixin';
|
|
12
|
-
/**
|
|
13
|
-
* Tab observer introduces the {@link module:engine/view/document~Document#event:tab `Document#tab`} event.
|
|
14
|
-
*
|
|
15
|
-
* Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
|
|
16
|
-
* {@link module:engine/view/view~View}, this event is available by default.
|
|
17
|
-
*/
|
|
18
|
-
export default class TabObserver extends Observer {
|
|
19
|
-
/**
|
|
20
|
-
* @inheritDoc
|
|
21
|
-
*/
|
|
22
|
-
constructor(view: View);
|
|
23
|
-
/**
|
|
24
|
-
* @inheritDoc
|
|
25
|
-
*/
|
|
26
|
-
observe(): void;
|
|
27
|
-
/**
|
|
28
|
-
* @inheritDoc
|
|
29
|
-
*/
|
|
30
|
-
stopObserving(): void;
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* Event fired when the user presses a tab key.
|
|
34
|
-
*
|
|
35
|
-
* Introduced by {@link module:engine/view/observer/tabobserver~TabObserver}.
|
|
36
|
-
*
|
|
37
|
-
* Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
|
|
38
|
-
* {@link module:engine/view/view~View}, this event is available by default.
|
|
39
|
-
*
|
|
40
|
-
* @eventName module:engine/view/document~Document#tab
|
|
41
|
-
* @param data
|
|
42
|
-
*/
|
|
43
|
-
export type ViewDocumentTabEvent = BubblingEvent<{
|
|
44
|
-
name: 'tab';
|
|
45
|
-
args: [data: KeyEventData];
|
|
46
|
-
}>;
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* @module engine/view/observer/tabobserver
|
|
7
|
+
*/
|
|
8
|
+
import type View from '../view';
|
|
9
|
+
import Observer from './observer';
|
|
10
|
+
import type { KeyEventData } from './keyobserver';
|
|
11
|
+
import type { BubblingEvent } from './bubblingemittermixin';
|
|
12
|
+
/**
|
|
13
|
+
* Tab observer introduces the {@link module:engine/view/document~Document#event:tab `Document#tab`} event.
|
|
14
|
+
*
|
|
15
|
+
* Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
|
|
16
|
+
* {@link module:engine/view/view~View}, this event is available by default.
|
|
17
|
+
*/
|
|
18
|
+
export default class TabObserver extends Observer {
|
|
19
|
+
/**
|
|
20
|
+
* @inheritDoc
|
|
21
|
+
*/
|
|
22
|
+
constructor(view: View);
|
|
23
|
+
/**
|
|
24
|
+
* @inheritDoc
|
|
25
|
+
*/
|
|
26
|
+
observe(): void;
|
|
27
|
+
/**
|
|
28
|
+
* @inheritDoc
|
|
29
|
+
*/
|
|
30
|
+
stopObserving(): void;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Event fired when the user presses a tab key.
|
|
34
|
+
*
|
|
35
|
+
* Introduced by {@link module:engine/view/observer/tabobserver~TabObserver}.
|
|
36
|
+
*
|
|
37
|
+
* Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
|
|
38
|
+
* {@link module:engine/view/view~View}, this event is available by default.
|
|
39
|
+
*
|
|
40
|
+
* @eventName module:engine/view/document~Document#tab
|
|
41
|
+
* @param data
|
|
42
|
+
*/
|
|
43
|
+
export type ViewDocumentTabEvent = BubblingEvent<{
|
|
44
|
+
name: 'tab';
|
|
45
|
+
args: [data: KeyEventData];
|
|
46
|
+
}>;
|
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
-
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
-
*/
|
|
5
|
-
import Observer from './observer';
|
|
6
|
-
import BubblingEventInfo from './bubblingeventinfo';
|
|
7
|
-
import { keyCodes } from '@ckeditor/ckeditor5-utils';
|
|
8
|
-
/**
|
|
9
|
-
* Tab observer introduces the {@link module:engine/view/document~Document#event:tab `Document#tab`} event.
|
|
10
|
-
*
|
|
11
|
-
* Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
|
|
12
|
-
* {@link module:engine/view/view~View}, this event is available by default.
|
|
13
|
-
*/
|
|
14
|
-
export default class TabObserver extends Observer {
|
|
15
|
-
/**
|
|
16
|
-
* @inheritDoc
|
|
17
|
-
*/
|
|
18
|
-
constructor(view) {
|
|
19
|
-
super(view);
|
|
20
|
-
const doc = this.document;
|
|
21
|
-
doc.on('keydown', (evt, data) => {
|
|
22
|
-
if (!this.isEnabled ||
|
|
23
|
-
data.keyCode != keyCodes.tab ||
|
|
24
|
-
data.ctrlKey) {
|
|
25
|
-
return;
|
|
26
|
-
}
|
|
27
|
-
const event = new BubblingEventInfo(doc, 'tab', doc.selection.getFirstRange());
|
|
28
|
-
doc.fire(event, data);
|
|
29
|
-
if (event.stop.called) {
|
|
30
|
-
evt.stop();
|
|
31
|
-
}
|
|
32
|
-
});
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* @inheritDoc
|
|
36
|
-
*/
|
|
37
|
-
observe() { }
|
|
38
|
-
/**
|
|
39
|
-
* @inheritDoc
|
|
40
|
-
*/
|
|
41
|
-
stopObserving() { }
|
|
42
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
+
*/
|
|
5
|
+
import Observer from './observer';
|
|
6
|
+
import BubblingEventInfo from './bubblingeventinfo';
|
|
7
|
+
import { keyCodes } from '@ckeditor/ckeditor5-utils';
|
|
8
|
+
/**
|
|
9
|
+
* Tab observer introduces the {@link module:engine/view/document~Document#event:tab `Document#tab`} event.
|
|
10
|
+
*
|
|
11
|
+
* Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
|
|
12
|
+
* {@link module:engine/view/view~View}, this event is available by default.
|
|
13
|
+
*/
|
|
14
|
+
export default class TabObserver extends Observer {
|
|
15
|
+
/**
|
|
16
|
+
* @inheritDoc
|
|
17
|
+
*/
|
|
18
|
+
constructor(view) {
|
|
19
|
+
super(view);
|
|
20
|
+
const doc = this.document;
|
|
21
|
+
doc.on('keydown', (evt, data) => {
|
|
22
|
+
if (!this.isEnabled ||
|
|
23
|
+
data.keyCode != keyCodes.tab ||
|
|
24
|
+
data.ctrlKey) {
|
|
25
|
+
return;
|
|
26
|
+
}
|
|
27
|
+
const event = new BubblingEventInfo(doc, 'tab', doc.selection.getFirstRange());
|
|
28
|
+
doc.fire(event, data);
|
|
29
|
+
if (event.stop.called) {
|
|
30
|
+
evt.stop();
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* @inheritDoc
|
|
36
|
+
*/
|
|
37
|
+
observe() { }
|
|
38
|
+
/**
|
|
39
|
+
* @inheritDoc
|
|
40
|
+
*/
|
|
41
|
+
stopObserving() { }
|
|
42
|
+
}
|