| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/model/element
- */
- import Node from './node';
- import NodeList from './nodelist';
- import Text from './text';
- import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable';
- /**
- * Model element. Type of {@link module:engine/model/node~Node node} that has a {@link module:engine/model/element~Element#name name} and
- * {@link module:engine/model/element~Element#getChildren child nodes}.
- *
- * **Important**: see {@link module:engine/model/node~Node} to read about restrictions using `Element` and `Node` API.
- */
- export default class Element extends Node {
- /**
- * Creates a model element.
- *
- * @param {String} name Element's name.
- * @param {Object} [attrs] Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
- * @param {module:engine/model/node~Node|Iterable.<module:engine/model/node~Node>} [children]
- * One or more nodes to be inserted as children of created element.
- */
- constructor( name, attrs, children ) {
- super( attrs );
- /**
- * Element name.
- *
- * @member {String} module:engine/model/element~Element#name
- */
- this.name = name;
- /**
- * List of children nodes.
- *
- * @private
- * @member {module:engine/model/nodelist~NodeList} module:engine/model/element~Element#_children
- */
- this._children = new NodeList();
- if ( children ) {
- this.insertChildren( 0, children );
- }
- }
- /**
- * Number of this element's children.
- *
- * @readonly
- * @type {Number}
- */
- get childCount() {
- return this._children.length;
- }
- /**
- * Sum of {module:engine/model/node~Node#offsetSize offset sizes} of all of this element's children.
- *
- * @readonly
- * @type {Number}
- */
- get maxOffset() {
- return this._children.maxOffset;
- }
- /**
- * Is `true` if there are no nodes inside this element, `false` otherwise.
- *
- * @readonly
- * @type {Boolean}
- */
- get isEmpty() {
- return this.childCount === 0;
- }
- /**
- * Checks whether given model tree object is of given type.
- *
- * obj.name; // 'listItem'
- * obj instanceof Element; // true
- *
- * obj.is( 'element' ); // true
- * obj.is( 'listItem' ); // true
- * obj.is( 'element', 'listItem' ); // true
- * obj.is( 'text' ); // false
- * obj.is( 'element', 'image' ); // false
- *
- * Read more in {@link module:engine/model/node~Node#is}.
- *
- * @param {String} type Type to check when `name` parameter is present.
- * Otherwise, it acts like the `name` parameter.
- * @param {String} [name] Element name.
- * @returns {Boolean}
- */
- is( type, name = null ) {
- if ( !name ) {
- return type == 'element' || type == this.name;
- } else {
- return type == 'element' && name == this.name;
- }
- }
- /**
- * Gets the child at the given index.
- *
- * @param {Number} index Index of child.
- * @returns {module:engine/model/node~Node} Child node.
- */
- getChild( index ) {
- return this._children.getNode( index );
- }
- /**
- * Returns an iterator that iterates over all of this element's children.
- *
- * @returns {Iterable.<module:engine/model/node~Node>}
- */
- getChildren() {
- return this._children[ Symbol.iterator ]();
- }
- /**
- * Returns an index of the given child node. Returns `null` if given node is not a child of this element.
- *
- * @param {module:engine/model/node~Node} node Child node to look for.
- * @returns {Number} Child node's index in this element.
- */
- getChildIndex( node ) {
- return this._children.getNodeIndex( node );
- }
- /**
- * Returns the starting offset of given child. Starting offset is equal to the sum of
- * {module:engine/model/node~Node#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
- * given node is not a child of this element.
- *
- * @param {module:engine/model/node~Node} node Child node to look for.
- * @returns {Number} Child node's starting offset.
- */
- getChildStartOffset( node ) {
- return this._children.getNodeStartOffset( node );
- }
- /**
- * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element.
- * If clone is deep, the original element's children are also cloned. If not, then empty element is removed.
- *
- * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`,
- * element will be cloned without any child.
- */
- clone( deep = false ) {
- const children = deep ? Array.from( this._children ).map( node => node.clone( true ) ) : null;
- return new Element( this.name, this.getAttributes(), children );
- }
- /**
- * Returns index of a node that occupies given offset. If given offset is too low, returns `0`. If given offset is
- * too high, returns {@link module:engine/model/element~Element#getChildIndex index after last child}.
- *
- * const textNode = new Text( 'foo' );
- * const pElement = new Element( 'p' );
- * const divElement = new Element( [ textNode, pElement ] );
- * divElement.offsetToIndex( -1 ); // Returns 0, because offset is too low.
- * divElement.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
- * divElement.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
- * divElement.offsetToIndex( 2 ); // Returns 0.
- * divElement.offsetToIndex( 3 ); // Returns 1.
- * divElement.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
- *
- * @param {Number} offset Offset to look for.
- * @returns {Number}
- */
- offsetToIndex( offset ) {
- return this._children.offsetToIndex( offset );
- }
- /**
- * {@link module:engine/model/element~Element#insertChildren Inserts} one or more nodes at the end of this element.
- *
- * @param {module:engine/model/node~Node|Iterable.<module:engine/model/node~Node>} nodes Nodes to be inserted.
- */
- appendChildren( nodes ) {
- this.insertChildren( this.childCount, nodes );
- }
- /**
- * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes
- * to this element.
- *
- * @param {Number} index Index at which nodes should be inserted.
- * @param {module:engine/model/node~Node|Iterable.<module:engine/model/node~Node>} nodes Nodes to be inserted.
- */
- insertChildren( index, nodes ) {
- nodes = normalize( nodes );
- for ( const node of nodes ) {
- node.parent = this;
- }
- this._children.insertNodes( index, nodes );
- }
- /**
- * Removes one or more nodes starting at the given index and sets
- * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
- *
- * @param {Number} index Index of the first node to remove.
- * @param {Number} [howMany=1] Number of nodes to remove.
- * @returns {Array.<module:engine/model/node~Node>} Array containing removed nodes.
- */
- removeChildren( index, howMany = 1 ) {
- const nodes = this._children.removeNodes( index, howMany );
- for ( const node of nodes ) {
- node.parent = null;
- }
- return nodes;
- }
- /**
- * Returns a descendant node by its path relative to this element.
- *
- * // <this>a<b>c</b></this>
- * this.getNodeByPath( [ 0 ] ); // -> "a"
- * this.getNodeByPath( [ 1 ] ); // -> <b>
- * this.getNodeByPath( [ 1, 0 ] ); // -> "c"
- *
- * @param {Array.<Number>} relativePath Path of the node to find, relative to this element.
- * @returns {module:engine/model/node~Node}
- */
- getNodeByPath( relativePath ) {
- let node = this; // eslint-disable-line consistent-this
- for ( const index of relativePath ) {
- node = node.getChild( node.offsetToIndex( index ) );
- }
- return node;
- }
- /**
- * Converts `Element` instance to plain object and returns it. Takes care of converting all of this element's children.
- *
- * @returns {Object} `Element` instance converted to plain object.
- */
- toJSON() {
- const json = super.toJSON();
- json.name = this.name;
- if ( this._children.length > 0 ) {
- json.children = [];
- for ( const node of this._children ) {
- json.children.push( node.toJSON() );
- }
- }
- return json;
- }
- /**
- * Creates an `Element` instance from given plain object (i.e. parsed JSON string).
- * Converts `Element` children to proper nodes.
- *
- * @param {Object} json Plain object to be converted to `Element`.
- * @returns {module:engine/model/element~Element} `Element` instance created using given plain object.
- */
- static fromJSON( json ) {
- let children = null;
- if ( json.children ) {
- children = [];
- for ( const child of json.children ) {
- if ( child.name ) {
- // If child has name property, it is an Element.
- children.push( Element.fromJSON( child ) );
- } else {
- // Otherwise, it is a Text node.
- children.push( Text.fromJSON( child ) );
- }
- }
- }
- return new Element( json.name, json.attributes, children );
- }
- }
- // Converts strings to Text and non-iterables to arrays.
- //
- // @param {String|module:engine/model/node~Node|Iterable.<String|module:engine/model/node~Node>}
- // @return {Iterable.<module:engine/model/node~Node>}
- function normalize( nodes ) {
- // Separate condition because string is iterable.
- if ( typeof nodes == 'string' ) {
- return [ new Text( nodes ) ];
- }
- if ( !isIterable( nodes ) ) {
- nodes = [ nodes ];
- }
- // Array.from to enable .map() on non-arrays.
- return Array.from( nodes )
- .map( node => {
- return typeof node == 'string' ? new Text( node ) : node;
- } );
- }
|