8
0

documentfragment.js 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import mix from '../../utils/mix.js';
  6. import isIterable from '../../utils/isiterable.js';
  7. import EmitterMixin from '../../utils/emittermixin.js';
  8. /**
  9. * DocumentFragment class.
  10. *
  11. * @memberOf engine.view
  12. */
  13. export default class DocumentFragment {
  14. /**
  15. * Creates new DocumentFragment instance.
  16. *
  17. * @param {engine.view.Node|Iterable.<engine.view.Node>} [children] List of nodes to be inserted into
  18. * created document fragment.
  19. */
  20. constructor( children ) {
  21. /**
  22. * Array of child nodes.
  23. *
  24. * @protected
  25. * @member {Array.<engine.view.Element>} engine.view.DocumentFragment#_children
  26. */
  27. this._children = [];
  28. if ( children ) {
  29. this.insertChildren( 0, children );
  30. }
  31. }
  32. /**
  33. * Iterates over nodes added to this DocumentFragment.
  34. */
  35. [ Symbol.iterator ]() {
  36. return this._children[ Symbol.iterator ]();
  37. }
  38. /**
  39. * Artificial root of `DocumentFragment`. Returns itself. Added for compatibility reasons.
  40. *
  41. * @readonly
  42. * @type {engine.model.DocumentFragment}
  43. */
  44. get root() {
  45. return this;
  46. }
  47. /**
  48. * Returns ancestor elements of `DocumentFragment`, which is an empty array. Added for compatibility reasons.
  49. *
  50. * @returns {Array}
  51. */
  52. getAncestors() {
  53. return [];
  54. }
  55. /**
  56. * {@link engine.view.DocumentFragment#insertChildren Insert} a child node or a list of child nodes at the end
  57. * and sets the parent of these nodes to this fragment.
  58. *
  59. * @param {engine.view.Node|Iterable.<engine.view.Node>} nodes Node or the list of nodes to be inserted.
  60. * @returns {Number} Number of appended nodes.
  61. */
  62. appendChildren( nodes ) {
  63. return this.insertChildren( this.getChildCount(), nodes );
  64. }
  65. /**
  66. * Gets child at the given index.
  67. *
  68. * @param {Number} index Index of child.
  69. * @returns {engine.view.Node} Child node.
  70. */
  71. getChild( index ) {
  72. return this._children[ index ];
  73. }
  74. /**
  75. * Gets the number of elements in fragment.
  76. *
  77. * @returns {Number} The number of elements.
  78. */
  79. getChildCount() {
  80. return this._children.length;
  81. }
  82. /**
  83. * Gets index of the given child node. Returns `-1` if child node is not found.
  84. *
  85. * @param {engine.view.Node} node Child node.
  86. * @returns {Number} Index of the child node.
  87. */
  88. getChildIndex( node ) {
  89. return this._children.indexOf( node );
  90. }
  91. /**
  92. * Gets child nodes iterator.
  93. *
  94. * @returns {Iterable.<engine.view.Node>} Child nodes iterator.
  95. */
  96. getChildren() {
  97. return this._children[ Symbol.iterator ]();
  98. }
  99. /**
  100. * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to
  101. * this fragment.
  102. *
  103. * @param {Number} index Position where nodes should be inserted.
  104. * @param {engine.view.Node|Iterable.<engine.view.Node>} nodes Node or list of nodes to be inserted.
  105. * @returns {Number} Number of inserted nodes.
  106. */
  107. insertChildren( index, nodes ) {
  108. this._fireChange( 'children', this );
  109. let count = 0;
  110. if ( !isIterable( nodes ) ) {
  111. nodes = [ nodes ];
  112. }
  113. for ( let node of nodes ) {
  114. node.parent = this;
  115. this._children.splice( index, 0, node );
  116. index++;
  117. count++;
  118. }
  119. return count;
  120. }
  121. /**
  122. * Returns `true` if there are no nodes inside this document fragment, `false` otherwise.
  123. *
  124. * @returns {Boolean}
  125. */
  126. isEmpty() {
  127. return this.getChildCount() === 0;
  128. }
  129. /**
  130. * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`.
  131. *
  132. * @param {Number} index Number of the first node to remove.
  133. * @param {Number} [howMany=1] Number of nodes to remove.
  134. * @returns {Array.<engine.view.Node>} The array of removed nodes.
  135. */
  136. removeChildren( index, howMany = 1 ) {
  137. this._fireChange( 'children', this );
  138. for ( let i = index; i < index + howMany; i++ ) {
  139. this._children[ i ].parent = null;
  140. }
  141. return this._children.splice( index, howMany );
  142. }
  143. /**
  144. * Fires `change` event with given type of the change.
  145. *
  146. * @private
  147. * @param {engine.view.ChangeType} type Type of the change.
  148. * @param {engine.view.Node} node Changed node.
  149. * @fires engine.view.Node#change
  150. */
  151. _fireChange( type, node ) {
  152. this.fire( 'change:' + type, node );
  153. }
  154. }
  155. mix( DocumentFragment, EmitterMixin );