@ckeditor/ckeditor5-engine 48.2.0 → 48.3.0-alpha.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/dist/controller/datacontroller.d.ts +329 -328
- package/dist/controller/editingcontroller.d.ts +95 -94
- package/dist/conversion/comparemarkers.d.ts +45 -45
- package/dist/conversion/conversion.d.ts +474 -474
- package/dist/conversion/conversionhelpers.d.ts +21 -21
- package/dist/conversion/downcastdispatcher.d.ts +539 -538
- package/dist/conversion/downcasthelpers.d.ts +1129 -1129
- package/dist/conversion/mapper.d.ts +692 -697
- package/dist/conversion/modelconsumable.d.ts +196 -196
- package/dist/conversion/upcastdispatcher.d.ts +483 -482
- package/dist/conversion/upcasthelpers.d.ts +491 -491
- package/dist/conversion/viewconsumable.d.ts +330 -330
- package/dist/dataprocessor/basichtmlwriter.d.ts +15 -15
- package/dist/dataprocessor/dataprocessor.d.ts +57 -57
- package/dist/dataprocessor/htmldataprocessor.d.ts +72 -72
- package/dist/dataprocessor/htmlwriter.d.ts +11 -11
- package/dist/dataprocessor/xmldataprocessor.d.ts +86 -86
- package/dist/dev-utils/model.d.ts +128 -123
- package/dist/dev-utils/operationreplayer.d.ts +49 -49
- package/dist/dev-utils/utils.d.ts +33 -33
- package/dist/dev-utils/view.d.ts +314 -309
- package/dist/engineconfig.d.ts +39 -39
- package/dist/index.css.map +1 -1
- package/dist/index.d.ts +150 -150
- package/dist/index.js +34026 -40107
- package/dist/index.js.map +1 -1
- package/dist/legacyerrors.d.ts +0 -4
- package/dist/model/batch.d.ts +86 -86
- package/dist/model/differ.d.ts +504 -504
- package/dist/model/document.d.ts +265 -268
- package/dist/model/documentfragment.d.ts +214 -214
- package/dist/model/documentselection.d.ts +406 -410
- package/dist/model/element.d.ts +182 -182
- package/dist/model/history.d.ts +109 -109
- package/dist/model/item.d.ts +9 -9
- package/dist/model/liveposition.d.ts +70 -69
- package/dist/model/liverange.d.ts +93 -92
- package/dist/model/markercollection.d.ts +317 -324
- package/dist/model/model.d.ts +889 -909
- package/dist/model/node.d.ts +254 -254
- package/dist/model/nodelist.d.ts +110 -110
- package/dist/model/operation/attributeoperation.d.ts +98 -98
- package/dist/model/operation/detachoperation.d.ts +57 -57
- package/dist/model/operation/insertoperation.d.ts +85 -85
- package/dist/model/operation/markeroperation.d.ts +87 -87
- package/dist/model/operation/mergeoperation.d.ts +95 -95
- package/dist/model/operation/moveoperation.d.ts +97 -97
- package/dist/model/operation/nooperation.d.ts +33 -33
- package/dist/model/operation/operation.d.ts +94 -94
- package/dist/model/operation/operationfactory.d.ts +14 -14
- package/dist/model/operation/renameoperation.d.ts +78 -78
- package/dist/model/operation/rootattributeoperation.d.ts +93 -93
- package/dist/model/operation/rootoperation.d.ts +71 -71
- package/dist/model/operation/splitoperation.d.ts +104 -104
- package/dist/model/operation/transform.d.ts +91 -91
- package/dist/model/operation/utils.d.ts +58 -58
- package/dist/model/position.d.ts +535 -535
- package/dist/model/range.d.ts +458 -453
- package/dist/model/rootelement.d.ts +55 -55
- package/dist/model/schema.d.ts +1325 -1327
- package/dist/model/selection.d.ts +452 -471
- package/dist/model/text.d.ts +62 -62
- package/dist/model/textproxy.d.ts +140 -140
- package/dist/model/treewalker.d.ts +190 -190
- package/dist/model/typecheckable.d.ts +281 -281
- package/dist/model/utils/autoparagraphing.d.ts +29 -29
- package/dist/model/utils/deletecontent.d.ts +68 -68
- package/dist/model/utils/getselectedcontent.d.ts +27 -27
- package/dist/model/utils/insertcontent.d.ts +42 -42
- package/dist/model/utils/insertobject.d.ts +41 -41
- package/dist/model/utils/modifyselection.d.ts +44 -44
- package/dist/model/utils/selection-post-fixer.d.ts +71 -71
- package/dist/model/writer.d.ts +854 -854
- package/dist/view/attributeelement.d.ts +123 -123
- package/dist/view/containerelement.d.ts +49 -49
- package/dist/view/datatransfer.d.ts +70 -70
- package/dist/view/document.d.ts +175 -177
- package/dist/view/documentfragment.d.ts +158 -157
- package/dist/view/documentselection.d.ts +308 -307
- package/dist/view/domconverter.d.ts +612 -657
- package/dist/view/downcastwriter.d.ts +1006 -1006
- package/dist/view/editableelement.d.ts +64 -63
- package/dist/view/element.d.ts +754 -754
- package/dist/view/elementdefinition.d.ts +79 -79
- package/dist/view/emptyelement.d.ts +42 -42
- package/dist/view/filler.d.ts +75 -75
- package/dist/view/item.d.ts +9 -9
- package/dist/view/matcher.d.ts +412 -487
- package/dist/view/node.d.ts +164 -163
- package/dist/view/observer/arrowkeysobserver.d.ts +37 -37
- package/dist/view/observer/bubblingemittermixin.d.ts +163 -153
- package/dist/view/observer/bubblingeventinfo.d.ts +45 -42
- package/dist/view/observer/clickobserver.d.ts +36 -36
- package/dist/view/observer/compositionobserver.d.ts +67 -67
- package/dist/view/observer/domeventdata.d.ts +46 -46
- package/dist/view/observer/domeventobserver.d.ts +77 -74
- package/dist/view/observer/fakeselectionobserver.d.ts +42 -42
- package/dist/view/observer/focusobserver.d.ts +84 -84
- package/dist/view/observer/inputobserver.d.ts +76 -76
- package/dist/view/observer/keyobserver.d.ts +53 -53
- package/dist/view/observer/mouseobserver.d.ts +73 -73
- package/dist/view/observer/mutationobserver.d.ts +101 -101
- package/dist/view/observer/observer.d.ts +84 -83
- package/dist/view/observer/pointerobserver.d.ts +63 -63
- package/dist/view/observer/selectionobserver.d.ts +136 -136
- package/dist/view/observer/tabobserver.d.ts +38 -38
- package/dist/view/observer/touchobserver.d.ts +60 -60
- package/dist/view/placeholder.d.ts +80 -80
- package/dist/view/position.d.ts +187 -187
- package/dist/view/range.d.ts +282 -282
- package/dist/view/rawelement.d.ts +72 -72
- package/dist/view/renderer.d.ts +270 -272
- package/dist/view/rooteditableelement.d.ts +43 -43
- package/dist/view/selection.d.ts +356 -369
- package/dist/view/styles/background.d.ts +15 -15
- package/dist/view/styles/border.d.ts +27 -27
- package/dist/view/styles/margin.d.ts +12 -12
- package/dist/view/styles/padding.d.ts +12 -12
- package/dist/view/styles/utils.d.ts +72 -72
- package/dist/view/stylesmap.d.ts +715 -715
- package/dist/view/text.d.ts +75 -75
- package/dist/view/textproxy.d.ts +92 -92
- package/dist/view/tokenlist.d.ts +104 -104
- package/dist/view/treewalker.d.ts +201 -201
- package/dist/view/typecheckable.d.ts +445 -445
- package/dist/view/uielement.d.ts +93 -93
- package/dist/view/upcastwriter.d.ts +412 -412
- package/dist/view/view.d.ts +466 -469
- package/package.json +2 -2
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import { type DataProcessorHtmlWriter } from
|
|
6
|
+
* @module engine/dataprocessor/basichtmlwriter
|
|
7
|
+
*/
|
|
8
|
+
import { type DataProcessorHtmlWriter } from "./htmlwriter.js";
|
|
9
9
|
/**
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
10
|
+
* Basic HTML writer. It uses the native `innerHTML` property for basic conversion
|
|
11
|
+
* from a document fragment to an HTML string.
|
|
12
|
+
*
|
|
13
|
+
* @internal
|
|
14
|
+
*/
|
|
15
15
|
export declare class BasicHtmlWriter implements DataProcessorHtmlWriter {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
/**
|
|
17
|
+
* Returns an HTML string created from the document fragment.
|
|
18
|
+
*/
|
|
19
|
+
getHtml(fragment: DocumentFragment): string;
|
|
20
20
|
}
|
|
@@ -1,62 +1,62 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import { type ViewDocumentFragment } from
|
|
9
|
-
import type { MatcherPattern } from
|
|
6
|
+
* @module engine/dataprocessor/dataprocessor
|
|
7
|
+
*/
|
|
8
|
+
import { type ViewDocumentFragment } from "../view/documentfragment.js";
|
|
9
|
+
import type { MatcherPattern } from "../view/matcher.js";
|
|
10
10
|
/**
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
11
|
+
* The data processor interface. It should be implemented by actual data processors.
|
|
12
|
+
*
|
|
13
|
+
* Each data processor implements a certain format of the data. For example, {@glink features/markdown Markdown data processor}
|
|
14
|
+
* will convert the data (a Markdown string) to a {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}
|
|
15
|
+
* and back.
|
|
16
|
+
*
|
|
17
|
+
* **Note:** While the CKEditor 5 architecture supports changing the data format, in most scenarios we do recommend sticking to
|
|
18
|
+
* the default format which is HTML (supported by the {@link module:engine/dataprocessor/htmldataprocessor~HtmlDataProcessor}).
|
|
19
|
+
* HTML remains [the best standard for rich-text data](https://medium.com/content-uneditable/a-standard-for-rich-text-data-4b3a507af552).
|
|
20
|
+
*
|
|
21
|
+
* And please do remember – using Markdown [does not automatically make your
|
|
22
|
+
* application/website secure](https://github.com/ckeditor/ckeditor5-markdown-gfm/issues/16#issuecomment-375752994).
|
|
23
|
+
*/
|
|
24
24
|
export interface DataProcessor {
|
|
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
|
-
|
|
25
|
+
/**
|
|
26
|
+
* Converts a {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment} to data.
|
|
27
|
+
*
|
|
28
|
+
* @param viewFragment The document fragment to be processed.
|
|
29
|
+
*/
|
|
30
|
+
toData(viewFragment: ViewDocumentFragment): string;
|
|
31
|
+
/**
|
|
32
|
+
* Converts the data to a {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}.
|
|
33
|
+
*
|
|
34
|
+
* @param data The data to be processed.
|
|
35
|
+
*/
|
|
36
|
+
toView(data: string): ViewDocumentFragment;
|
|
37
|
+
/**
|
|
38
|
+
* Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
|
|
39
|
+
* and its content should be converted to a
|
|
40
|
+
* {@link module:engine/view/element~ViewElement#getCustomProperty custom property of a view element} called `"$rawContent"` while
|
|
41
|
+
* converting {@link #toView to view}.
|
|
42
|
+
*
|
|
43
|
+
* @param pattern Pattern matching all view elements whose content should be treated as plain text.
|
|
44
|
+
*/
|
|
45
|
+
registerRawContentMatcher(pattern: MatcherPattern): void;
|
|
46
|
+
/**
|
|
47
|
+
* If the processor is set to use marked fillers, it will insert ` ` fillers wrapped in `<span>` elements
|
|
48
|
+
* (`<span data-cke-filler="true"> </span>`) instead of regular ` ` characters.
|
|
49
|
+
*
|
|
50
|
+
* This mode allows for more precise handling of block fillers (so they do not leak into the editor content) but bloats the
|
|
51
|
+
* editor data with additional markup.
|
|
52
|
+
*
|
|
53
|
+
* This mode may be required by some features and will be turned on by them automatically.
|
|
54
|
+
*
|
|
55
|
+
* @param type Whether to use the default or marked ` ` block fillers.
|
|
56
|
+
*/
|
|
57
|
+
useFillerType(type: "default" | "marked"): void;
|
|
58
|
+
/**
|
|
59
|
+
* If `false`, comment nodes will be converted to `$comment`. Otherwise comment nodes are ignored.
|
|
60
|
+
*/
|
|
61
|
+
skipComments?: boolean;
|
|
62
62
|
}
|
|
@@ -1,76 +1,76 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
import { ViewDomConverter } from
|
|
6
|
-
import { type DataProcessor } from
|
|
7
|
-
import { type DataProcessorHtmlWriter } from
|
|
8
|
-
import { type ViewDocument } from
|
|
9
|
-
import { type ViewDocumentFragment } from
|
|
10
|
-
import type { MatcherPattern } from
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
|
+
import { ViewDomConverter } from "../view/domconverter.js";
|
|
6
|
+
import { type DataProcessor } from "./dataprocessor.js";
|
|
7
|
+
import { type DataProcessorHtmlWriter } from "./htmlwriter.js";
|
|
8
|
+
import { type ViewDocument } from "../view/document.js";
|
|
9
|
+
import { type ViewDocumentFragment } from "../view/documentfragment.js";
|
|
10
|
+
import type { MatcherPattern } from "../view/matcher.js";
|
|
11
11
|
/**
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
* The HTML data processor class.
|
|
13
|
+
* This data processor implementation uses HTML as input and output data.
|
|
14
|
+
*/
|
|
15
15
|
export declare class HtmlDataProcessor implements DataProcessor {
|
|
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
|
-
|
|
16
|
+
/**
|
|
17
|
+
* A DOM parser instance used to parse an HTML string to an HTML document.
|
|
18
|
+
*/
|
|
19
|
+
domParser: DOMParser;
|
|
20
|
+
/**
|
|
21
|
+
* A DOM converter used to convert DOM elements to view elements.
|
|
22
|
+
*/
|
|
23
|
+
domConverter: ViewDomConverter;
|
|
24
|
+
/**
|
|
25
|
+
* A basic HTML writer instance used to convert DOM elements to an HTML string.
|
|
26
|
+
*/
|
|
27
|
+
htmlWriter: DataProcessorHtmlWriter;
|
|
28
|
+
skipComments: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* Creates a new instance of the HTML data processor class.
|
|
31
|
+
*
|
|
32
|
+
* @param document The view document instance.
|
|
33
|
+
*/
|
|
34
|
+
constructor(document: ViewDocument);
|
|
35
|
+
/**
|
|
36
|
+
* Converts a provided {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}
|
|
37
|
+
* to data format – in this case to an HTML string.
|
|
38
|
+
*
|
|
39
|
+
* @returns HTML string.
|
|
40
|
+
*/
|
|
41
|
+
toData(viewFragment: ViewDocumentFragment): string;
|
|
42
|
+
/**
|
|
43
|
+
* Converts the provided HTML string to a view tree.
|
|
44
|
+
*
|
|
45
|
+
* @param data An HTML string.
|
|
46
|
+
* @returns A converted view element.
|
|
47
|
+
*/
|
|
48
|
+
toView(data: string): ViewDocumentFragment;
|
|
49
|
+
/**
|
|
50
|
+
* Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
|
|
51
|
+
* and not processed during the conversion from the DOM to the view elements.
|
|
52
|
+
*
|
|
53
|
+
* The raw data can be later accessed by a
|
|
54
|
+
* {@link module:engine/view/element~ViewElement#getCustomProperty custom property of a view element} called `"$rawContent"`.
|
|
55
|
+
*
|
|
56
|
+
* @param pattern Pattern matching all view elements whose content should be treated as raw data.
|
|
57
|
+
*/
|
|
58
|
+
registerRawContentMatcher(pattern: MatcherPattern): void;
|
|
59
|
+
/**
|
|
60
|
+
* If the processor is set to use marked fillers, it will insert ` ` fillers wrapped in `<span>` elements
|
|
61
|
+
* (`<span data-cke-filler="true"> </span>`) instead of regular ` ` characters.
|
|
62
|
+
*
|
|
63
|
+
* This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
|
|
64
|
+
* bloats the editor data with additional markup.
|
|
65
|
+
*
|
|
66
|
+
* This mode may be required by some features and will be turned on by them automatically.
|
|
67
|
+
*
|
|
68
|
+
* @param type Whether to use the default or the marked ` ` block fillers.
|
|
69
|
+
*/
|
|
70
|
+
useFillerType(type: "default" | "marked"): void;
|
|
71
|
+
/**
|
|
72
|
+
* Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
|
|
73
|
+
* the provided data.
|
|
74
|
+
*/
|
|
75
|
+
protected _toDom(data: string): DocumentFragment;
|
|
76
76
|
}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
* @module engine/dataprocessor/htmlwriter
|
|
7
|
+
*/
|
|
8
8
|
/**
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
* The HTML writer interface.
|
|
10
|
+
*/
|
|
11
11
|
export interface DataProcessorHtmlWriter {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
/**
|
|
13
|
+
* Returns an HTML string created from a document fragment.
|
|
14
|
+
*/
|
|
15
|
+
getHtml(fragment: DocumentFragment): string;
|
|
16
16
|
}
|
|
@@ -1,90 +1,90 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
import { ViewDomConverter } from
|
|
6
|
-
import { type DataProcessor } from
|
|
7
|
-
import { type DataProcessorHtmlWriter } from
|
|
8
|
-
import { type ViewDocument } from
|
|
9
|
-
import { type ViewDocumentFragment } from
|
|
10
|
-
import type { MatcherPattern } from
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
|
+
import { ViewDomConverter } from "../view/domconverter.js";
|
|
6
|
+
import { type DataProcessor } from "./dataprocessor.js";
|
|
7
|
+
import { type DataProcessorHtmlWriter } from "./htmlwriter.js";
|
|
8
|
+
import { type ViewDocument } from "../view/document.js";
|
|
9
|
+
import { type ViewDocumentFragment } from "../view/documentfragment.js";
|
|
10
|
+
import type { MatcherPattern } from "../view/matcher.js";
|
|
11
11
|
/**
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
12
|
+
* The XML data processor class.
|
|
13
|
+
* This data processor implementation uses XML as input and output data.
|
|
14
|
+
* This class is needed because unlike HTML, XML allows to use any tag with any value.
|
|
15
|
+
* For example, `<link>Text</link>` is a valid XML but invalid HTML.
|
|
16
|
+
*/
|
|
17
17
|
export declare class XmlDataProcessor implements DataProcessor {
|
|
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
|
-
|
|
18
|
+
/**
|
|
19
|
+
* A list of namespaces allowed to use in the XML input.
|
|
20
|
+
*
|
|
21
|
+
* For example, registering namespaces [ 'attribute', 'container' ] allows to use `<attirbute:tagName></attribute:tagName>`
|
|
22
|
+
* and `<container:tagName></container:tagName>` input. It is mainly for debugging.
|
|
23
|
+
*/
|
|
24
|
+
namespaces: Array<string>;
|
|
25
|
+
/**
|
|
26
|
+
* DOM parser instance used to parse an XML string to an XML document.
|
|
27
|
+
*/
|
|
28
|
+
domParser: DOMParser;
|
|
29
|
+
/**
|
|
30
|
+
* DOM converter used to convert DOM elements to view elements.
|
|
31
|
+
*/
|
|
32
|
+
domConverter: ViewDomConverter;
|
|
33
|
+
/**
|
|
34
|
+
* A basic HTML writer instance used to convert DOM elements to an XML string.
|
|
35
|
+
* There is no need to use a dedicated XML writer because the basic HTML writer works well in this case.
|
|
36
|
+
*/
|
|
37
|
+
htmlWriter: DataProcessorHtmlWriter;
|
|
38
|
+
skipComments: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Creates a new instance of the XML data processor class.
|
|
41
|
+
*
|
|
42
|
+
* @param document The view document instance.
|
|
43
|
+
* @param options Configuration options.
|
|
44
|
+
* @param options.namespaces A list of namespaces allowed to use in the XML input.
|
|
45
|
+
*/
|
|
46
|
+
constructor(document: ViewDocument, options?: {
|
|
47
|
+
namespaces?: Array<string>;
|
|
48
|
+
});
|
|
49
|
+
/**
|
|
50
|
+
* Converts the provided {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}
|
|
51
|
+
* to data format – in this case an XML string.
|
|
52
|
+
*
|
|
53
|
+
* @returns An XML string.
|
|
54
|
+
*/
|
|
55
|
+
toData(viewFragment: ViewDocumentFragment): string;
|
|
56
|
+
/**
|
|
57
|
+
* Converts the provided XML string to a view tree.
|
|
58
|
+
*
|
|
59
|
+
* @param data An XML string.
|
|
60
|
+
* @returns A converted view element.
|
|
61
|
+
*/
|
|
62
|
+
toView(data: string): ViewDocumentFragment;
|
|
63
|
+
/**
|
|
64
|
+
* Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
|
|
65
|
+
* and not processed during the conversion from XML to view elements.
|
|
66
|
+
*
|
|
67
|
+
* The raw data can be later accessed by a
|
|
68
|
+
* {@link module:engine/view/element~ViewElement#getCustomProperty custom property of a view element} called `"$rawContent"`.
|
|
69
|
+
*
|
|
70
|
+
* @param pattern Pattern matching all view elements whose content should be treated as raw data.
|
|
71
|
+
*/
|
|
72
|
+
registerRawContentMatcher(pattern: MatcherPattern): void;
|
|
73
|
+
/**
|
|
74
|
+
* If the processor is set to use marked fillers, it will insert ` ` fillers wrapped in `<span>` elements
|
|
75
|
+
* (`<span data-cke-filler="true"> </span>`) instead of regular ` ` characters.
|
|
76
|
+
*
|
|
77
|
+
* This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
|
|
78
|
+
* bloats the editor data with additional markup.
|
|
79
|
+
*
|
|
80
|
+
* This mode may be required by some features and will be turned on by them automatically.
|
|
81
|
+
*
|
|
82
|
+
* @param type Whether to use the default or the marked ` ` block fillers.
|
|
83
|
+
*/
|
|
84
|
+
useFillerType(type: "default" | "marked"): void;
|
|
85
|
+
/**
|
|
86
|
+
* Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
|
|
87
|
+
* the provided data.
|
|
88
|
+
*/
|
|
89
|
+
private _toDom;
|
|
90
90
|
}
|