@ckeditor/ckeditor5-engine 0.0.0-internal-20241017.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/CHANGELOG.md +4 -0
- package/LICENSE.md +21 -0
- package/README.md +36 -0
- package/dist/controller/datacontroller.d.ts +339 -0
- package/dist/controller/editingcontroller.d.ts +102 -0
- package/dist/conversion/conversion.d.ts +482 -0
- package/dist/conversion/conversionhelpers.d.ts +30 -0
- package/dist/conversion/downcastdispatcher.d.ts +566 -0
- package/dist/conversion/downcasthelpers.d.ts +1194 -0
- package/dist/conversion/mapper.d.ts +507 -0
- package/dist/conversion/modelconsumable.d.ts +205 -0
- package/dist/conversion/upcastdispatcher.d.ts +496 -0
- package/dist/conversion/upcasthelpers.d.ts +503 -0
- package/dist/conversion/viewconsumable.d.ts +373 -0
- package/dist/dataprocessor/basichtmlwriter.d.ts +22 -0
- package/dist/dataprocessor/dataprocessor.d.ts +65 -0
- package/dist/dataprocessor/htmldataprocessor.d.ts +80 -0
- package/dist/dataprocessor/htmlwriter.d.ts +20 -0
- package/dist/dataprocessor/xmldataprocessor.d.ts +94 -0
- package/dist/dev-utils/model.d.ts +130 -0
- package/dist/dev-utils/operationreplayer.d.ts +55 -0
- package/dist/dev-utils/utils.d.ts +41 -0
- package/dist/dev-utils/view.d.ts +324 -0
- package/dist/index-content.css +4 -0
- package/dist/index-editor.css +24 -0
- package/dist/index.css +49 -0
- package/dist/index.css.map +1 -0
- package/dist/index.d.ts +122 -0
- package/dist/index.js +37775 -0
- package/dist/index.js.map +1 -0
- package/dist/model/batch.d.ts +110 -0
- package/dist/model/differ.d.ts +511 -0
- package/dist/model/document.d.ts +278 -0
- package/dist/model/documentfragment.d.ts +204 -0
- package/dist/model/documentselection.d.ts +424 -0
- package/dist/model/element.d.ts +169 -0
- package/dist/model/history.d.ts +118 -0
- package/dist/model/item.d.ts +18 -0
- package/dist/model/liveposition.d.ts +81 -0
- package/dist/model/liverange.d.ts +106 -0
- package/dist/model/markercollection.d.ts +339 -0
- package/dist/model/model.d.ts +923 -0
- package/dist/model/node.d.ts +259 -0
- package/dist/model/nodelist.d.ts +95 -0
- package/dist/model/operation/attributeoperation.d.ts +107 -0
- package/dist/model/operation/detachoperation.d.ts +64 -0
- package/dist/model/operation/insertoperation.d.ts +94 -0
- package/dist/model/operation/markeroperation.d.ts +95 -0
- package/dist/model/operation/mergeoperation.d.ts +104 -0
- package/dist/model/operation/moveoperation.d.ts +100 -0
- package/dist/model/operation/nooperation.d.ts +42 -0
- package/dist/model/operation/operation.d.ts +100 -0
- package/dist/model/operation/operationfactory.d.ts +22 -0
- package/dist/model/operation/renameoperation.d.ts +87 -0
- package/dist/model/operation/rootattributeoperation.d.ts +102 -0
- package/dist/model/operation/rootoperation.d.ts +80 -0
- package/dist/model/operation/splitoperation.d.ts +113 -0
- package/dist/model/operation/transform.d.ts +104 -0
- package/dist/model/operation/utils.d.ts +75 -0
- package/dist/model/position.d.ts +542 -0
- package/dist/model/range.d.ts +462 -0
- package/dist/model/rootelement.d.ts +64 -0
- package/dist/model/schema.d.ts +1334 -0
- package/dist/model/selection.d.ts +486 -0
- package/dist/model/text.d.ts +70 -0
- package/dist/model/textproxy.d.ts +148 -0
- package/dist/model/treewalker.d.ts +190 -0
- package/dist/model/typecheckable.d.ts +289 -0
- package/dist/model/utils/autoparagraphing.d.ts +41 -0
- package/dist/model/utils/deletecontent.d.ts +62 -0
- package/dist/model/utils/getselectedcontent.d.ts +34 -0
- package/dist/model/utils/insertcontent.d.ts +50 -0
- package/dist/model/utils/insertobject.d.ts +51 -0
- package/dist/model/utils/modifyselection.d.ts +52 -0
- package/dist/model/utils/selection-post-fixer.d.ts +78 -0
- package/dist/model/writer.d.ts +855 -0
- package/dist/view/attributeelement.d.ts +112 -0
- package/dist/view/containerelement.d.ts +53 -0
- package/dist/view/datatransfer.d.ts +83 -0
- package/dist/view/document.d.ts +188 -0
- package/dist/view/documentfragment.d.ts +157 -0
- package/dist/view/documentselection.d.ts +310 -0
- package/dist/view/domconverter.d.ts +665 -0
- package/dist/view/downcastwriter.d.ts +1000 -0
- package/dist/view/editableelement.d.ts +66 -0
- package/dist/view/element.d.ts +472 -0
- package/dist/view/elementdefinition.d.ts +91 -0
- package/dist/view/emptyelement.d.ts +45 -0
- package/dist/view/filler.d.ts +115 -0
- package/dist/view/item.d.ts +18 -0
- package/dist/view/matcher.d.ts +490 -0
- package/dist/view/node.d.ts +166 -0
- package/dist/view/observer/arrowkeysobserver.d.ts +49 -0
- package/dist/view/observer/bubblingemittermixin.d.ts +170 -0
- package/dist/view/observer/bubblingeventinfo.d.ts +51 -0
- package/dist/view/observer/clickobserver.d.ts +47 -0
- package/dist/view/observer/compositionobserver.d.ts +86 -0
- package/dist/view/observer/domeventdata.d.ts +54 -0
- package/dist/view/observer/domeventobserver.d.ts +82 -0
- package/dist/view/observer/fakeselectionobserver.d.ts +51 -0
- package/dist/view/observer/focusobserver.d.ts +98 -0
- package/dist/view/observer/inputobserver.d.ts +90 -0
- package/dist/view/observer/keyobserver.d.ts +70 -0
- package/dist/view/observer/mouseobserver.d.ts +93 -0
- package/dist/view/observer/mutationobserver.d.ts +119 -0
- package/dist/view/observer/observer.d.ts +93 -0
- package/dist/view/observer/selectionobserver.d.ts +151 -0
- package/dist/view/observer/tabobserver.d.ts +50 -0
- package/dist/view/placeholder.d.ts +100 -0
- package/dist/view/position.d.ts +192 -0
- package/dist/view/range.d.ts +283 -0
- package/dist/view/rawelement.d.ts +77 -0
- package/dist/view/renderer.d.ts +281 -0
- package/dist/view/rooteditableelement.d.ts +45 -0
- package/dist/view/selection.d.ts +379 -0
- package/dist/view/styles/background.d.ts +37 -0
- package/dist/view/styles/border.d.ts +47 -0
- package/dist/view/styles/margin.d.ts +33 -0
- package/dist/view/styles/padding.d.ts +33 -0
- package/dist/view/styles/utils.d.ts +97 -0
- package/dist/view/stylesmap.d.ts +677 -0
- package/dist/view/text.d.ts +78 -0
- package/dist/view/textproxy.d.ts +101 -0
- package/dist/view/treewalker.d.ts +199 -0
- package/dist/view/typecheckable.d.ts +452 -0
- package/dist/view/uielement.d.ts +100 -0
- package/dist/view/upcastwriter.d.ts +421 -0
- package/dist/view/view.d.ts +488 -0
- package/package.json +49 -0
- package/src/controller/datacontroller.d.ts +335 -0
- package/src/controller/datacontroller.js +481 -0
- package/src/controller/editingcontroller.d.ts +98 -0
- package/src/controller/editingcontroller.js +191 -0
- package/src/conversion/conversion.d.ts +478 -0
- package/src/conversion/conversion.js +601 -0
- package/src/conversion/conversionhelpers.d.ts +26 -0
- package/src/conversion/conversionhelpers.js +32 -0
- package/src/conversion/downcastdispatcher.d.ts +562 -0
- package/src/conversion/downcastdispatcher.js +548 -0
- package/src/conversion/downcasthelpers.d.ts +1190 -0
- package/src/conversion/downcasthelpers.js +2161 -0
- package/src/conversion/mapper.d.ts +503 -0
- package/src/conversion/mapper.js +536 -0
- package/src/conversion/modelconsumable.d.ts +201 -0
- package/src/conversion/modelconsumable.js +333 -0
- package/src/conversion/upcastdispatcher.d.ts +492 -0
- package/src/conversion/upcastdispatcher.js +460 -0
- package/src/conversion/upcasthelpers.d.ts +499 -0
- package/src/conversion/upcasthelpers.js +943 -0
- package/src/conversion/viewconsumable.d.ts +369 -0
- package/src/conversion/viewconsumable.js +535 -0
- package/src/dataprocessor/basichtmlwriter.d.ts +18 -0
- package/src/dataprocessor/basichtmlwriter.js +20 -0
- package/src/dataprocessor/dataprocessor.d.ts +61 -0
- package/src/dataprocessor/dataprocessor.js +5 -0
- package/src/dataprocessor/htmldataprocessor.d.ts +76 -0
- package/src/dataprocessor/htmldataprocessor.js +96 -0
- package/src/dataprocessor/htmlwriter.d.ts +16 -0
- package/src/dataprocessor/htmlwriter.js +5 -0
- package/src/dataprocessor/xmldataprocessor.d.ts +90 -0
- package/src/dataprocessor/xmldataprocessor.js +108 -0
- package/src/dev-utils/model.d.ts +126 -0
- package/src/dev-utils/model.js +397 -0
- package/src/dev-utils/operationreplayer.d.ts +51 -0
- package/src/dev-utils/operationreplayer.js +112 -0
- package/src/dev-utils/utils.d.ts +37 -0
- package/src/dev-utils/utils.js +80 -0
- package/src/dev-utils/view.d.ts +320 -0
- package/src/dev-utils/view.js +970 -0
- package/src/index.d.ts +118 -0
- package/src/index.js +83 -0
- package/src/model/batch.d.ts +106 -0
- package/src/model/batch.js +96 -0
- package/src/model/differ.d.ts +507 -0
- package/src/model/differ.js +1285 -0
- package/src/model/document.d.ts +274 -0
- package/src/model/document.js +360 -0
- package/src/model/documentfragment.d.ts +200 -0
- package/src/model/documentfragment.js +306 -0
- package/src/model/documentselection.d.ts +420 -0
- package/src/model/documentselection.js +993 -0
- package/src/model/element.d.ts +165 -0
- package/src/model/element.js +281 -0
- package/src/model/history.d.ts +114 -0
- package/src/model/history.js +207 -0
- package/src/model/item.d.ts +14 -0
- package/src/model/item.js +5 -0
- package/src/model/liveposition.d.ts +77 -0
- package/src/model/liveposition.js +93 -0
- package/src/model/liverange.d.ts +102 -0
- package/src/model/liverange.js +120 -0
- package/src/model/markercollection.d.ts +335 -0
- package/src/model/markercollection.js +403 -0
- package/src/model/model.d.ts +919 -0
- package/src/model/model.js +838 -0
- package/src/model/node.d.ts +255 -0
- package/src/model/node.js +373 -0
- package/src/model/nodelist.d.ts +91 -0
- package/src/model/nodelist.js +170 -0
- package/src/model/operation/attributeoperation.d.ts +103 -0
- package/src/model/operation/attributeoperation.js +148 -0
- package/src/model/operation/detachoperation.d.ts +60 -0
- package/src/model/operation/detachoperation.js +77 -0
- package/src/model/operation/insertoperation.d.ts +90 -0
- package/src/model/operation/insertoperation.js +135 -0
- package/src/model/operation/markeroperation.d.ts +91 -0
- package/src/model/operation/markeroperation.js +107 -0
- package/src/model/operation/mergeoperation.d.ts +100 -0
- package/src/model/operation/mergeoperation.js +167 -0
- package/src/model/operation/moveoperation.d.ts +96 -0
- package/src/model/operation/moveoperation.js +164 -0
- package/src/model/operation/nooperation.d.ts +38 -0
- package/src/model/operation/nooperation.js +48 -0
- package/src/model/operation/operation.d.ts +96 -0
- package/src/model/operation/operation.js +59 -0
- package/src/model/operation/operationfactory.d.ts +18 -0
- package/src/model/operation/operationfactory.js +44 -0
- package/src/model/operation/renameoperation.d.ts +83 -0
- package/src/model/operation/renameoperation.js +115 -0
- package/src/model/operation/rootattributeoperation.d.ts +98 -0
- package/src/model/operation/rootattributeoperation.js +155 -0
- package/src/model/operation/rootoperation.d.ts +76 -0
- package/src/model/operation/rootoperation.js +90 -0
- package/src/model/operation/splitoperation.d.ts +109 -0
- package/src/model/operation/splitoperation.js +194 -0
- package/src/model/operation/transform.d.ts +100 -0
- package/src/model/operation/transform.js +2119 -0
- package/src/model/operation/utils.d.ts +71 -0
- package/src/model/operation/utils.js +217 -0
- package/src/model/position.d.ts +538 -0
- package/src/model/position.js +977 -0
- package/src/model/range.d.ts +458 -0
- package/src/model/range.js +872 -0
- package/src/model/rootelement.d.ts +60 -0
- package/src/model/rootelement.js +74 -0
- package/src/model/schema.d.ts +1330 -0
- package/src/model/schema.js +1524 -0
- package/src/model/selection.d.ts +482 -0
- package/src/model/selection.js +789 -0
- package/src/model/text.d.ts +66 -0
- package/src/model/text.js +85 -0
- package/src/model/textproxy.d.ts +144 -0
- package/src/model/textproxy.js +189 -0
- package/src/model/treewalker.d.ts +186 -0
- package/src/model/treewalker.js +244 -0
- package/src/model/typecheckable.d.ts +285 -0
- package/src/model/typecheckable.js +16 -0
- package/src/model/utils/autoparagraphing.d.ts +37 -0
- package/src/model/utils/autoparagraphing.js +63 -0
- package/src/model/utils/deletecontent.d.ts +58 -0
- package/src/model/utils/deletecontent.js +488 -0
- package/src/model/utils/getselectedcontent.d.ts +30 -0
- package/src/model/utils/getselectedcontent.js +125 -0
- package/src/model/utils/insertcontent.d.ts +46 -0
- package/src/model/utils/insertcontent.js +661 -0
- package/src/model/utils/insertobject.d.ts +47 -0
- package/src/model/utils/insertobject.js +135 -0
- package/src/model/utils/modifyselection.d.ts +48 -0
- package/src/model/utils/modifyselection.js +186 -0
- package/src/model/utils/selection-post-fixer.d.ts +74 -0
- package/src/model/utils/selection-post-fixer.js +260 -0
- package/src/model/writer.d.ts +851 -0
- package/src/model/writer.js +1306 -0
- package/src/view/attributeelement.d.ts +108 -0
- package/src/view/attributeelement.js +185 -0
- package/src/view/containerelement.d.ts +49 -0
- package/src/view/containerelement.js +80 -0
- package/src/view/datatransfer.d.ts +79 -0
- package/src/view/datatransfer.js +98 -0
- package/src/view/document.d.ts +184 -0
- package/src/view/document.js +122 -0
- package/src/view/documentfragment.d.ts +153 -0
- package/src/view/documentfragment.js +234 -0
- package/src/view/documentselection.d.ts +306 -0
- package/src/view/documentselection.js +256 -0
- package/src/view/domconverter.d.ts +661 -0
- package/src/view/domconverter.js +1523 -0
- package/src/view/downcastwriter.d.ts +996 -0
- package/src/view/downcastwriter.js +1696 -0
- package/src/view/editableelement.d.ts +62 -0
- package/src/view/editableelement.js +62 -0
- package/src/view/element.d.ts +468 -0
- package/src/view/element.js +724 -0
- package/src/view/elementdefinition.d.ts +87 -0
- package/src/view/elementdefinition.js +5 -0
- package/src/view/emptyelement.d.ts +41 -0
- package/src/view/emptyelement.js +73 -0
- package/src/view/filler.d.ts +111 -0
- package/src/view/filler.js +150 -0
- package/src/view/item.d.ts +14 -0
- package/src/view/item.js +5 -0
- package/src/view/matcher.d.ts +486 -0
- package/src/view/matcher.js +507 -0
- package/src/view/node.d.ts +162 -0
- package/src/view/node.js +226 -0
- package/src/view/observer/arrowkeysobserver.d.ts +45 -0
- package/src/view/observer/arrowkeysobserver.js +40 -0
- package/src/view/observer/bubblingemittermixin.d.ts +166 -0
- package/src/view/observer/bubblingemittermixin.js +172 -0
- package/src/view/observer/bubblingeventinfo.d.ts +47 -0
- package/src/view/observer/bubblingeventinfo.js +37 -0
- package/src/view/observer/clickobserver.d.ts +43 -0
- package/src/view/observer/clickobserver.js +29 -0
- package/src/view/observer/compositionobserver.d.ts +82 -0
- package/src/view/observer/compositionobserver.js +62 -0
- package/src/view/observer/domeventdata.d.ts +50 -0
- package/src/view/observer/domeventdata.js +47 -0
- package/src/view/observer/domeventobserver.d.ts +78 -0
- package/src/view/observer/domeventobserver.js +84 -0
- package/src/view/observer/fakeselectionobserver.d.ts +47 -0
- package/src/view/observer/fakeselectionobserver.js +91 -0
- package/src/view/observer/focusobserver.d.ts +94 -0
- package/src/view/observer/focusobserver.js +116 -0
- package/src/view/observer/inputobserver.d.ts +86 -0
- package/src/view/observer/inputobserver.js +166 -0
- package/src/view/observer/keyobserver.d.ts +66 -0
- package/src/view/observer/keyobserver.js +39 -0
- package/src/view/observer/mouseobserver.d.ts +89 -0
- package/src/view/observer/mouseobserver.js +29 -0
- package/src/view/observer/mutationobserver.d.ts +115 -0
- package/src/view/observer/mutationobserver.js +203 -0
- package/src/view/observer/observer.d.ts +89 -0
- package/src/view/observer/observer.js +84 -0
- package/src/view/observer/selectionobserver.d.ts +147 -0
- package/src/view/observer/selectionobserver.js +220 -0
- package/src/view/observer/tabobserver.d.ts +46 -0
- package/src/view/observer/tabobserver.js +42 -0
- package/src/view/placeholder.d.ts +96 -0
- package/src/view/placeholder.js +267 -0
- package/src/view/position.d.ts +188 -0
- package/src/view/position.js +322 -0
- package/src/view/range.d.ts +279 -0
- package/src/view/range.js +430 -0
- package/src/view/rawelement.d.ts +73 -0
- package/src/view/rawelement.js +105 -0
- package/src/view/renderer.d.ts +277 -0
- package/src/view/renderer.js +1056 -0
- package/src/view/rooteditableelement.d.ts +41 -0
- package/src/view/rooteditableelement.js +69 -0
- package/src/view/selection.d.ts +375 -0
- package/src/view/selection.js +559 -0
- package/src/view/styles/background.d.ts +33 -0
- package/src/view/styles/background.js +74 -0
- package/src/view/styles/border.d.ts +43 -0
- package/src/view/styles/border.js +316 -0
- package/src/view/styles/margin.d.ts +29 -0
- package/src/view/styles/margin.js +34 -0
- package/src/view/styles/padding.d.ts +29 -0
- package/src/view/styles/padding.js +34 -0
- package/src/view/styles/utils.d.ts +93 -0
- package/src/view/styles/utils.js +219 -0
- package/src/view/stylesmap.d.ts +673 -0
- package/src/view/stylesmap.js +762 -0
- package/src/view/text.d.ts +74 -0
- package/src/view/text.js +93 -0
- package/src/view/textproxy.d.ts +97 -0
- package/src/view/textproxy.js +124 -0
- package/src/view/treewalker.d.ts +195 -0
- package/src/view/treewalker.js +327 -0
- package/src/view/typecheckable.d.ts +448 -0
- package/src/view/typecheckable.js +19 -0
- package/src/view/uielement.d.ts +96 -0
- package/src/view/uielement.js +183 -0
- package/src/view/upcastwriter.d.ts +417 -0
- package/src/view/upcastwriter.js +359 -0
- package/src/view/view.d.ts +484 -0
- package/src/view/view.js +560 -0
- package/theme/placeholder.css +36 -0
- package/theme/renderer.css +9 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/bubblingeventinfo
|
|
7
|
+
*/
|
|
8
|
+
import { EventInfo } from '@ckeditor/ckeditor5-utils';
|
|
9
|
+
/**
|
|
10
|
+
* The event object passed to bubbling event callbacks. It is used to provide information about the event as well as a tool to
|
|
11
|
+
* manipulate it.
|
|
12
|
+
*/
|
|
13
|
+
export default class BubblingEventInfo extends EventInfo {
|
|
14
|
+
/**
|
|
15
|
+
* @param source The emitter.
|
|
16
|
+
* @param name The event name.
|
|
17
|
+
* @param startRange The view range that the bubbling should start from.
|
|
18
|
+
*/
|
|
19
|
+
constructor(source, name, startRange) {
|
|
20
|
+
super(source, name);
|
|
21
|
+
this.startRange = startRange;
|
|
22
|
+
this._eventPhase = 'none';
|
|
23
|
+
this._currentTarget = null;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* The current event phase.
|
|
27
|
+
*/
|
|
28
|
+
get eventPhase() {
|
|
29
|
+
return this._eventPhase;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The current bubbling target.
|
|
33
|
+
*/
|
|
34
|
+
get currentTarget() {
|
|
35
|
+
return this._currentTarget;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/clickobserver
|
|
7
|
+
*/
|
|
8
|
+
import DomEventObserver from './domeventobserver.js';
|
|
9
|
+
import type DomEventData from './domeventdata.js';
|
|
10
|
+
import type { BubblingEvent } from './bubblingemittermixin.js';
|
|
11
|
+
/**
|
|
12
|
+
* {@link module:engine/view/document~Document#event:click Click} event observer.
|
|
13
|
+
*
|
|
14
|
+
* Note that this observer is not available by default. To make it available it needs to be added to
|
|
15
|
+
* {@link module:engine/view/view~View view controller} by a {@link module:engine/view/view~View#addObserver} method.
|
|
16
|
+
*/
|
|
17
|
+
export default class ClickObserver extends DomEventObserver<'click'> {
|
|
18
|
+
/**
|
|
19
|
+
* @inheritDoc
|
|
20
|
+
*/
|
|
21
|
+
readonly domEventType: "click";
|
|
22
|
+
/**
|
|
23
|
+
* @inheritDoc
|
|
24
|
+
*/
|
|
25
|
+
onDomEvent(domEvent: MouseEvent): void;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Fired when one of the editables has been clicked.
|
|
29
|
+
*
|
|
30
|
+
* Introduced by {@link module:engine/view/observer/clickobserver~ClickObserver}.
|
|
31
|
+
*
|
|
32
|
+
* Note that this event is not available by default. To make it available
|
|
33
|
+
* {@link module:engine/view/observer/clickobserver~ClickObserver} needs to be added
|
|
34
|
+
* to {@link module:engine/view/view~View} by a {@link module:engine/view/view~View#addObserver} method.
|
|
35
|
+
*
|
|
36
|
+
* @see module:engine/view/observer/clickobserver~ClickObserver
|
|
37
|
+
* @eventName module:engine/view/document~Document#click
|
|
38
|
+
* @param data Event data.
|
|
39
|
+
*/
|
|
40
|
+
export type ViewDocumentClickEvent = BubblingEvent<{
|
|
41
|
+
name: 'click';
|
|
42
|
+
args: [data: DomEventData<MouseEvent>];
|
|
43
|
+
}>;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/clickobserver
|
|
7
|
+
*/
|
|
8
|
+
import DomEventObserver from './domeventobserver.js';
|
|
9
|
+
/**
|
|
10
|
+
* {@link module:engine/view/document~Document#event:click Click} event observer.
|
|
11
|
+
*
|
|
12
|
+
* Note that this observer is not available by default. To make it available it needs to be added to
|
|
13
|
+
* {@link module:engine/view/view~View view controller} by a {@link module:engine/view/view~View#addObserver} method.
|
|
14
|
+
*/
|
|
15
|
+
export default class ClickObserver extends DomEventObserver {
|
|
16
|
+
constructor() {
|
|
17
|
+
super(...arguments);
|
|
18
|
+
/**
|
|
19
|
+
* @inheritDoc
|
|
20
|
+
*/
|
|
21
|
+
this.domEventType = 'click';
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @inheritDoc
|
|
25
|
+
*/
|
|
26
|
+
onDomEvent(domEvent) {
|
|
27
|
+
this.fire(domEvent.type, domEvent);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/compositionobserver
|
|
7
|
+
*/
|
|
8
|
+
import DomEventObserver from './domeventobserver.js';
|
|
9
|
+
import type View from '../view.js';
|
|
10
|
+
import type DomEventData from './domeventdata.js';
|
|
11
|
+
/**
|
|
12
|
+
* {@link module:engine/view/document~Document#event:compositionstart Compositionstart},
|
|
13
|
+
* {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and
|
|
14
|
+
* {@link module:engine/view/document~Document#event:compositionend compositionend} events observer.
|
|
15
|
+
*
|
|
16
|
+
* Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
|
|
17
|
+
*/
|
|
18
|
+
export default class CompositionObserver extends DomEventObserver<'compositionstart' | 'compositionupdate' | 'compositionend'> {
|
|
19
|
+
/**
|
|
20
|
+
* @inheritDoc
|
|
21
|
+
*/
|
|
22
|
+
readonly domEventType: readonly ["compositionstart", "compositionupdate", "compositionend"];
|
|
23
|
+
/**
|
|
24
|
+
* @inheritDoc
|
|
25
|
+
*/
|
|
26
|
+
constructor(view: View);
|
|
27
|
+
/**
|
|
28
|
+
* @inheritDoc
|
|
29
|
+
*/
|
|
30
|
+
onDomEvent(domEvent: CompositionEvent): void;
|
|
31
|
+
}
|
|
32
|
+
export interface CompositionEventData extends DomEventData<CompositionEvent> {
|
|
33
|
+
data: string | null;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Fired when composition starts inside one of the editables.
|
|
37
|
+
*
|
|
38
|
+
* Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
|
|
39
|
+
*
|
|
40
|
+
* Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
|
|
41
|
+
* {@link module:engine/view/view~View} this event is available by default.
|
|
42
|
+
*
|
|
43
|
+
* @see module:engine/view/observer/compositionobserver~CompositionObserver
|
|
44
|
+
* @eventName module:engine/view/document~Document#compositionstart
|
|
45
|
+
* @param data Event data.
|
|
46
|
+
*/
|
|
47
|
+
export type ViewDocumentCompositionStartEvent = {
|
|
48
|
+
name: 'compositionstart';
|
|
49
|
+
args: [data: CompositionEventData];
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* Fired when composition is updated inside one of the editables.
|
|
53
|
+
*
|
|
54
|
+
* Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
|
|
55
|
+
*
|
|
56
|
+
* Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
|
|
57
|
+
* {@link module:engine/view/view~View} this event is available by default.
|
|
58
|
+
*
|
|
59
|
+
* @see module:engine/view/observer/compositionobserver~CompositionObserver
|
|
60
|
+
* @eventName module:engine/view/document~Document#compositionupdate
|
|
61
|
+
* @param data Event data.
|
|
62
|
+
*/
|
|
63
|
+
export type ViewDocumentCompositionUpdateEvent = {
|
|
64
|
+
name: 'compositionupdate';
|
|
65
|
+
args: [data: CompositionEventData];
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* Fired when composition ends inside one of the editables.
|
|
69
|
+
*
|
|
70
|
+
* Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
|
|
71
|
+
*
|
|
72
|
+
* Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the
|
|
73
|
+
* {@link module:engine/view/view~View} this event is available by default.
|
|
74
|
+
*
|
|
75
|
+
* @see module:engine/view/observer/compositionobserver~CompositionObserver
|
|
76
|
+
* @eventName module:engine/view/document~Document#compositionend
|
|
77
|
+
* @param data Event data.
|
|
78
|
+
*/
|
|
79
|
+
export type ViewDocumentCompositionEndEvent = {
|
|
80
|
+
name: 'compositionend';
|
|
81
|
+
args: [data: CompositionEventData];
|
|
82
|
+
};
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/compositionobserver
|
|
7
|
+
*/
|
|
8
|
+
import DomEventObserver from './domeventobserver.js';
|
|
9
|
+
// @if CK_DEBUG_TYPING // const { _debouncedLine } = require( '../../dev-utils/utils.js' );
|
|
10
|
+
/**
|
|
11
|
+
* {@link module:engine/view/document~Document#event:compositionstart Compositionstart},
|
|
12
|
+
* {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and
|
|
13
|
+
* {@link module:engine/view/document~Document#event:compositionend compositionend} events observer.
|
|
14
|
+
*
|
|
15
|
+
* Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
|
|
16
|
+
*/
|
|
17
|
+
export default class CompositionObserver extends DomEventObserver {
|
|
18
|
+
/**
|
|
19
|
+
* @inheritDoc
|
|
20
|
+
*/
|
|
21
|
+
constructor(view) {
|
|
22
|
+
super(view);
|
|
23
|
+
/**
|
|
24
|
+
* @inheritDoc
|
|
25
|
+
*/
|
|
26
|
+
this.domEventType = ['compositionstart', 'compositionupdate', 'compositionend'];
|
|
27
|
+
const document = this.document;
|
|
28
|
+
document.on('compositionstart', () => {
|
|
29
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
30
|
+
// @if CK_DEBUG_TYPING // console.log( '%c[CompositionObserver] ' +
|
|
31
|
+
// @if CK_DEBUG_TYPING // '┌───────────────────────────── isComposing = true ─────────────────────────────┐',
|
|
32
|
+
// @if CK_DEBUG_TYPING // 'font-weight: bold; color: green'
|
|
33
|
+
// @if CK_DEBUG_TYPING // );
|
|
34
|
+
// @if CK_DEBUG_TYPING // }
|
|
35
|
+
document.isComposing = true;
|
|
36
|
+
}, { priority: 'low' });
|
|
37
|
+
document.on('compositionend', () => {
|
|
38
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
39
|
+
// @if CK_DEBUG_TYPING // console.log( '%c[CompositionObserver] ' +
|
|
40
|
+
// @if CK_DEBUG_TYPING // '└───────────────────────────── isComposing = false ─────────────────────────────┘',
|
|
41
|
+
// @if CK_DEBUG_TYPING // 'font-weight: bold; color: green'
|
|
42
|
+
// @if CK_DEBUG_TYPING // );
|
|
43
|
+
// @if CK_DEBUG_TYPING // }
|
|
44
|
+
document.isComposing = false;
|
|
45
|
+
}, { priority: 'low' });
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* @inheritDoc
|
|
49
|
+
*/
|
|
50
|
+
onDomEvent(domEvent) {
|
|
51
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
52
|
+
// @if CK_DEBUG_TYPING // _debouncedLine();
|
|
53
|
+
// @if CK_DEBUG_TYPING // console.group( `%c[CompositionObserver]%c ${ domEvent.type }`, 'color: green', '' );
|
|
54
|
+
// @if CK_DEBUG_TYPING // }
|
|
55
|
+
this.fire(domEvent.type, domEvent, {
|
|
56
|
+
data: domEvent.data
|
|
57
|
+
});
|
|
58
|
+
// @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
|
|
59
|
+
// @if CK_DEBUG_TYPING // console.groupEnd();
|
|
60
|
+
// @if CK_DEBUG_TYPING // }
|
|
61
|
+
}
|
|
62
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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 type Document from '../document.js';
|
|
6
|
+
import type Element from '../element.js';
|
|
7
|
+
import type View from '../view.js';
|
|
8
|
+
/**
|
|
9
|
+
* Information about a DOM event in context of the {@link module:engine/view/document~Document}.
|
|
10
|
+
* It wraps the native event, which usually should not be used as the wrapper contains
|
|
11
|
+
* additional data (like key code for keyboard events).
|
|
12
|
+
*
|
|
13
|
+
* @typeParam TEvent The type of DOM Event that this class represents.
|
|
14
|
+
*/
|
|
15
|
+
export default class DomEventData<TEvent extends Event = Event> {
|
|
16
|
+
/**
|
|
17
|
+
* Instance of the view controller.
|
|
18
|
+
*/
|
|
19
|
+
readonly view: View;
|
|
20
|
+
/**
|
|
21
|
+
* The instance of the document.
|
|
22
|
+
*/
|
|
23
|
+
readonly document: Document;
|
|
24
|
+
/**
|
|
25
|
+
* The DOM event.
|
|
26
|
+
*/
|
|
27
|
+
readonly domEvent: TEvent;
|
|
28
|
+
/**
|
|
29
|
+
* The DOM target.
|
|
30
|
+
*/
|
|
31
|
+
readonly domTarget: HTMLElement;
|
|
32
|
+
/**
|
|
33
|
+
* @param view The instance of the view controller.
|
|
34
|
+
* @param domEvent The DOM event.
|
|
35
|
+
* @param additionalData Additional properties that the instance should contain.
|
|
36
|
+
*/
|
|
37
|
+
constructor(view: View, domEvent: TEvent, additionalData?: object);
|
|
38
|
+
/**
|
|
39
|
+
* The tree view element representing the target.
|
|
40
|
+
*/
|
|
41
|
+
get target(): Element;
|
|
42
|
+
/**
|
|
43
|
+
* Prevents the native's event default action.
|
|
44
|
+
*/
|
|
45
|
+
preventDefault(): void;
|
|
46
|
+
/**
|
|
47
|
+
* Stops native event propagation.
|
|
48
|
+
*/
|
|
49
|
+
stopPropagation(): void;
|
|
50
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/domeventdata
|
|
7
|
+
*/
|
|
8
|
+
import { extend } from 'lodash-es';
|
|
9
|
+
/**
|
|
10
|
+
* Information about a DOM event in context of the {@link module:engine/view/document~Document}.
|
|
11
|
+
* It wraps the native event, which usually should not be used as the wrapper contains
|
|
12
|
+
* additional data (like key code for keyboard events).
|
|
13
|
+
*
|
|
14
|
+
* @typeParam TEvent The type of DOM Event that this class represents.
|
|
15
|
+
*/
|
|
16
|
+
export default class DomEventData {
|
|
17
|
+
/**
|
|
18
|
+
* @param view The instance of the view controller.
|
|
19
|
+
* @param domEvent The DOM event.
|
|
20
|
+
* @param additionalData Additional properties that the instance should contain.
|
|
21
|
+
*/
|
|
22
|
+
constructor(view, domEvent, additionalData) {
|
|
23
|
+
this.view = view;
|
|
24
|
+
this.document = view.document;
|
|
25
|
+
this.domEvent = domEvent;
|
|
26
|
+
this.domTarget = domEvent.target;
|
|
27
|
+
extend(this, additionalData);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* The tree view element representing the target.
|
|
31
|
+
*/
|
|
32
|
+
get target() {
|
|
33
|
+
return this.view.domConverter.mapDomToView(this.domTarget);
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Prevents the native's event default action.
|
|
37
|
+
*/
|
|
38
|
+
preventDefault() {
|
|
39
|
+
this.domEvent.preventDefault();
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Stops native event propagation.
|
|
43
|
+
*/
|
|
44
|
+
stopPropagation() {
|
|
45
|
+
this.domEvent.stopPropagation();
|
|
46
|
+
}
|
|
47
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/domeventobserver
|
|
7
|
+
*/
|
|
8
|
+
import Observer from './observer.js';
|
|
9
|
+
import type { EventInfo } from '@ckeditor/ckeditor5-utils';
|
|
10
|
+
/**
|
|
11
|
+
* Base class for DOM event observers. This class handles
|
|
12
|
+
* {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
|
|
13
|
+
* {@link module:engine/view/observer/observer~Observer#disable disabling} and
|
|
14
|
+
* {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
|
|
15
|
+
* Child class needs to define
|
|
16
|
+
* {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
|
|
17
|
+
* {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
|
|
18
|
+
*
|
|
19
|
+
* For instance:
|
|
20
|
+
*
|
|
21
|
+
* ```ts
|
|
22
|
+
* class ClickObserver extends DomEventObserver<'click'> {
|
|
23
|
+
* // It can also be defined as a normal property in the constructor.
|
|
24
|
+
* get domEventType(): 'click' {
|
|
25
|
+
* return 'click';
|
|
26
|
+
* }
|
|
27
|
+
*
|
|
28
|
+
* onDomEvent( domEvent: MouseEvent ): void {
|
|
29
|
+
* this.fire( 'click', domEvent );
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* @typeParam EventType DOM Event type name or an union of those.
|
|
35
|
+
* @typeParam AdditionalData Additional data passed along with the event.
|
|
36
|
+
*/
|
|
37
|
+
export default abstract class DomEventObserver<EventType extends keyof HTMLElementEventMap, AdditionalData extends object = object> extends Observer {
|
|
38
|
+
/**
|
|
39
|
+
* Type of the DOM event the observer should listen to. Array of types can be defined
|
|
40
|
+
* if the observer should listen to multiple DOM events.
|
|
41
|
+
*/
|
|
42
|
+
abstract get domEventType(): EventType | ReadonlyArray<EventType>;
|
|
43
|
+
/**
|
|
44
|
+
* If set to `true` DOM events will be listened on the capturing phase.
|
|
45
|
+
* Default value is `false`.
|
|
46
|
+
*/
|
|
47
|
+
useCapture: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* If set to `true`, indicates that the function specified by listener will never call `preventDefault()`.
|
|
50
|
+
* Default value is `false`.
|
|
51
|
+
*/
|
|
52
|
+
usePassive: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Callback which should be called when the DOM event occurred. Note that the callback will not be called if
|
|
55
|
+
* observer {@link #isEnabled is not enabled}.
|
|
56
|
+
*
|
|
57
|
+
* @see #domEventType
|
|
58
|
+
*/
|
|
59
|
+
abstract onDomEvent(event: HTMLElementEventMap[EventType]): void;
|
|
60
|
+
/**
|
|
61
|
+
* @inheritDoc
|
|
62
|
+
*/
|
|
63
|
+
observe(domElement: HTMLElement): void;
|
|
64
|
+
/**
|
|
65
|
+
* @inheritDoc
|
|
66
|
+
*/
|
|
67
|
+
stopObserving(domElement: HTMLElement): void;
|
|
68
|
+
/**
|
|
69
|
+
* Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
|
|
70
|
+
*
|
|
71
|
+
* @see module:utils/emittermixin~Emitter#fire
|
|
72
|
+
* @param eventType The event type (name).
|
|
73
|
+
* @param domEvent The DOM event.
|
|
74
|
+
* @param additionalData The additional data which should extend the
|
|
75
|
+
* {@link module:engine/view/observer/domeventdata~DomEventData event data} object.
|
|
76
|
+
*/
|
|
77
|
+
fire(eventType: string | EventInfo, domEvent: Event, additionalData?: AdditionalData): void;
|
|
78
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/domeventobserver
|
|
7
|
+
*/
|
|
8
|
+
import Observer from './observer.js';
|
|
9
|
+
import DomEventData from './domeventdata.js';
|
|
10
|
+
/**
|
|
11
|
+
* Base class for DOM event observers. This class handles
|
|
12
|
+
* {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
|
|
13
|
+
* {@link module:engine/view/observer/observer~Observer#disable disabling} and
|
|
14
|
+
* {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
|
|
15
|
+
* Child class needs to define
|
|
16
|
+
* {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
|
|
17
|
+
* {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
|
|
18
|
+
*
|
|
19
|
+
* For instance:
|
|
20
|
+
*
|
|
21
|
+
* ```ts
|
|
22
|
+
* class ClickObserver extends DomEventObserver<'click'> {
|
|
23
|
+
* // It can also be defined as a normal property in the constructor.
|
|
24
|
+
* get domEventType(): 'click' {
|
|
25
|
+
* return 'click';
|
|
26
|
+
* }
|
|
27
|
+
*
|
|
28
|
+
* onDomEvent( domEvent: MouseEvent ): void {
|
|
29
|
+
* this.fire( 'click', domEvent );
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* @typeParam EventType DOM Event type name or an union of those.
|
|
35
|
+
* @typeParam AdditionalData Additional data passed along with the event.
|
|
36
|
+
*/
|
|
37
|
+
export default class DomEventObserver extends Observer {
|
|
38
|
+
constructor() {
|
|
39
|
+
super(...arguments);
|
|
40
|
+
/**
|
|
41
|
+
* If set to `true` DOM events will be listened on the capturing phase.
|
|
42
|
+
* Default value is `false`.
|
|
43
|
+
*/
|
|
44
|
+
this.useCapture = false;
|
|
45
|
+
/**
|
|
46
|
+
* If set to `true`, indicates that the function specified by listener will never call `preventDefault()`.
|
|
47
|
+
* Default value is `false`.
|
|
48
|
+
*/
|
|
49
|
+
this.usePassive = false;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @inheritDoc
|
|
53
|
+
*/
|
|
54
|
+
observe(domElement) {
|
|
55
|
+
const types = typeof this.domEventType == 'string' ? [this.domEventType] : this.domEventType;
|
|
56
|
+
types.forEach(type => {
|
|
57
|
+
this.listenTo(domElement, type, (eventInfo, domEvent) => {
|
|
58
|
+
if (this.isEnabled && !this.checkShouldIgnoreEventFromTarget(domEvent.target)) {
|
|
59
|
+
this.onDomEvent(domEvent);
|
|
60
|
+
}
|
|
61
|
+
}, { useCapture: this.useCapture, usePassive: this.usePassive });
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* @inheritDoc
|
|
66
|
+
*/
|
|
67
|
+
stopObserving(domElement) {
|
|
68
|
+
this.stopListening(domElement);
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
|
|
72
|
+
*
|
|
73
|
+
* @see module:utils/emittermixin~Emitter#fire
|
|
74
|
+
* @param eventType The event type (name).
|
|
75
|
+
* @param domEvent The DOM event.
|
|
76
|
+
* @param additionalData The additional data which should extend the
|
|
77
|
+
* {@link module:engine/view/observer/domeventdata~DomEventData event data} object.
|
|
78
|
+
*/
|
|
79
|
+
fire(eventType, domEvent, additionalData) {
|
|
80
|
+
if (this.isEnabled) {
|
|
81
|
+
this.document.fire(eventType, new DomEventData(this.view, domEvent, additionalData));
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/fakeselectionobserver
|
|
7
|
+
*/
|
|
8
|
+
import Observer from './observer.js';
|
|
9
|
+
import type View from '../view.js';
|
|
10
|
+
/**
|
|
11
|
+
* Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
|
|
12
|
+
* on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
|
|
13
|
+
* if arrow keys are pressed.
|
|
14
|
+
* Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
|
|
15
|
+
* {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
|
|
16
|
+
*/
|
|
17
|
+
export default class FakeSelectionObserver extends Observer {
|
|
18
|
+
/**
|
|
19
|
+
* Fires debounced event `selectionChangeDone`. It uses `lodash#debounce` method to delay function call.
|
|
20
|
+
*/
|
|
21
|
+
private readonly _fireSelectionChangeDoneDebounced;
|
|
22
|
+
/**
|
|
23
|
+
* Creates new FakeSelectionObserver instance.
|
|
24
|
+
*/
|
|
25
|
+
constructor(view: View);
|
|
26
|
+
/**
|
|
27
|
+
* @inheritDoc
|
|
28
|
+
*/
|
|
29
|
+
observe(): void;
|
|
30
|
+
/**
|
|
31
|
+
* @inheritDoc
|
|
32
|
+
*/
|
|
33
|
+
stopObserving(): void;
|
|
34
|
+
/**
|
|
35
|
+
* @inheritDoc
|
|
36
|
+
*/
|
|
37
|
+
destroy(): void;
|
|
38
|
+
/**
|
|
39
|
+
* Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
|
|
40
|
+
* collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
|
|
41
|
+
*
|
|
42
|
+
* This method fires {@link module:engine/view/document~Document#event:selectionChange} and
|
|
43
|
+
* {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
|
|
44
|
+
* {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
|
|
45
|
+
*/
|
|
46
|
+
private _handleSelectionMove;
|
|
47
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2024, 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/fakeselectionobserver
|
|
7
|
+
*/
|
|
8
|
+
import Observer from './observer.js';
|
|
9
|
+
import ViewSelection from '../selection.js';
|
|
10
|
+
import { keyCodes } from '@ckeditor/ckeditor5-utils';
|
|
11
|
+
import { debounce } from 'lodash-es';
|
|
12
|
+
/**
|
|
13
|
+
* Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
|
|
14
|
+
* on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
|
|
15
|
+
* if arrow keys are pressed.
|
|
16
|
+
* Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
|
|
17
|
+
* {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
|
|
18
|
+
*/
|
|
19
|
+
export default class FakeSelectionObserver extends Observer {
|
|
20
|
+
/**
|
|
21
|
+
* Creates new FakeSelectionObserver instance.
|
|
22
|
+
*/
|
|
23
|
+
constructor(view) {
|
|
24
|
+
super(view);
|
|
25
|
+
this._fireSelectionChangeDoneDebounced = debounce(data => {
|
|
26
|
+
this.document.fire('selectionChangeDone', data);
|
|
27
|
+
}, 200);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* @inheritDoc
|
|
31
|
+
*/
|
|
32
|
+
observe() {
|
|
33
|
+
const document = this.document;
|
|
34
|
+
document.on('arrowKey', (eventInfo, data) => {
|
|
35
|
+
const selection = document.selection;
|
|
36
|
+
if (selection.isFake && this.isEnabled) {
|
|
37
|
+
// Prevents default key down handling - no selection change will occur.
|
|
38
|
+
data.preventDefault();
|
|
39
|
+
}
|
|
40
|
+
}, { context: '$capture' });
|
|
41
|
+
document.on('arrowKey', (eventInfo, data) => {
|
|
42
|
+
const selection = document.selection;
|
|
43
|
+
if (selection.isFake && this.isEnabled) {
|
|
44
|
+
this._handleSelectionMove(data.keyCode);
|
|
45
|
+
}
|
|
46
|
+
}, { priority: 'lowest' });
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* @inheritDoc
|
|
50
|
+
*/
|
|
51
|
+
stopObserving() { }
|
|
52
|
+
/**
|
|
53
|
+
* @inheritDoc
|
|
54
|
+
*/
|
|
55
|
+
destroy() {
|
|
56
|
+
super.destroy();
|
|
57
|
+
this._fireSelectionChangeDoneDebounced.cancel();
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
|
|
61
|
+
* collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
|
|
62
|
+
*
|
|
63
|
+
* This method fires {@link module:engine/view/document~Document#event:selectionChange} and
|
|
64
|
+
* {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
|
|
65
|
+
* {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
|
|
66
|
+
*/
|
|
67
|
+
_handleSelectionMove(keyCode) {
|
|
68
|
+
const selection = this.document.selection;
|
|
69
|
+
const newSelection = new ViewSelection(selection.getRanges(), { backward: selection.isBackward, fake: false });
|
|
70
|
+
// Left or up arrow pressed - move selection to start.
|
|
71
|
+
if (keyCode == keyCodes.arrowleft || keyCode == keyCodes.arrowup) {
|
|
72
|
+
newSelection.setTo(newSelection.getFirstPosition());
|
|
73
|
+
}
|
|
74
|
+
// Right or down arrow pressed - move selection to end.
|
|
75
|
+
if (keyCode == keyCodes.arrowright || keyCode == keyCodes.arrowdown) {
|
|
76
|
+
newSelection.setTo(newSelection.getLastPosition());
|
|
77
|
+
}
|
|
78
|
+
const data = {
|
|
79
|
+
oldSelection: selection,
|
|
80
|
+
newSelection,
|
|
81
|
+
domSelection: null
|
|
82
|
+
};
|
|
83
|
+
// Fire dummy selection change event.
|
|
84
|
+
this.document.fire('selectionChange', data);
|
|
85
|
+
// Call` #_fireSelectionChangeDoneDebounced` every time when `selectionChange` event is fired.
|
|
86
|
+
// This function is debounced what means that `selectionChangeDone` event will be fired only when
|
|
87
|
+
// defined int the function time will elapse since the last time the function was called.
|
|
88
|
+
// So `selectionChangeDone` will be fired when selection will stop changing.
|
|
89
|
+
this._fireSelectionChangeDoneDebounced(data);
|
|
90
|
+
}
|
|
91
|
+
}
|