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

package/src/view/view.js

@@ -5,22 +5,22 @@
 /**
  * @module engine/view/view
  */
-import Document from './document.js';
-import DowncastWriter from './downcastwriter.js';
-import Renderer from './renderer.js';
-import DomConverter from './domconverter.js';
-import Position from './position.js';
-import Range from './range.js';
-import Selection from './selection.js';
-import KeyObserver from './observer/keyobserver.js';
-import FakeSelectionObserver from './observer/fakeselectionobserver.js';
-import MutationObserver from './observer/mutationobserver.js';
-import SelectionObserver from './observer/selectionobserver.js';
-import FocusObserver from './observer/focusobserver.js';
-import CompositionObserver from './observer/compositionobserver.js';
-import InputObserver from './observer/inputobserver.js';
-import ArrowKeysObserver from './observer/arrowkeysobserver.js';
-import TabObserver from './observer/tabobserver.js';
+import { ViewDocument } from './document.js';
+import { ViewDowncastWriter } from './downcastwriter.js';
+import { ViewRenderer } from './renderer.js';
+import { ViewDomConverter } from './domconverter.js';
+import { ViewPosition } from './position.js';
+import { ViewRange } from './range.js';
+import { ViewSelection } from './selection.js';
+import { KeyObserver } from './observer/keyobserver.js';
+import { FakeSelectionObserver } from './observer/fakeselectionobserver.js';
+import { MutationObserver } from './observer/mutationobserver.js';
+import { SelectionObserver } from './observer/selectionobserver.js';
+import { FocusObserver } from './observer/focusobserver.js';
+import { CompositionObserver } from './observer/compositionobserver.js';
+import { InputObserver } from './observer/inputobserver.js';
+import { ArrowKeysObserver } from './observer/arrowkeysobserver.js';
+import { TabObserver } from './observer/tabobserver.js';
 import { CKEditorError, env, ObservableMixin, scrollViewportToShowTarget } from '@ckeditor/ckeditor5-utils';
 import { injectUiElementHandling } from './uielement.js';
 import { injectQuirksHandling } from './filler.js';
@@ -30,8 +30,8 @@ import { cloneDeep } from 'es-toolkit/compat';
  * abstraction over the DOM structure and events and hide all browsers quirks.
  *
  * View controller renders view document to DOM whenever view structure changes. To determine when view can be rendered,
