@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.
Files changed (129) hide show
  1. package/dist/controller/datacontroller.d.ts +329 -328
  2. package/dist/controller/editingcontroller.d.ts +95 -94
  3. package/dist/conversion/comparemarkers.d.ts +45 -45
  4. package/dist/conversion/conversion.d.ts +474 -474
  5. package/dist/conversion/conversionhelpers.d.ts +21 -21
  6. package/dist/conversion/downcastdispatcher.d.ts +539 -538
  7. package/dist/conversion/downcasthelpers.d.ts +1129 -1129
  8. package/dist/conversion/mapper.d.ts +692 -697
  9. package/dist/conversion/modelconsumable.d.ts +196 -196
  10. package/dist/conversion/upcastdispatcher.d.ts +483 -482
  11. package/dist/conversion/upcasthelpers.d.ts +491 -491
  12. package/dist/conversion/viewconsumable.d.ts +330 -330
  13. package/dist/dataprocessor/basichtmlwriter.d.ts +15 -15
  14. package/dist/dataprocessor/dataprocessor.d.ts +57 -57
  15. package/dist/dataprocessor/htmldataprocessor.d.ts +72 -72
  16. package/dist/dataprocessor/htmlwriter.d.ts +11 -11
  17. package/dist/dataprocessor/xmldataprocessor.d.ts +86 -86
  18. package/dist/dev-utils/model.d.ts +128 -123
  19. package/dist/dev-utils/operationreplayer.d.ts +49 -49
  20. package/dist/dev-utils/utils.d.ts +33 -33
  21. package/dist/dev-utils/view.d.ts +314 -309
  22. package/dist/engineconfig.d.ts +39 -39
  23. package/dist/index.css.map +1 -1
  24. package/dist/index.d.ts +150 -150
  25. package/dist/index.js +34026 -40107
  26. package/dist/index.js.map +1 -1
  27. package/dist/legacyerrors.d.ts +0 -4
  28. package/dist/model/batch.d.ts +86 -86
  29. package/dist/model/differ.d.ts +504 -504
  30. package/dist/model/document.d.ts +265 -268
  31. package/dist/model/documentfragment.d.ts +214 -214
  32. package/dist/model/documentselection.d.ts +406 -410
  33. package/dist/model/element.d.ts +182 -182
  34. package/dist/model/history.d.ts +109 -109
  35. package/dist/model/item.d.ts +9 -9
  36. package/dist/model/liveposition.d.ts +70 -69
  37. package/dist/model/liverange.d.ts +93 -92
  38. package/dist/model/markercollection.d.ts +317 -324
  39. package/dist/model/model.d.ts +889 -909
  40. package/dist/model/node.d.ts +254 -254
  41. package/dist/model/nodelist.d.ts +110 -110
  42. package/dist/model/operation/attributeoperation.d.ts +98 -98
  43. package/dist/model/operation/detachoperation.d.ts +57 -57
  44. package/dist/model/operation/insertoperation.d.ts +85 -85
  45. package/dist/model/operation/markeroperation.d.ts +87 -87
  46. package/dist/model/operation/mergeoperation.d.ts +95 -95
  47. package/dist/model/operation/moveoperation.d.ts +97 -97
  48. package/dist/model/operation/nooperation.d.ts +33 -33
  49. package/dist/model/operation/operation.d.ts +94 -94
  50. package/dist/model/operation/operationfactory.d.ts +14 -14
  51. package/dist/model/operation/renameoperation.d.ts +78 -78
  52. package/dist/model/operation/rootattributeoperation.d.ts +93 -93
  53. package/dist/model/operation/rootoperation.d.ts +71 -71
  54. package/dist/model/operation/splitoperation.d.ts +104 -104
  55. package/dist/model/operation/transform.d.ts +91 -91
  56. package/dist/model/operation/utils.d.ts +58 -58
  57. package/dist/model/position.d.ts +535 -535
  58. package/dist/model/range.d.ts +458 -453
  59. package/dist/model/rootelement.d.ts +55 -55
  60. package/dist/model/schema.d.ts +1325 -1327
  61. package/dist/model/selection.d.ts +452 -471
  62. package/dist/model/text.d.ts +62 -62
  63. package/dist/model/textproxy.d.ts +140 -140
  64. package/dist/model/treewalker.d.ts +190 -190
  65. package/dist/model/typecheckable.d.ts +281 -281
  66. package/dist/model/utils/autoparagraphing.d.ts +29 -29
  67. package/dist/model/utils/deletecontent.d.ts +68 -68
  68. package/dist/model/utils/getselectedcontent.d.ts +27 -27
  69. package/dist/model/utils/insertcontent.d.ts +42 -42
  70. package/dist/model/utils/insertobject.d.ts +41 -41
  71. package/dist/model/utils/modifyselection.d.ts +44 -44
  72. package/dist/model/utils/selection-post-fixer.d.ts +71 -71
  73. package/dist/model/writer.d.ts +854 -854
  74. package/dist/view/attributeelement.d.ts +123 -123
  75. package/dist/view/containerelement.d.ts +49 -49
  76. package/dist/view/datatransfer.d.ts +70 -70
  77. package/dist/view/document.d.ts +175 -177
  78. package/dist/view/documentfragment.d.ts +158 -157
  79. package/dist/view/documentselection.d.ts +308 -307
  80. package/dist/view/domconverter.d.ts +612 -657
  81. package/dist/view/downcastwriter.d.ts +1006 -1006
  82. package/dist/view/editableelement.d.ts +64 -63
  83. package/dist/view/element.d.ts +754 -754
  84. package/dist/view/elementdefinition.d.ts +79 -79
  85. package/dist/view/emptyelement.d.ts +42 -42
  86. package/dist/view/filler.d.ts +75 -75
  87. package/dist/view/item.d.ts +9 -9
  88. package/dist/view/matcher.d.ts +412 -487
  89. package/dist/view/node.d.ts +164 -163
  90. package/dist/view/observer/arrowkeysobserver.d.ts +37 -37
  91. package/dist/view/observer/bubblingemittermixin.d.ts +163 -153
  92. package/dist/view/observer/bubblingeventinfo.d.ts +45 -42
  93. package/dist/view/observer/clickobserver.d.ts +36 -36
  94. package/dist/view/observer/compositionobserver.d.ts +67 -67
  95. package/dist/view/observer/domeventdata.d.ts +46 -46
  96. package/dist/view/observer/domeventobserver.d.ts +77 -74
  97. package/dist/view/observer/fakeselectionobserver.d.ts +42 -42
  98. package/dist/view/observer/focusobserver.d.ts +84 -84
  99. package/dist/view/observer/inputobserver.d.ts +76 -76
  100. package/dist/view/observer/keyobserver.d.ts +53 -53
  101. package/dist/view/observer/mouseobserver.d.ts +73 -73
  102. package/dist/view/observer/mutationobserver.d.ts +101 -101
  103. package/dist/view/observer/observer.d.ts +84 -83
  104. package/dist/view/observer/pointerobserver.d.ts +63 -63
  105. package/dist/view/observer/selectionobserver.d.ts +136 -136
  106. package/dist/view/observer/tabobserver.d.ts +38 -38
  107. package/dist/view/observer/touchobserver.d.ts +60 -60
  108. package/dist/view/placeholder.d.ts +80 -80
  109. package/dist/view/position.d.ts +187 -187
  110. package/dist/view/range.d.ts +282 -282
  111. package/dist/view/rawelement.d.ts +72 -72
  112. package/dist/view/renderer.d.ts +270 -272
  113. package/dist/view/rooteditableelement.d.ts +43 -43
  114. package/dist/view/selection.d.ts +356 -369
  115. package/dist/view/styles/background.d.ts +15 -15
  116. package/dist/view/styles/border.d.ts +27 -27
  117. package/dist/view/styles/margin.d.ts +12 -12
  118. package/dist/view/styles/padding.d.ts +12 -12
  119. package/dist/view/styles/utils.d.ts +72 -72
  120. package/dist/view/stylesmap.d.ts +715 -715
  121. package/dist/view/text.d.ts +75 -75
  122. package/dist/view/textproxy.d.ts +92 -92
  123. package/dist/view/tokenlist.d.ts +104 -104
  124. package/dist/view/treewalker.d.ts +201 -201
  125. package/dist/view/typecheckable.d.ts +445 -445
  126. package/dist/view/uielement.d.ts +93 -93
  127. package/dist/view/upcastwriter.d.ts +412 -412
  128. package/dist/view/view.d.ts +466 -469
  129. package/package.json +2 -2
