Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'origin/master' into t/ckeditor5/479
Browse files Browse the repository at this point in the history
  • Loading branch information
oleq committed Feb 7, 2019
2 parents 459002c + 4fba713 commit c5ab990
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 23 deletions.
4 changes: 2 additions & 2 deletions src/model/element.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
10 changes: 8 additions & 2 deletions src/view/element.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions src/view/node.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand All @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion src/view/observer/mutationobserver.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
Expand Down
4 changes: 2 additions & 2 deletions src/view/observer/observer.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
*/
Expand Down
28 changes: 14 additions & 14 deletions src/view/view.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,23 @@ 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
* @type {module:engine/view/domconverter~DomConverter}
*/
this.domConverter = new DomConverter();

/**
* Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys.
*
* @readonly
* @type {Map.<String, HTMLElement>}
*/
this.domRoots = new Map();

/**
* Instance of the {@link module:engine/view/renderer~Renderer renderer}.
*
Expand All @@ -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.<String, HTMLElement>}
*/
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
Expand Down Expand Up @@ -125,15 +125,15 @@ 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}
*/
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}
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c5ab990

Please sign in to comment.