diff --git a/src/model/element.js b/src/model/element.js index 4d01d0c0b..6efce6913 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -89,7 +89,7 @@ export default class Element extends Node { } /** - * Checks whether given model tree object is of given type. + * Checks whether this model object is of the given type. * * obj.name; // 'listItem' * obj instanceof Element; // true @@ -100,7 +100,7 @@ export default class Element extends Node { * obj.is( 'text' ); // false * obj.is( 'element', 'image' ); // false * - * Read more in {@link module:engine/model/node~Node#is}. + * Read more in {@link module:engine/model/node~Node#is `Node#is()`}. * * @param {String} type Type to check when `name` parameter is present. * Otherwise, it acts like the `name` parameter. diff --git a/src/view/element.js b/src/view/element.js index 2bd9ddee1..4e4a86560 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -147,9 +147,15 @@ export default class Element extends Node { } /** - * Checks whether given view tree object is of given type. + * Checks whether this view object is of the given type. * - * Read more in {@link module:engine/view/node~Node#is}. + * obj.is( 'element' ); // true + * obj.is( 'li' ); // true + * obj.is( 'element', 'li' ); // true + * obj.is( 'text' ); // false + * obj.is( 'element', 'img' ); // false + * + * Read more in {@link module:engine/view/node~Node#is `Node#is()`}. * * @param {String} type * @param {String} [name] Element name. diff --git a/src/view/node.js b/src/view/node.js index 13a7a08bc..0f9a2a991 100644 --- a/src/view/node.js +++ b/src/view/node.js @@ -287,7 +287,7 @@ export default class Node { } /** - * Checks whether given view tree object is of given type. + * Checks whether this view object is of the given type. * * This method is useful when processing view tree objects that are of unknown type. For example, a function * may return {@link module:engine/view/documentfragment~DocumentFragment} or {@link module:engine/view/node~Node} @@ -300,7 +300,6 @@ export default class Node { * obj.is( 'p' ); // shortcut for obj.is( 'element', 'p' ) * obj.is( 'text' ); // true for text node, false for element and document fragment * - * @method #is * @param {'element'|'containerElement'|'attributeElement'|'emptyElement'|'uiElement'| * 'rootElement'|'documentFragment'|'text'|'textProxy'} type * @returns {Boolean} diff --git a/src/view/observer/mutationobserver.js b/src/view/observer/mutationobserver.js index 818fcaabc..d49c7df49 100644 --- a/src/view/observer/mutationobserver.js +++ b/src/view/observer/mutationobserver.js @@ -55,7 +55,7 @@ export default class MutationObserver extends Observer { this.domConverter = view.domConverter; /** - * Reference to the {@link module:engine/view/view~View#renderer}. + * Reference to the {@link module:engine/view/view~View#_renderer}. * * @member {module:engine/view/renderer~Renderer} */ diff --git a/src/view/observer/observer.js b/src/view/observer/observer.js index 1ba4e277e..dcabe3df0 100644 --- a/src/view/observer/observer.js +++ b/src/view/observer/observer.js @@ -52,7 +52,7 @@ export default class Observer { /** * Enables the observer. This method is called when the observer is registered to the - * {@link module:engine/view/view~View} and after {@link module:engine/view/view~View#render rendering} + * {@link module:engine/view/view~View} and after {@link module:engine/view/view~View#forceRender rendering} * (all observers are {@link #disable disabled} before rendering). * * A typical use case for disabling observers is that mutation observers need to be disabled for the rendering. @@ -66,7 +66,7 @@ export default class Observer { /** * Disables the observer. This method is called before - * {@link module:engine/view/view~View#render rendering} to prevent firing events during rendering. + * {@link module:engine/view/view~View#forceRender rendering} to prevent firing events during rendering. * * @see module:engine/view/observer/observer~Observer#enable */ diff --git a/src/view/view.js b/src/view/view.js index bd170ad93..a3d46e0ea 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -71,8 +71,8 @@ export default class View { this.document = new Document(); /** - * Instance of the {@link module:engine/view/domconverter~DomConverter domConverter} use by - * {@link module:engine/view/view~View#renderer renderer} + * Instance of the {@link module:engine/view/domconverter~DomConverter domConverter} used by + * {@link module:engine/view/view~View#_renderer renderer} * and {@link module:engine/view/observer/observer~Observer observers}. * * @readonly @@ -80,6 +80,14 @@ export default class View { */ this.domConverter = new DomConverter(); + /** + * Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys. + * + * @readonly + * @type {Map.} + */ + this.domRoots = new Map(); + /** * Instance of the {@link module:engine/view/renderer~Renderer renderer}. * @@ -89,14 +97,6 @@ export default class View { this._renderer = new Renderer( this.domConverter, this.document.selection ); this._renderer.bind( 'isFocused' ).to( this.document ); - /** - * Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys. - * - * @readonly - * @type {Map.} - */ - this.domRoots = new Map(); - /** * 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 @@ -125,7 +125,7 @@ export default class View { this._ongoingChange = false; /** - * Used to prevent calling {@link #render} and {@link #change} during rendering view to the DOM. + * Used to prevent calling {@link #forceRender} and {@link #change} during rendering view to the DOM. * * @private * @type {Boolean} @@ -133,7 +133,7 @@ export default class View { this._renderingInProgress = false; /** - * Used to prevent calling {@link #render} and {@link #change} during rendering view to the DOM. + * Used to prevent calling {@link #forceRender} and {@link #change} during rendering view to the DOM. * * @private * @type {Boolean} @@ -434,8 +434,8 @@ export default class View { * cause some unexpected behaviour and inconsistency between the DOM and the view. * This may be caused by: * - * * calling {@link #change} or {@link #render} during rendering process, - * * calling {@link #change} or {@link #render} inside of + * * calling {@link #change} or {@link #forceRender} during rendering process, + * * calling {@link #change} or {@link #forceRender} inside of * {@link module:engine/view/document~Document#registerPostFixer post-fixer function}. * * @error cannot-change-view-tree