@@ -1,287 +1,287 @@
1
1
  /**
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
- */
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
- * @module engine/view/range
7
- */
8
- import { ViewTypeCheckable } from './typecheckable.js';
9
- import { ViewPosition } from './position.js';
10
- import { type ViewDocumentFragment } from './documentfragment.js';
11
- import { type ViewElement } from './element.js';
12
- import { type ViewItem } from './item.js';
13
- import { type ViewNode } from './node.js';
14
- import { ViewTreeWalker, type ViewTreeWalkerValue, type ViewTreeWalkerOptions } from './treewalker.js';
6
+ * @module engine/view/range
7
+ */
8
+ import { ViewTypeCheckable } from "./typecheckable.js";
9
+ import { ViewPosition } from "./position.js";
10
+ import { type ViewDocumentFragment } from "./documentfragment.js";
11
+ import { type ViewElement } from "./element.js";
12
+ import { type ViewItem } from "./item.js";
13
+ import { type ViewNode } from "./node.js";
14
+ import { ViewTreeWalker, type ViewTreeWalkerValue, type ViewTreeWalkerOptions } from "./treewalker.js";
15
15
  /**
16
- * Range in the view tree. A range is represented by its start and end {@link module:engine/view/position~ViewPosition positions}.
17
- *
18
- * In order to create a new position instance use the `createPosition*()` factory methods available in:
19
- *
20
- * * {@link module:engine/view/view~EditingView}
21
- * * {@link module:engine/view/downcastwriter~ViewDowncastWriter}
22
- * * {@link module:engine/view/upcastwriter~ViewUpcastWriter}
23
- */
16
+ * Range in the view tree. A range is represented by its start and end {@link module:engine/view/position~ViewPosition positions}.
17
+ *
18
+ * In order to create a new position instance use the `createPosition*()` factory methods available in:
19
+ *
20
+ * * {@link module:engine/view/view~EditingView}
21
+ * * {@link module:engine/view/downcastwriter~ViewDowncastWriter}
22
+ * * {@link module:engine/view/upcastwriter~ViewUpcastWriter}
23
+ */
24
24
  export declare class ViewRange extends ViewTypeCheckable implements Iterable<ViewTreeWalkerValue> {
25
- /**
26
- * Start position.
27
- */
28
- readonly start: ViewPosition;
29
- /**
30
- * End position.
31
- */
32
- readonly end: ViewPosition;
33
- /**
34
- * Creates a range spanning from `start` position to `end` position.
35
- *
36
- * **Note:** Constructor creates it's own {@link module:engine/view/position~ViewPosition} instances basing on passed values.
37
- *
38
- * @param start Start position.
39
- * @param end End position. If not set, range will be collapsed at the `start` position.
40
- */
41
- constructor(start: ViewPosition, end?: ViewPosition | null);
42
- /**
43
- * Iterable interface.
44
- *
45
- * Iterates over all {@link module:engine/view/item~ViewItem view items} that are in this range and returns
46
- * them together with additional information like length or {@link module:engine/view/position~ViewPosition positions},
47
- * grouped as {@link module:engine/view/treewalker~ViewTreeWalkerValue}.
48
- *
49
- * This iterator uses {@link module:engine/view/treewalker~ViewTreeWalker TreeWalker} with `boundaries` set to this range and
50
- * `ignoreElementEnd` option
51
- * set to `true`.
52
- */
53
- [Symbol.iterator](): IterableIterator<ViewTreeWalkerValue>;
54
- /**
55
- * Returns whether the range is collapsed, that is it start and end positions are equal.
56
- */
57
- get isCollapsed(): boolean;
58
- /**
59
- * Returns whether this range is flat, that is if {@link module:engine/view/range~ViewRange#start start} position and
60
- * {@link module:engine/view/range~ViewRange#end end} position are in the same
61
- * {@link module:engine/view/position~ViewPosition#parent parent}.
62
- */
63
- get isFlat(): boolean;
64
- /**
65
- * Range root element.
66
- */
67
- get root(): ViewNode | ViewDocumentFragment;
68
- /**
69
- * Creates a maximal range that has the same content as this range but is expanded in both ways (at the beginning
70
- * and at the end).
71
- *
72
- * For example:
73
- *
74
- * ```html
75
- * <p>Foo</p><p><b>{Bar}</b></p> -> <p>Foo</p>[<p><b>Bar</b>]</p>
76
- * <p><b>foo</b>{bar}<span></span></p> -> <p><b>foo[</b>bar<span></span>]</p>
77
- * ```
78
- *
79
- * Note that in the sample above:
80
- *
81
- * - `<p>` have type of {@link module:engine/view/containerelement~ViewContainerElement},
82
- * - `<b>` have type of {@link module:engine/view/attributeelement~ViewAttributeElement},
83
- * - `<span>` have type of {@link module:engine/view/uielement~ViewUIElement}.
84
- *
85
- * @returns Enlarged range.
86
- */
87
- getEnlarged(): ViewRange;
88
- /**
89
- * Creates a minimum range that has the same content as this range but is trimmed in both ways (at the beginning
90
- * and at the end).
91
- *
92
- * For example:
93
- *
94
- * ```html
95
- * <p>Foo</p>[<p><b>Bar</b>]</p> -> <p>Foo</p><p><b>{Bar}</b></p>
96
- * <p><b>foo[</b>bar<span></span>]</p> -> <p><b>foo</b>{bar}<span></span></p>
97
- * ```
98
- *
99
- * Note that in the sample above:
100
- *
101
- * - `<p>` have type of {@link module:engine/view/containerelement~ViewContainerElement},
102
- * - `<b>` have type of {@link module:engine/view/attributeelement~ViewAttributeElement},
103
- * - `<span>` have type of {@link module:engine/view/uielement~ViewUIElement}.
104
- *
105
- * @returns Shrunk range.
106
- */
107
- getTrimmed(): ViewRange;
108
- /**
109
- * Two ranges are equal if their start and end positions are equal.
110
- *
111
- * @param otherRange Range to compare with.
112
- * @returns `true` if ranges are equal, `false` otherwise
113
- */
114
- isEqual(otherRange: ViewRange): boolean;
115
- /**
116
- * Checks whether this range contains given {@link module:engine/view/position~ViewPosition position}.
117
- *
118
- * @param position Position to check.
119
- * @returns `true` if given {@link module:engine/view/position~ViewPosition position} is contained in this range, `false` otherwise.
120
- */
121
- containsPosition(position: ViewPosition): boolean;
122
- /**
123
- * Checks whether this range contains given {@link module:engine/view/range~ViewRange range}.
124
- *
125
- * @param otherRange Range to check.
126
- * @param loose Whether the check is loose or strict. If the check is strict (`false`), compared range cannot
127
- * start or end at the same position as this range boundaries. If the check is loose (`true`), compared range can start, end or
128
- * even be equal to this range. Note that collapsed ranges are always compared in strict mode.
129
- * @returns `true` if given {@link module:engine/view/range~ViewRange range} boundaries are contained by this range, `false`
130
- * otherwise.
131
- */
132
- containsRange(otherRange: ViewRange, loose?: boolean): boolean;
133
- /**
134
- * Computes which part(s) of this {@link module:engine/view/range~ViewRange range} is not a part of given
135
- * {@link module:engine/view/range~ViewRange range}.
136
- * Returned array contains zero, one or two {@link module:engine/view/range~ViewRange ranges}.
137
- *
138
- * Examples:
139
- *
140
- * ```ts
141
- * let foo = downcastWriter.createText( 'foo' );
142
- * let img = downcastWriter.createContainerElement( 'img' );
143
- * let bar = downcastWriter.createText( 'bar' );
144
- * let p = downcastWriter.createContainerElement( 'p', null, [ foo, img, bar ] );
145
- *
146
- * let range = view.createRange( view.createPositionAt( foo, 2 ), view.createPositionAt( bar, 1 ); // "o", img, "b" are in range.
147
- * let otherRange = view.createRange( // "oo", img, "ba" are in range.
148
- * view.createPositionAt( foo, 1 ),
149
- * view.createPositionAt( bar, 2 )
150
- * );
151
- * let transformed = range.getDifference( otherRange );
152
- * // transformed array has no ranges because `otherRange` contains `range`
153
- *
154
- * otherRange = view.createRange( view.createPositionAt( foo, 1 ), view.createPositionAt( p, 2 ); // "oo", img are in range.
155
- * transformed = range.getDifference( otherRange );
156
- * // transformed array has one range: from ( p, 2 ) to ( bar, 1 )
157
- *
158
- * otherRange = view.createRange( view.createPositionAt( p, 1 ), view.createPositionAt( p, 2 ) ); // img is in range.
159
- * transformed = range.getDifference( otherRange );
160
- * // transformed array has two ranges: from ( foo, 1 ) to ( p, 1 ) and from ( p, 2 ) to ( bar, 1 )
161
- * ```
162
- *
163
- * @param otherRange Range to differentiate against.
164
- * @returns The difference between ranges.
165
- */
166
- getDifference(otherRange: ViewRange): Array<ViewRange>;
167
- /**
168
- * Returns an intersection of this {@link module:engine/view/range~ViewRange range}
169
- * and given {@link module:engine/view/range~ViewRange range}.
170
- * Intersection is a common part of both of those ranges. If ranges has no common part, returns `null`.
171
- *
172
- * Examples:
173
- *
174
- * ```ts
175
- * let foo = downcastWriter.createText( 'foo' );
176
- * let img = downcastWriter.createContainerElement( 'img' );
177
- * let bar = downcastWriter.createText( 'bar' );
178
- * let p = downcastWriter.createContainerElement( 'p', null, [ foo, img, bar ] );
179
- *
180
- * let range = view.createRange( view.createPositionAt( foo, 2 ), view.createPositionAt( bar, 1 ); // "o", img, "b" are in range.
181
- * let otherRange = view.createRange( view.createPositionAt( foo, 1 ), view.createPositionAt( p, 2 ); // "oo", img are in range.
182
- * let transformed = range.getIntersection( otherRange ); // range from ( foo, 1 ) to ( p, 2 ).
183
- *
184
- * otherRange = view.createRange( view.createPositionAt( bar, 1 ), view.createPositionAt( bar, 3 ); "ar" is in range.
185
- * transformed = range.getIntersection( otherRange ); // null - no common part.
186
- * ```
187
- *
188
- * @param otherRange Range to check for intersection.
189
- * @returns A common part of given ranges or `null` if ranges have no common part.
190
- */
191
- getIntersection(otherRange: ViewRange): ViewRange | null;
192
- /**
193
- * Creates a {@link module:engine/view/treewalker~ViewTreeWalker TreeWalker} instance with this range as a boundary.
194
- *
195
- * @param options Object with configuration options. See {@link module:engine/view/treewalker~ViewTreeWalker}.
196
- */
197
- getWalker(options?: ViewTreeWalkerOptions): ViewTreeWalker;
198
- /**
199
- * Returns a {@link module:engine/view/node~ViewNode} or {@link module:engine/view/documentfragment~ViewDocumentFragment}
200
- * which is a common ancestor of range's both ends (in which the entire range is contained).
201
- */
202
- getCommonAncestor(): ViewNode | ViewDocumentFragment | null;
203
- /**
204
- * Returns an {@link module:engine/view/element~ViewElement Element} contained by the range.
205
- * The element will be returned when it is the **only** node within the range and **fully–contained**
206
- * at the same time.
207
- */
208
- getContainedElement(): ViewElement | null;
209
- /**
210
- * Clones this range.
211
- */
212
- clone(): ViewRange;
213
- /**
214
- * Returns an iterator that iterates over all {@link module:engine/view/item~ViewItem view items} that are in this range and returns
215
- * them.
216
- *
217
- * This method uses {@link module:engine/view/treewalker~ViewTreeWalker} with `boundaries` set to this range
218
- * and `ignoreElementEnd` option set to `true`. However it returns only {@link module:engine/view/item~ViewItem items},
219
- * not {@link module:engine/view/treewalker~ViewTreeWalkerValue}.
220
- *
221
- * You may specify additional options for the tree walker. See {@link module:engine/view/treewalker~ViewTreeWalker} for
222
- * a full list of available options.
223
- *
224
- * @param options Object with configuration options. See {@link module:engine/view/treewalker~ViewTreeWalker}.
225
- */
226
- getItems(options?: ViewTreeWalkerOptions): IterableIterator<ViewItem>;
227
- /**
228
- * Returns an iterator that iterates over all {@link module:engine/view/position~ViewPosition positions} that are boundaries or
229
- * contained in this range.
230
- *
231
- * This method uses {@link module:engine/view/treewalker~ViewTreeWalker} with `boundaries` set to this range. However it returns only
232
- * {@link module:engine/view/position~ViewPosition positions}, not {@link module:engine/view/treewalker~ViewTreeWalkerValue}.
233
- *
234
- * You may specify additional options for the tree walker. See {@link module:engine/view/treewalker~ViewTreeWalker} for
235
- * a full list of available options.
236
- *
237
- * @param options Object with configuration options. See {@link module:engine/view/treewalker~ViewTreeWalker}.
238
- */
239
- getPositions(options?: ViewTreeWalkerOptions): IterableIterator<ViewPosition>;
240
- /**
241
- * Checks and returns whether this range intersects with the given range.
242
- *
243
- * @param otherRange Range to compare with.
244
- * @returns True if ranges intersect.
245
- */
246
- isIntersecting(otherRange: ViewRange): boolean;
247
- /**
248
- * Converts `ViewRange` instance to plain object and returns it.
249
- *
250
- * @returns `ViewRange` instance converted to plain object.
251
- */
252
- toJSON(): unknown;
253
- /**
254
- * Creates a range from the given parents and offsets.
255
- *
256
- * @internal
257
- * @param startElement Start position parent element.
258
- * @param startOffset Start position offset.
259
- * @param endElement End position parent element.
260
- * @param endOffset End position offset.
261
- * @returns Created range.
262
- */
263
- static _createFromParentsAndOffsets(startElement: ViewElement | ViewDocumentFragment, startOffset: number, endElement: ViewElement | ViewDocumentFragment, endOffset: number): ViewRange;
264
- /**
265
- * Creates a new range, spreading from specified {@link module:engine/view/position~ViewPosition position} to a position moved by
266
- * given `shift`. If `shift` is a negative value, shifted position is treated as the beginning of the range.
267
- *
268
- * @internal
269
- * @param position Beginning of the range.
270
- * @param shift How long the range should be.
271
- */
272
- static _createFromPositionAndShift(position: ViewPosition, shift: number): ViewRange;
273
- /**
274
- * Creates a range inside an {@link module:engine/view/element~ViewElement element} which starts before the first child of
275
- * that element and ends after the last child of that element.
276
- *
277
- * @internal
278
- * @param element Element which is a parent for the range.
279
- */
280
- static _createIn(element: ViewElement | ViewDocumentFragment): ViewRange;
281
- /**
282
- * Creates a range that starts before given {@link module:engine/view/item~ViewItem view item} and ends after it.
283
- *
284
- * @internal
285
- */
286
- static _createOn(item: ViewItem): ViewRange;
25
+ /**
26
+ * Start position.
27
+ */
28
+ readonly start: ViewPosition;
29
+ /**
30
+ * End position.
31
+ */
32
+ readonly end: ViewPosition;
33
+ /**
34
+ * Creates a range spanning from `start` position to `end` position.
35
+ *
36
+ * **Note:** Constructor creates it's own {@link module:engine/view/position~ViewPosition} instances basing on passed values.
37
+ *
38
+ * @param start Start position.
39
+ * @param end End position. If not set, range will be collapsed at the `start` position.
40
+ */
41
+ constructor(start: ViewPosition, end?: ViewPosition | null);
42
+ /**
43
+ * Iterable interface.
44
+ *
45
+ * Iterates over all {@link module:engine/view/item~ViewItem view items} that are in this range and returns
46
+ * them together with additional information like length or {@link module:engine/view/position~ViewPosition positions},
47
+ * grouped as {@link module:engine/view/treewalker~ViewTreeWalkerValue}.
48
+ *
49
+ * This iterator uses {@link module:engine/view/treewalker~ViewTreeWalker TreeWalker} with `boundaries` set to this range and
50
+ * `ignoreElementEnd` option
51
+ * set to `true`.
52
+ */
53
+ [Symbol.iterator](): IterableIterator<ViewTreeWalkerValue>;
54
+ /**
55
+ * Returns whether the range is collapsed, that is it start and end positions are equal.
56
+ */
57
+ get isCollapsed(): boolean;
58
+ /**
59
+ * Returns whether this range is flat, that is if {@link module:engine/view/range~ViewRange#start start} position and
60
+ * {@link module:engine/view/range~ViewRange#end end} position are in the same
61
+ * {@link module:engine/view/position~ViewPosition#parent parent}.
62
+ */
63
+ get isFlat(): boolean;
64
+ /**
65
+ * Range root element.
66
+ */
67
+ get root(): ViewNode | ViewDocumentFragment;
68
+ /**
69
+ * Creates a maximal range that has the same content as this range but is expanded in both ways (at the beginning
70
+ * and at the end).
71
+ *
72
+ * For example:
73
+ *
74
+ * ```html
75
+ * <p>Foo</p><p><b>{Bar}</b></p> -> <p>Foo</p>[<p><b>Bar</b>]</p>
76
+ * <p><b>foo</b>{bar}<span></span></p> -> <p><b>foo[</b>bar<span></span>]</p>
77
+ * ```
78
+ *
79
+ * Note that in the sample above:
80
+ *
81
+ * - `<p>` have type of {@link module:engine/view/containerelement~ViewContainerElement},
82
+ * - `<b>` have type of {@link module:engine/view/attributeelement~ViewAttributeElement},
83
+ * - `<span>` have type of {@link module:engine/view/uielement~ViewUIElement}.
84
+ *
85
+ * @returns Enlarged range.
86
+ */
87
+ getEnlarged(): ViewRange;
88
+ /**
89
+ * Creates a minimum range that has the same content as this range but is trimmed in both ways (at the beginning
90
+ * and at the end).
91
+ *
92
+ * For example:
93
+ *
94
+ * ```html
95
+ * <p>Foo</p>[<p><b>Bar</b>]</p> -> <p>Foo</p><p><b>{Bar}</b></p>
96
+ * <p><b>foo[</b>bar<span></span>]</p> -> <p><b>foo</b>{bar}<span></span></p>
97
+ * ```
98
+ *
99
+ * Note that in the sample above:
100
+ *
101
+ * - `<p>` have type of {@link module:engine/view/containerelement~ViewContainerElement},
102
+ * - `<b>` have type of {@link module:engine/view/attributeelement~ViewAttributeElement},
103
+ * - `<span>` have type of {@link module:engine/view/uielement~ViewUIElement}.
104
+ *
105
+ * @returns Shrunk range.
106
+ */
107
+ getTrimmed(): ViewRange;
108
+ /**
109
+ * Two ranges are equal if their start and end positions are equal.
110
+ *
111
+ * @param otherRange Range to compare with.
112
+ * @returns `true` if ranges are equal, `false` otherwise
113
+ */
114
+ isEqual(otherRange: ViewRange): boolean;
115
+ /**
116
+ * Checks whether this range contains given {@link module:engine/view/position~ViewPosition position}.
117
+ *
118
+ * @param position Position to check.
119
+ * @returns `true` if given {@link module:engine/view/position~ViewPosition position} is contained in this range, `false` otherwise.
120
+ */
121
+ containsPosition(position: ViewPosition): boolean;
122
+ /**
123
+ * Checks whether this range contains given {@link module:engine/view/range~ViewRange range}.
124
+ *
125
+ * @param otherRange Range to check.
126
+ * @param loose Whether the check is loose or strict. If the check is strict (`false`), compared range cannot
127
+ * start or end at the same position as this range boundaries. If the check is loose (`true`), compared range can start, end or
128
+ * even be equal to this range. Note that collapsed ranges are always compared in strict mode.
129
+ * @returns `true` if given {@link module:engine/view/range~ViewRange range} boundaries are contained by this range, `false`
130
+ * otherwise.
131
+ */
132
+ containsRange(otherRange: ViewRange, loose?: boolean): boolean;
133
+ /**
134
+ * Computes which part(s) of this {@link module:engine/view/range~ViewRange range} is not a part of given
135
+ * {@link module:engine/view/range~ViewRange range}.
136
+ * Returned array contains zero, one or two {@link module:engine/view/range~ViewRange ranges}.
137
+ *
138
+ * Examples:
139
+ *
140
+ * ```ts
141
+ * let foo = downcastWriter.createText( 'foo' );
142
+ * let img = downcastWriter.createContainerElement( 'img' );
143
+ * let bar = downcastWriter.createText( 'bar' );
144
+ * let p = downcastWriter.createContainerElement( 'p', null, [ foo, img, bar ] );
145
+ *
146
+ * let range = view.createRange( view.createPositionAt( foo, 2 ), view.createPositionAt( bar, 1 ); // "o", img, "b" are in range.
147
+ * let otherRange = view.createRange( // "oo", img, "ba" are in range.
148
+ * view.createPositionAt( foo, 1 ),
149
+ * view.createPositionAt( bar, 2 )
150
+ * );
151
+ * let transformed = range.getDifference( otherRange );
152
+ * // transformed array has no ranges because `otherRange` contains `range`
153
+ *
154
+ * otherRange = view.createRange( view.createPositionAt( foo, 1 ), view.createPositionAt( p, 2 ); // "oo", img are in range.
155
+ * transformed = range.getDifference( otherRange );
156
+ * // transformed array has one range: from ( p, 2 ) to ( bar, 1 )
157
+ *
158
+ * otherRange = view.createRange( view.createPositionAt( p, 1 ), view.createPositionAt( p, 2 ) ); // img is in range.
159
+ * transformed = range.getDifference( otherRange );
160
+ * // transformed array has two ranges: from ( foo, 1 ) to ( p, 1 ) and from ( p, 2 ) to ( bar, 1 )
161
+ * ```
162
+ *
163
+ * @param otherRange Range to differentiate against.
164
+ * @returns The difference between ranges.
165
+ */
166
+ getDifference(otherRange: ViewRange): Array<ViewRange>;
167
+ /**
168
+ * Returns an intersection of this {@link module:engine/view/range~ViewRange range}
169
+ * and given {@link module:engine/view/range~ViewRange range}.
170
+ * Intersection is a common part of both of those ranges. If ranges has no common part, returns `null`.
171
+ *
172
+ * Examples:
173
+ *
174
+ * ```ts
175
+ * let foo = downcastWriter.createText( 'foo' );
176
+ * let img = downcastWriter.createContainerElement( 'img' );
177
+ * let bar = downcastWriter.createText( 'bar' );
178
+ * let p = downcastWriter.createContainerElement( 'p', null, [ foo, img, bar ] );
179
+ *
180
+ * let range = view.createRange( view.createPositionAt( foo, 2 ), view.createPositionAt( bar, 1 ); // "o", img, "b" are in range.
181
+ * let otherRange = view.createRange( view.createPositionAt( foo, 1 ), view.createPositionAt( p, 2 ); // "oo", img are in range.
182
+ * let transformed = range.getIntersection( otherRange ); // range from ( foo, 1 ) to ( p, 2 ).
183
+ *
184
+ * otherRange = view.createRange( view.createPositionAt( bar, 1 ), view.createPositionAt( bar, 3 ); "ar" is in range.
185
+ * transformed = range.getIntersection( otherRange ); // null - no common part.
186
+ * ```
187
+ *
188
+ * @param otherRange Range to check for intersection.
189
+ * @returns A common part of given ranges or `null` if ranges have no common part.
190
+ */
191
+ getIntersection(otherRange: ViewRange): ViewRange | null;
192
+ /**
193
+ * Creates a {@link module:engine/view/treewalker~ViewTreeWalker TreeWalker} instance with this range as a boundary.
194
+ *
195
+ * @param options Object with configuration options. See {@link module:engine/view/treewalker~ViewTreeWalker}.
196
+ */
197
+ getWalker(options?: ViewTreeWalkerOptions): ViewTreeWalker;
198
+ /**
199
+ * Returns a {@link module:engine/view/node~ViewNode} or {@link module:engine/view/documentfragment~ViewDocumentFragment}
200
+ * which is a common ancestor of range's both ends (in which the entire range is contained).
201
+ */
202
+ getCommonAncestor(): ViewNode | ViewDocumentFragment | null;
203
+ /**
204
+ * Returns an {@link module:engine/view/element~ViewElement Element} contained by the range.
205
+ * The element will be returned when it is the **only** node within the range and **fully–contained**
206
+ * at the same time.
207
+ */
208
+ getContainedElement(): ViewElement | null;
209
+ /**
210
+ * Clones this range.
211
+ */
212
+ clone(): ViewRange;
213
+ /**
214
+ * Returns an iterator that iterates over all {@link module:engine/view/item~ViewItem view items} that are in this range and returns
215
+ * them.
216
+ *
217
+ * This method uses {@link module:engine/view/treewalker~ViewTreeWalker} with `boundaries` set to this range
218
+ * and `ignoreElementEnd` option set to `true`. However it returns only {@link module:engine/view/item~ViewItem items},
219
+ * not {@link module:engine/view/treewalker~ViewTreeWalkerValue}.
220
+ *
221
+ * You may specify additional options for the tree walker. See {@link module:engine/view/treewalker~ViewTreeWalker} for
222
+ * a full list of available options.
223
+ *
224
+ * @param options Object with configuration options. See {@link module:engine/view/treewalker~ViewTreeWalker}.
225
+ */
226
+ getItems(options?: ViewTreeWalkerOptions): IterableIterator<ViewItem>;
227
+ /**
228
+ * Returns an iterator that iterates over all {@link module:engine/view/position~ViewPosition positions} that are boundaries or
229
+ * contained in this range.
230
+ *
231
+ * This method uses {@link module:engine/view/treewalker~ViewTreeWalker} with `boundaries` set to this range. However it returns only
232
+ * {@link module:engine/view/position~ViewPosition positions}, not {@link module:engine/view/treewalker~ViewTreeWalkerValue}.
233
+ *
234
+ * You may specify additional options for the tree walker. See {@link module:engine/view/treewalker~ViewTreeWalker} for
235
+ * a full list of available options.
236
+ *
237
+ * @param options Object with configuration options. See {@link module:engine/view/treewalker~ViewTreeWalker}.
238
+ */
239
+ getPositions(options?: ViewTreeWalkerOptions): IterableIterator<ViewPosition>;
240
+ /**
241
+ * Checks and returns whether this range intersects with the given range.
242
+ *
243
+ * @param otherRange Range to compare with.
244
+ * @returns True if ranges intersect.
245
+ */
246
+ isIntersecting(otherRange: ViewRange): boolean;
247
+ /**
248
+ * Converts `ViewRange` instance to plain object and returns it.
249
+ *
250
+ * @returns `ViewRange` instance converted to plain object.
251
+ */
252
+ toJSON(): unknown;
253
+ /**
254
+ * Creates a range from the given parents and offsets.
255
+ *
256
+ * @internal
257
+ * @param startElement Start position parent element.
258
+ * @param startOffset Start position offset.
259
+ * @param endElement End position parent element.
260
+ * @param endOffset End position offset.
261
+ * @returns Created range.
262
+ */
263
+ static _createFromParentsAndOffsets(startElement: ViewElement | ViewDocumentFragment, startOffset: number, endElement: ViewElement | ViewDocumentFragment, endOffset: number): ViewRange;
264
+ /**
265
+ * Creates a new range, spreading from specified {@link module:engine/view/position~ViewPosition position} to a position moved by
266
+ * given `shift`. If `shift` is a negative value, shifted position is treated as the beginning of the range.
267
+ *
268
+ * @internal
269
+ * @param position Beginning of the range.
270
+ * @param shift How long the range should be.
271
+ */
272
+ static _createFromPositionAndShift(position: ViewPosition, shift: number): ViewRange;
273
+ /**
274
+ * Creates a range inside an {@link module:engine/view/element~ViewElement element} which starts before the first child of
275
+ * that element and ends after the last child of that element.
276
+ *
277
+ * @internal
278
+ * @param element Element which is a parent for the range.
279
+ */
280
+ static _createIn(element: ViewElement | ViewDocumentFragment): ViewRange;
281
+ /**
282
+ * Creates a range that starts before given {@link module:engine/view/item~ViewItem view item} and ends after it.
283
+ *
284
+ * @internal
285
+ */
286
+ static _createOn(item: ViewItem): ViewRange;
287
287
  }