8
0

documentfragment.js 3.7 KB

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