@ckeditor/ckeditor5-engine 45.2.1 → 46.0.0-alpha.0

package/src/model/documentselection.d.ts

@@ -5,51 +5,51 @@
 /**
  * @module engine/model/documentselection
  */
-import TypeCheckable from './typecheckable.js';
-import Selection, { type SelectionChangeAttributeEvent, type SelectionChangeRangeEvent } from './selection.js';
-import type { default as Document } from './document.js';
+import { ModelTypeCheckable } from './typecheckable.js';
+import { ModelSelection, type ModelSelectionChangeAttributeEvent, type ModelSelectionChangeRangeEvent } from './selection.js';
+import type { ModelDocument } from './document.js';
 import type { Marker } from './markercollection.js';
-import type Element from './element.js';
-import type Item from './item.js';
-import type { default as Position, PositionOffset } from './position.js';
-import type Range from './range.js';
+import { type ModelElement } from './element.js';
+import { type ModelItem } from './item.js';
+import type { ModelPosition, ModelPositionOffset } from './position.js';
+import { type ModelRange } from './range.js';
 import { Collection } from '@ckeditor/ckeditor5-utils';
-declare const DocumentSelection_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
+declare const ModelDocumentSelection_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ModelTypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
- * `DocumentSelection` is a special selection which is used as the
- * {@link module:engine/model/document~Document#selection document's selection}.
- * There can be only one instance of `DocumentSelection` per document.
+ * `ModelDocumentSelection` is a special selection which is used as the
+ * {@link module:engine/model/document~ModelDocument#selection document's selection}.
+ * There can be only one instance of `ModelDocumentSelection` per document.
  *
- * Document selection can only be changed by using the {@link module:engine/model/writer~Writer} instance
+ * Document selection can only be changed by using the {@link module:engine/model/writer~ModelWriter} instance
  * inside the {@link module:engine/model/model~Model#change `change()`} block, as it provides a secure way to modify model.
  *
- * `DocumentSelection` is automatically updated upon changes in the {@link module:engine/model/document~Document document}
+ * `ModelDocumentSelection` is automatically updated upon changes in the {@link module:engine/model/document~ModelDocument document}
  * to always contain valid ranges. Its attributes are inherited from the text unless set explicitly.
  *
- * Differences between {@link module:engine/model/selection~Selection} and `DocumentSelection` are:
- * * there is always a range in `DocumentSelection` - even if no ranges were added there is a "default range"
+ * Differences between {@link module:engine/model/selection~ModelSelection} and `ModelDocumentSelection` are:
+ * * there is always a range in `ModelDocumentSelection` - even if no ranges were added there is a "default range"
  * present in the selection,
  * * ranges added to this selection updates automatically when the document changes,
- * * attributes of `DocumentSelection` are updated automatically according to selection ranges.
+ * * attributes of `ModelDocumentSelection` are updated automatically according to selection ranges.
  *
- * Since `DocumentSelection` uses {@link module:engine/model/liverange~LiveRange live ranges}
- * and is updated when {@link module:engine/model/document~Document document}
- * changes, it cannot be set on {@link module:engine/model/node~Node nodes}
- * that are inside {@link module:engine/model/documentfragment~DocumentFragment document fragment}.
+ * Since `ModelDocumentSelection` uses {@link module:engine/model/liverange~ModelLiveRange live ranges}
+ * and is updated when {@link module:engine/model/document~ModelDocument document}
+ * changes, it cannot be set on {@link module:engine/model/node~ModelNode nodes}
+ * that are inside {@link module:engine/model/documentfragment~ModelDocumentFragment document fragment}.
  * If you need to represent a selection in document fragment,
- * use {@link module:engine/model/selection~Selection Selection class} instead.
+ * use {@link module:engine/model/selection~ModelSelection Selection class} instead.
  */
-export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection_base {
+export declare class ModelDocumentSelection extends /* #__PURE__ */ ModelDocumentSelection_base {
     /**
-     * Selection used internally by that class (`DocumentSelection` is a proxy to that selection).
+     * Selection used internally by that class (`ModelDocumentSelection` is a proxy to that selection).
      */
     private _selection;
     /**
-     * Creates an empty live selection for given {@link module:engine/model/document~Document}.
+     * Creates an empty live selection for given {@link module:engine/model/document~ModelDocument}.
      *
      * @param doc Document which owns this selection.
      */
-    constructor(doc: Document);
+    constructor(doc: ModelDocument);
     /**
      * Describes whether the selection is collapsed. Selection is collapsed when there is exactly one range which is
      * collapsed.
@@ -58,14 +58,14 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
     /**
      * Selection anchor. Anchor may be described as a position where the most recent part of the selection starts.
      * Together with {@link #focus} they define the direction of selection, which is important
-     * when expanding/shrinking selection. Anchor is always {@link module:engine/model/range~Range#start start} or
-     * {@link module:engine/model/range~Range#end end} position of the most recently added range.
+     * when expanding/shrinking selection. Anchor is always {@link module:engine/model/range~ModelRange#start start} or
+     * {@link module:engine/model/range~ModelRange#end end} position of the most recently added range.
      *
      * Is set to `null` if there are no ranges in selection.
      *
      * @see #focus
      */
-    get anchor(): Position | null;
+    get anchor(): ModelPosition | null;
     /**
      * Selection focus. Focus is a position where the selection ends.
      *
@@ -73,14 +73,14 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
      *
      * @see #anchor
      */
-    get focus(): Position | null;
+    get focus(): ModelPosition | null;
     /**
      * Number of ranges in selection.
      */
     get rangeCount(): number;
     /**
      * Describes whether `Documentselection` has own range(s) set, or if it is defaulted to
-     * {@link module:engine/model/document~Document#_getDefaultRange document's default range}.
+     * {@link module:engine/model/document~ModelDocument#_getDefaultRange document's default range}.
      */
     get hasOwnRange(): boolean;
     /**
@@ -92,7 +92,7 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
      */
     get isBackward(): boolean;
     /**
-     * Describes whether the gravity is overridden (using {@link module:engine/model/writer~Writer#overrideSelectionGravity}) or not.
+     * Describes whether the gravity is overridden (using {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}) or not.
      *
      * Note that the gravity remains overridden as long as will not be restored the same number of times as it was overridden.
      */
@@ -101,55 +101,55 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
      * A collection of selection {@link module:engine/model/markercollection~Marker markers}.
      * Marker is a selection marker when selection range is inside the marker range.
      *
-     * **Note**: Only markers from {@link ~DocumentSelection#observeMarkers observed markers groups} are collected.
+     * **Note**: Only markers from {@link ~ModelDocumentSelection#observeMarkers observed markers groups} are collected.
      */
     get markers(): Collection<Marker>;
     /**
-     * Used for the compatibility with the {@link module:engine/model/selection~Selection#isEqual} method.
+     * Used for the compatibility with the {@link module:engine/model/selection~ModelSelection#isEqual} method.
      *
      * @internal
      */
-    get _ranges(): Array<Range>;
+    get _ranges(): Array<ModelRange>;
     /**
      * Returns an iterable that iterates over copies of selection ranges.
      */
-    getRanges(): IterableIterator<Range>;
+    getRanges(): IterableIterator<ModelRange>;
     /**
      * Returns the first position in the selection.
-     * First position is the position that {@link module:engine/model/position~Position#isBefore is before}
+     * First position is the position that {@link module:engine/model/position~ModelPosition#isBefore is before}
      * any other position in the selection.
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getFirstPosition(): Position | null;
+    getFirstPosition(): ModelPosition | null;
     /**
      * Returns the last position in the selection.
-     * Last position is the position that {@link module:engine/model/position~Position#isAfter is after}
+     * Last position is the position that {@link module:engine/model/position~ModelPosition#isAfter is after}
      * any other position in the selection.
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getLastPosition(): Position | null;
+    getLastPosition(): ModelPosition | null;
     /**
      * Returns a copy of the first range in the selection.
-     * First range is the one which {@link module:engine/model/range~Range#start start} position
-     * {@link module:engine/model/position~Position#isBefore is before} start position of all other ranges
+     * First range is the one which {@link module:engine/model/range~ModelRange#start start} position
+     * {@link module:engine/model/position~ModelPosition#isBefore is before} start position of all other ranges
      * (not to confuse with the first range added to the selection).
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getFirstRange(): Range | null;
+    getFirstRange(): ModelRange | null;
     /**
      * Returns a copy of the last range in the selection.
-     * Last range is the one which {@link module:engine/model/range~Range#end end} position
-     * {@link module:engine/model/position~Position#isAfter is after} end position of all other ranges (not to confuse with the range most
-     * recently added to the selection).
+     * Last range is the one which {@link module:engine/model/range~ModelRange#end end} position
+     * {@link module:engine/model/position~ModelPosition#isAfter is after} end position of all
+     * other ranges (not to confuse with the range most recently added to the selection).
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getLastRange(): Range | null;
+    getLastRange(): ModelRange | null;
     /**
-     * Gets elements of type {@link module:engine/model/schema~Schema#isBlock "block"} touched by the selection.
+     * Gets elements of type {@link module:engine/model/schema~ModelSchema#isBlock "block"} touched by the selection.
      *
      * This method's result can be used for example to apply block styling to all blocks covered by this selection.
      *
@@ -201,22 +201,22 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
      * <paragraph>]c</paragraph> // this block will not be returned
      * ```
      */
-    getSelectedBlocks(): IterableIterator<Element>;
+    getSelectedBlocks(): IterableIterator<ModelElement>;
     /**
-     * Returns the selected element. {@link module:engine/model/element~Element Element} is considered as selected if there is only
+     * Returns the selected element. {@link module:engine/model/element~ModelElement Element} is considered as selected if there is only
      * one range in the selection, and that range contains exactly one element.
      * Returns `null` if there is no selected element.
      */
-    getSelectedElement(): Element | null;
+    getSelectedElement(): ModelElement | null;
     /**
      * Checks whether the selection contains the entire content of the given element. This means that selection must start
-     * at a position {@link module:engine/model/position~Position#isTouching touching} the element's start and ends at position
+     * at a position {@link module:engine/model/position~ModelPosition#isTouching touching} the element's start and ends at position
      * touching the element's end.
      *
      * By default, this method will check whether the entire content of the selection's current root is selected.
      * Useful to check if e.g. the user has just pressed <kbd>Ctrl</kbd> + <kbd>A</kbd>.
      */
-    containsEntireContent(element: Element): boolean;
+    containsEntireContent(element: ModelElement): boolean;
     /**
      * Unbinds all events previously bound by document selection.
      */
@@ -252,7 +252,7 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
     refresh(): void;
     /**
      * Registers a marker group prefix or a marker name to be collected in the
-     * {@link ~DocumentSelection#markers selection markers collection}.
+     * {@link ~ModelDocumentSelection#markers selection markers collection}.
      *
      * See also {@link module:engine/model/markercollection~MarkerCollection#getMarkersGroup `MarkerCollection#getMarkersGroup()`}.
      *
@@ -260,32 +260,32 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
      */
     observeMarkers(prefixOrName: string): void;
     /**
-     * Moves {@link module:engine/model/documentselection~DocumentSelection#focus} to the specified location.
-     * Should be used only within the {@link module:engine/model/writer~Writer#setSelectionFocus} method.
+     * Moves {@link module:engine/model/documentselection~ModelDocumentSelection#focus} to the specified location.
+     * Should be used only within the {@link module:engine/model/writer~ModelWriter#setSelectionFocus} method.
      *
      * The location can be specified in the same form as
-     * {@link module:engine/model/writer~Writer#createPositionAt writer.createPositionAt()} parameters.
+     * {@link module:engine/model/writer~ModelWriter#createPositionAt writer.createPositionAt()} parameters.
      *
-     * @see module:engine/model/writer~Writer#setSelectionFocus
+     * @see module:engine/model/writer~ModelWriter#setSelectionFocus
      * @internal
      * @param offset Offset or one of the flags. Used only when
-     * first parameter is a {@link module:engine/model/item~Item model item}.
+     * first parameter is a {@link module:engine/model/item~ModelItem model item}.
      */
-    _setFocus(itemOrPosition: Item | Position, offset?: PositionOffset): void;
+    _setFocus(itemOrPosition: ModelItem | ModelPosition, offset?: ModelPositionOffset): void;
     /**
      * Sets this selection's ranges and direction to the specified location based on the given
-     * {@link module:engine/model/selection~Selectable selectable}.
-     * Should be used only within the {@link module:engine/model/writer~Writer#setSelection} method.
+     * {@link module:engine/model/selection~ModelSelectable selectable}.
+     * Should be used only within the {@link module:engine/model/writer~ModelWriter#setSelection} method.
      *
-     * @see module:engine/model/writer~Writer#setSelection
+     * @see module:engine/model/writer~ModelWriter#setSelection
      * @internal
      */
-    _setTo(...args: Parameters<Selection['setTo']>): void;
+    _setTo(...args: Parameters<ModelSelection['setTo']>): void;
     /**
      * Sets attribute on the selection. If attribute with the same key already is set, it's value is overwritten.
-     * Should be used only within the {@link module:engine/model/writer~Writer#setSelectionAttribute} method.
+     * Should be used only within the {@link module:engine/model/writer~ModelWriter#setSelectionAttribute} method.
      *
-     * @see module:engine/model/writer~Writer#setSelectionAttribute
+     * @see module:engine/model/writer~ModelWriter#setSelectionAttribute
      * @internal
      * @param key Key of the attribute to set.
      * @param value Attribute value.
@@ -293,11 +293,11 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
     _setAttribute(key: string, value: unknown): void;
     /**
      * Removes an attribute with given key from the selection.
-     * If the given attribute was set on the selection, fires the {@link module:engine/model/selection~Selection#event:change:range}
+     * If the given attribute was set on the selection, fires the {@link module:engine/model/selection~ModelSelection#event:change:range}
      * event with removed attribute key.
-     * Should be used only within the {@link module:engine/model/writer~Writer#removeSelectionAttribute} method.
+     * Should be used only within the {@link module:engine/model/writer~ModelWriter#removeSelectionAttribute} method.
      *
-     * @see module:engine/model/writer~Writer#removeSelectionAttribute
+     * @see module:engine/model/writer~ModelWriter#removeSelectionAttribute
      * @internal
      * @param key Key of the attribute to remove.
      */
@@ -318,19 +318,19 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
      * It returns an unique identifier which is required to restore the gravity. It guarantees the symmetry
      * of the process.
      *
-     * @see module:engine/model/writer~Writer#overrideSelectionGravity
+     * @see module:engine/model/writer~ModelWriter#overrideSelectionGravity
      * @internal
      * @returns The unique id which allows restoring the gravity.
      */
     _overrideGravity(): string;
     /**
-     * Restores the {@link ~DocumentSelection#_overrideGravity overridden gravity}.
+     * Restores the {@link ~ModelDocumentSelection#_overrideGravity overridden gravity}.
      *
      * Restoring the gravity is only possible using the unique identifier returned by
-     * {@link ~DocumentSelection#_overrideGravity}. Note that the gravity remains overridden as long as won't be restored
+     * {@link ~ModelDocumentSelection#_overrideGravity}. Note that the gravity remains overridden as long as won't be restored
      * the same number of times it was overridden.
      *
-     * @see module:engine/model/writer~Writer#restoreSelectionGravity
+     * @see module:engine/model/writer~ModelWriter#restoreSelectionGravity
      * @internal
      * @param uid The unique id returned by {@link #_overrideGravity}.
      */
@@ -353,41 +353,41 @@ export default class DocumentSelection extends /* #__PURE__ */ DocumentSelection
 /**
  * Fired when selection range(s) changed.
  *
- * @eventName ~DocumentSelection#change:range
- * @param directChange In case of {@link module:engine/model/selection~Selection} class it is always set
+ * @eventName ~ModelDocumentSelection#change:range
+ * @param directChange In case of {@link module:engine/model/selection~ModelSelection} class it is always set
  * to `true` which indicates that the selection change was caused by a direct use of selection's API.
- * The {@link module:engine/model/documentselection~DocumentSelection}, however, may change because its position
- * was directly changed through the {@link module:engine/model/writer~Writer writer} or because its position was
+ * The {@link module:engine/model/documentselection~ModelDocumentSelection}, however, may change because its position
+ * was directly changed through the {@link module:engine/model/writer~ModelWriter writer} or because its position was
  * changed because the structure of the model has been changed (which means an indirect change).
  * The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live")
  * which mean that they are not updated once the document changes.
  */
-export type DocumentSelectionChangeRangeEvent = SelectionChangeRangeEvent;
+export type ModelDocumentSelectionChangeRangeEvent = ModelSelectionChangeRangeEvent;
 /**
  * Fired when selection attribute changed.
  *
- * @eventName ~DocumentSelection#change:attribute
- * @param directChange In case of {@link module:engine/model/selection~Selection} class it is always set
+ * @eventName ~ModelDocumentSelection#change:attribute
+ * @param directChange In case of {@link module:engine/model/selection~ModelSelection} class it is always set
  * to `true` which indicates that the selection change was caused by a direct use of selection's API.
- * The {@link module:engine/model/documentselection~DocumentSelection}, however, may change because its attributes
- * were directly changed through the {@link module:engine/model/writer~Writer writer} or because its position was
+ * The {@link module:engine/model/documentselection~ModelDocumentSelection}, however, may change because its attributes
+ * were directly changed through the {@link module:engine/model/writer~ModelWriter writer} or because its position was
  * changed in the model and its attributes were refreshed (which means an indirect change).
  * The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live")
  * which mean that they are not updated once the document changes.
  * @param attributeKeys Array containing keys of attributes that changed.
 */
-export type DocumentSelectionChangeAttributeEvent = SelectionChangeAttributeEvent;
+export type ModelDocumentSelectionChangeAttributeEvent = ModelSelectionChangeAttributeEvent;
 /**
  * Fired when selection marker(s) changed.
  *
- * @eventName ~DocumentSelection#change:marker
+ * @eventName ~ModelDocumentSelection#change:marker
  * @param directChange This is always set to `false` in case of `change:marker` event as there is no possibility
- * to change markers directly through {@link module:engine/model/documentselection~DocumentSelection} API.
- * See also {@link module:engine/model/documentselection~DocumentSelection#event:change:range} and
- * {@link module:engine/model/documentselection~DocumentSelection#event:change:attribute}.
+ * to change markers directly through {@link module:engine/model/documentselection~ModelDocumentSelection} API.
+ * See also {@link module:engine/model/documentselection~ModelDocumentSelection#event:change:range} and
+ * {@link module:engine/model/documentselection~ModelDocumentSelection#event:change:attribute}.
  * @param oldMarkers Markers in which the selection was before the change.
  */
-export type DocumentSelectionChangeMarkerEvent = {
+export type ModelDocumentSelectionChangeMarkerEvent = {
     name: 'change:marker';
     args: [
         {
@@ -399,15 +399,15 @@ export type DocumentSelectionChangeMarkerEvent = {
 /**
  * Fired when selection range(s), attribute(s) or marker(s) changed.
  *
- * @eventName ~DocumentSelection#change
+ * @eventName ~ModelDocumentSelection#change
  * @param directChange This is always set to `false` in case of `change:marker` event as there is no possibility
- * to change markers directly through {@link module:engine/model/documentselection~DocumentSelection} API.
- * See also {@link module:engine/model/documentselection~DocumentSelection#event:change:range} and
- * {@link module:engine/model/documentselection~DocumentSelection#event:change:attribute}.
+ * to change markers directly through {@link module:engine/model/documentselection~ModelDocumentSelection} API.
+ * See also {@link module:engine/model/documentselection~ModelDocumentSelection#event:change:range} and
+ * {@link module:engine/model/documentselection~ModelDocumentSelection#event:change:attribute}.
  * @param attributeKeys Array containing keys of attributes that changed.
  * @param oldMarkers Markers in which the selection was before the change.
  */
-export type DocumentSelectionChangeEvent = {
+export type ModelDocumentSelectionChangeEvent = {
     name: 'change' | 'change:attribute' | 'change:marker' | 'change:range';
     args: [
         {