- * all changes need to be done using the {@link module:engine/view/view~View#change} method, using
- * {@link module:engine/view/downcastwriter~DowncastWriter}:
+ * all changes need to be done using the {@link module:engine/view/view~EditingView#change} method, using
+ * {@link module:engine/view/downcastwriter~ViewDowncastWriter}:
  *
  * ```ts
  * view.change( writer => {
@@ -40,7 +40,7 @@ import { cloneDeep } from 'es-toolkit/compat';
  * ```
  *
  * View controller also register {@link module:engine/view/observer/observer~Observer observers} which observes changes
- * on DOM and fire events on the {@link module:engine/view/document~Document Document}.
+ * on DOM and fire events on the {@link module:engine/view/document~ViewDocument Document}.
  * Note that the following observers are added by the class constructor and are always available:
  *
  * * {@link module:engine/view/observer/selectionobserver~SelectionObserver},
@@ -52,19 +52,20 @@ import { cloneDeep } from 'es-toolkit/compat';
  * * {@link module:engine/view/observer/arrowkeysobserver~ArrowKeysObserver}.
  * * {@link module:engine/view/observer/tabobserver~TabObserver}.
  *
- * This class also {@link module:engine/view/view~View#attachDomRoot binds the DOM and the view elements}.
+ * This class also {@link module:engine/view/view~EditingView#attachDomRoot binds the DOM and the view elements}.
  *
  * If you do not need full a DOM - view management, and only want to transform a tree of view elements to a tree of DOM
- * elements you do not need this controller. You can use the {@link module:engine/view/domconverter~DomConverter DomConverter} instead.
+ * elements you do not need this controller. You can use the {@link module:engine/view/domconverter~ViewDomConverter ViewDomConverter}
+ * instead.
  */
-export default class View extends /* #__PURE__ */ ObservableMixin() {
+export class EditingView extends /* #__PURE__ */ ObservableMixin() {
     /**
-     * Instance of the {@link module:engine/view/document~Document} associated with this view controller.
+     * Instance of the {@link module:engine/view/document~ViewDocument} associated with this view controller.
      */
     document;
     /**
-     * Instance of the {@link module:engine/view/domconverter~DomConverter domConverter} used by
-     * {@link module:engine/view/view~View#_renderer renderer}
+     * Instance of the {@link module:engine/view/domconverter~ViewDomConverter domConverter} used by
+     * {@link module:engine/view/view~EditingView#_renderer renderer}
      * and {@link module:engine/view/observer/observer~Observer observers}.
      */
     domConverter;
@@ -73,13 +74,13 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
      */
     domRoots = new Map();
     /**
-     * Instance of the {@link module:engine/view/renderer~Renderer renderer}.
+     * Instance of the {@link module:engine/view/renderer~ViewRenderer renderer}.
      */
     _renderer;
     /**
      * A DOM root attributes cache. It saves the initial values of DOM root attributes before the DOM element
-     * is {@link module:engine/view/view~View#attachDomRoot attached} to the view so later on, when
-     * the view is destroyed ({@link module:engine/view/view~View#detachDomRoot}), they can be easily restored.
+     * is {@link module:engine/view/view~EditingView#attachDomRoot attached} to the view so later on, when
+     * the view is destroyed ({@link module:engine/view/view~EditingView#detachDomRoot}), they can be easily restored.
      * This way, the DOM element can go back to the (clean) state as if the editing view never used it.
      */
     _initialDomRootAttributes = new WeakMap();
@@ -88,7 +89,7 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
      */
     _observers = new Map();
     /**
-     * DowncastWriter instance used in {@link #change change method} callbacks.
+     * ViewDowncastWriter instance used in {@link #change change method} callbacks.
      */
     _writer;
     /**
@@ -113,16 +114,16 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
      */
     constructor(stylesProcessor) {
         super();
-        this.document = new Document(stylesProcessor);
-        this.domConverter = new DomConverter(this.document);
+        this.document = new ViewDocument(stylesProcessor);
+        this.domConverter = new ViewDomConverter(this.document);
         this.set('isRenderingInProgress', false);
         this.set('hasDomSelection', false);
-        this._renderer = new Renderer(this.domConverter, this.document.selection);
+        this._renderer = new ViewRenderer(this.domConverter, this.document.selection);
         this._renderer.bind('isFocused', 'isSelecting', 'isComposing')
             .to(this.document, 'isFocused', 'isSelecting', 'isComposing');
-        this._writer = new DowncastWriter(this.document);
+        this._writer = new ViewDowncastWriter(this.document);
         // Add default observers.
-        // Make sure that this list matches AlwaysRegisteredObservers type.
+        // Make sure that this list matches AlwaysRegisteredViewObservers type.
         this.addObserver(MutationObserver);
         this.addObserver(FocusObserver);
         this.addObserver(SelectionObserver);
@@ -174,7 +175,7 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
     }
     /**
      * Attaches a DOM root element to the view element and enable all observers on that element.
-     * Also {@link module:engine/view/renderer~Renderer#markToSync mark element} to be synchronized
+     * Also {@link module:engine/view/renderer~ViewRenderer#markToSync mark element} to be synchronized
      * with the view what means that all child nodes will be removed and replaced with content of the view root.
      *
      * This method also will change view element name as the same as tag name of given dom root.
@@ -369,7 +370,7 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
         scrollViewportToShowTarget(options);
     }
     /**
-     * It will focus DOM element representing {@link module:engine/view/editableelement~EditableElement EditableElement}
+     * It will focus DOM element representing {@link module:engine/view/editableelement~ViewEditableElement ViewEditableElement}
      * that is currently having selection inside.
      */
     focus() {
@@ -411,7 +412,7 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
      * ```
      *
      * When the outermost change block is done and rendering to the DOM is over the
-     * {@link module:engine/view/view~View#event:render `View#render`} event is fired.
+     * {@link module:engine/view/view~EditingView#event:render `View#render`} event is fired.
      *
      * This method throws a `applying-view-changes-on-rendering` error when
      * the change block is used after rendering to the DOM has started.
@@ -426,10 +427,10 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
              * cause some unexpected behaviour and inconsistency between the DOM and the view.
              * This may be caused by:
              *
-             * * calling {@link module:engine/view/view~View#change} or {@link module:engine/view/view~View#forceRender} during rendering
-             * process,
-             * * calling {@link module:engine/view/view~View#change} or {@link module:engine/view/view~View#forceRender} inside of
-             *   {@link module:engine/view/document~Document#registerPostFixer post-fixer function}.
+             * * calling {@link module:engine/view/view~EditingView#change} or {@link module:engine/view/view~EditingView#forceRender}
+             * during rendering process,
+             * * calling {@link module:engine/view/view~EditingView#change} or {@link module:engine/view/view~EditingView#forceRender}
+             * inside of {@link module:engine/view/document~ViewDocument#registerPostFixer post-fixer function}.
              *
              * @error cannot-change-view-tree
              */
@@ -463,7 +464,7 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
         }
     }
     /**
-     * Forces rendering {@link module:engine/view/document~Document view document} to DOM. If any view changes are
+     * Forces rendering {@link module:engine/view/document~ViewDocument view document} to DOM. If any view changes are
      * currently in progress, rendering will start after all {@link #change change blocks} are processed.
      *
      * Note that this method is dedicated for special cases. All view changes should be wrapped in the {@link #change}
@@ -490,20 +491,20 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
     /**
      * Creates position at the given location. The location can be specified as:
      *
-     * * a {@link module:engine/view/position~Position position},
+     * * a {@link module:engine/view/position~ViewPosition position},
      * * parent element and offset (offset defaults to `0`),
      * * parent element and `'end'` (sets position at the end of that element),
-     * * {@link module:engine/view/item~Item view item} and `'before'` or `'after'` (sets position before or after given view item).
+     * * {@link module:engine/view/item~ViewItem view item} and `'before'` or `'after'` (sets position before or after given view item).
      *
      * This method is a shortcut to other constructors such as:
      *
      * * {@link #createPositionBefore},
      * * {@link #createPositionAfter},
      *
-     * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/view/item~Item view item}.
+     * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/view/item~ViewItem view item}.
      */
     createPositionAt(itemOrPosition, offset) {
-        return Position._createAt(itemOrPosition, offset);
+        return ViewPosition._createAt(itemOrPosition, offset);
     }
     /**
      * Creates a new position after given view item.
@@ -511,7 +512,7 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
      * @param item View item after which the position should be located.
      */
     createPositionAfter(item) {
-        return Position._createAfter(item);
+        return ViewPosition._createAfter(item);
     }
     /**
      * Creates a new position before given view item.
@@ -519,36 +520,36 @@ export default class View extends /* #__PURE__ */ ObservableMixin() {
      * @param item View item before which the position should be located.
      */
     createPositionBefore(item) {
-        return Position._createBefore(item);
+        return ViewPosition._createBefore(item);
     }
     /**
      * Creates a range spanning from `start` position to `end` position.
      *
-     * **Note:** This factory method creates it's own {@link module:engine/view/position~Position} instances basing on passed values.
+     * **Note:** This factory method creates it's own {@link module:engine/view/position~ViewPosition} instances basing on passed values.
      *
      * @param start Start position.
      * @param end End position. If not set, range will be collapsed at `start` position.
      */
     createRange(start, end) {
-        return new Range(start, end);
+        return new ViewRange(start, end);
     }
     /**
-     * Creates a range that starts before given {@link module:engine/view/item~Item view item} and ends after it.
+     * Creates a range that starts before given {@link module:engine/view/item~ViewItem view item} and ends after it.
      */
     createRangeOn(item) {
-        return Range._createOn(item);
+        return ViewRange._createOn(item);
     }
     /**
-     * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of
+     * Creates a range inside an {@link module:engine/view/element~ViewElement element} which starts before the first child of
      * that element and ends after the last child of that element.
      *
      * @param element Element which is a parent for the range.
      */
     createRangeIn(element) {
-        return Range._createIn(element);
+        return ViewRange._createIn(element);
     }
     createSelection(...args) {
-        return new Selection(...args);
+        return new ViewSelection(...args);
     }
     /**
      * Disables or enables rendering. If the flag is set to `true` then the rendering will be disabled.