| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/view/node
- */
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- import clone from '@ckeditor/ckeditor5-utils/src/lib/lodash/clone';
- /**
- * Abstract tree view node class.
- *
- * @abstract
- */
- export default class Node {
- /**
- * Creates a tree view node.
- *
- * This is an abstract class, so this constructor should not be used directly.
- */
- constructor() {
- /**
- * Parent element. Null by default. Set by {@link module:engine/view/element~Element#_insertChildren}.
- *
- * @readonly
- * @member {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null}
- */
- this.parent = null;
- }
- /**
- * Index of the node in the parent element or null if the node has no parent.
- *
- * Accessing this property throws an error if this node's parent element does not contain it.
- * This means that view tree got broken.
- *
- * @readonly
- * @type {Number|null}
- */
- get index() {
- let pos;
- if ( !this.parent ) {
- return null;
- }
- // No parent or child doesn't exist in parent's children.
- if ( ( pos = this.parent.getChildIndex( this ) ) == -1 ) {
- /**
- * The node's parent does not contain this node. It means that the document tree is corrupted.
- *
- * @error view-node-not-found-in-parent
- */
- throw new CKEditorError( 'view-node-not-found-in-parent: The node\'s parent does not contain this node.' );
- }
- return pos;
- }
- /**
- * Node's next sibling, or `null` if it is the last child.
- *
- * @readonly
- * @type {module:engine/view/node~Node|null}
- */
- get nextSibling() {
- const index = this.index;
- return ( index !== null && this.parent.getChild( index + 1 ) ) || null;
- }
- /**
- * Node's previous sibling, or `null` if it is the first child.
- *
- * @readonly
- * @type {module:engine/view/node~Node|null}
- */
- get previousSibling() {
- const index = this.index;
- return ( index !== null && this.parent.getChild( index - 1 ) ) || null;
- }
- /**
- * Top-most ancestor of the node. If the node has no parent it is the root itself.
- *
- * @readonly
- * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment}
- */
- get root() {
- let root = this; // eslint-disable-line consistent-this
- while ( root.parent ) {
- root = root.parent;
- }
- return root;
- }
- /**
- * {@link module:engine/view/document~Document View document} that owns this node, or `null` if the node is inside
- * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
- *
- * @readonly
- * @type {module:engine/view/document~Document|null}
- */
- get document() {
- // Parent might be Node, null or DocumentFragment.
- if ( this.parent instanceof Node ) {
- return this.parent.document;
- } else {
- return null;
- }
- }
- /**
- * Returns ancestors array of this node.
- *
- * @param {Object} options Options object.
- * @param {Boolean} [options.includeSelf=false] When set to `true` this node will be also included in parent's array.
- * @param {Boolean} [options.parentFirst=false] When set to `true`, array will be sorted from node's parent to root element,
- * otherwise root element will be the first item in the array.
- * @returns {Array} Array with ancestors.
- */
- getAncestors( options = { includeSelf: false, parentFirst: false } ) {
- const ancestors = [];
- let parent = options.includeSelf ? this : this.parent;
- while ( parent ) {
- ancestors[ options.parentFirst ? 'push' : 'unshift' ]( parent );
- parent = parent.parent;
- }
- return ancestors;
- }
- /**
- * Returns a {@link module:engine/view/element~Element} or {@link module:engine/view/documentfragment~DocumentFragment}
- * which is a common ancestor of both nodes.
- *
- * @param {module:engine/view/node~Node} node The second node.
- * @param {Object} options Options object.
- * @param {Boolean} [options.includeSelf=false] When set to `true` both nodes will be considered "ancestors" too.
- * Which means that if e.g. node A is inside B, then their common ancestor will be B.
- * @returns {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null}
- */
- getCommonAncestor( node, options = {} ) {
- const ancestorsA = this.getAncestors( options );
- const ancestorsB = node.getAncestors( options );
- let i = 0;
- while ( ancestorsA[ i ] == ancestorsB[ i ] && ancestorsA[ i ] ) {
- i++;
- }
- return i === 0 ? null : ancestorsA[ i - 1 ];
- }
- /**
- * Removes node from parent.
- *
- * @protected
- */
- _remove() {
- this.parent._removeChildren( this.index );
- }
- /**
- * @param {module:engine/view/document~ChangeType} type Type of the change.
- * @param {module:engine/view/node~Node} node Changed node.
- * @fires change
- */
- _fireChange( type, node ) {
- this.fire( 'change:' + type, node );
- if ( this.parent ) {
- this.parent._fireChange( type, node );
- }
- }
- /**
- * Custom toJSON method to solve child-parent circular dependencies.
- *
- * @returns {Object} Clone of this object with the parent property removed.
- */
- toJSON() {
- const json = clone( this );
- // Due to circular references we need to remove parent reference.
- delete json.parent;
- return json;
- }
- /**
- * Checks whether given view tree object is of 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}
- * that can be either text node or element. This method can be used to check what kind of object is returned.
- *
- * obj.is( 'node' ); // true for any node, false for document fragment and text fragment
- * obj.is( 'documentFragment' ); // true for document fragment, false for any node
- * obj.is( 'element' ); // true for any element, false for text node or document fragment
- * obj.is( 'element', 'p' ); // true only for element which name is 'p'
- * 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}
- */
- is( type ) {
- return type == 'node';
- }
- /**
- * Clones this node.
- *
- * @method #clone
- * @returns {module:engine/view/node~Node} Clone of this node.
- */
- /**
- * Checks if provided node is similar to this node.
- *
- * @method #isSimilar
- * @returns {Boolean} True if nodes are similar.
- */
- }
- /**
- * Fired when list of {@link module:engine/view/element~Element elements} children changes.
- *
- * Change event is bubbled – it is fired on all ancestors.
- *
- * @event change:children
- * @param {module:engine/view/node~Node} changedNode
- */
- /**
- * Fired when list of {@link module:engine/view/element~Element elements} attributes changes.
- *
- * Change event is bubbled – it is fired on all ancestors.
- *
- * @event change:attributes
- * @param {module:engine/view/node~Node} changedNode
- */
- /**
- * Fired when {@link module:engine/view/text~Text text nodes} data changes.
- *
- * Change event is bubbled – it is fired on all ancestors.
- *
- * @event change:text
- * @param {module:engine/view/node~Node} changedNode
- */
- /**
- * @event change
- */
- mix( Node, EmitterMixin );
|