8
0

documentfragment.js 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  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 utils from '../../utils/utils.js';
  7. import EmitterMixin from '../../utils/emittermixin.js';
  8. /**
  9. * DocumentFragment class.
  10. *
  11. * @memberOf engine.treeView
  12. */
  13. export default class DocumentFragment {
  14. /**
  15. * Creates new DocumentFragment instance.
  16. *
  17. * @param {engine.treeView.Node|Iterable.<engine.treeView.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.treeView.Element>} engine.treeView.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. * {@link engine.treeView.DocumentFragment#insertChildren Insert} a child node or a list of child nodes at the end
  40. * and sets the parent of these nodes to this fragment.
  41. *
  42. * @param {engine.treeView.Node|Iterable.<engine.treeView.Node>} nodes Node or the list of nodes to be inserted.
  43. * @returns {Number} Number of appended nodes.
  44. */
  45. appendChildren( nodes ) {
  46. return this.insertChildren( this.getChildCount(), nodes );
  47. }
  48. /**
  49. * Gets child at the given index.
  50. *
  51. * @param {Number} index Index of child.
  52. * @returns {engine.treeView.Node} Child node.
  53. */
  54. getChild( index ) {
  55. return this._children[ index ];
  56. }
  57. /**
  58. * Gets the number of elements in fragment.
  59. *
  60. * @returns {Number} The number of elements.
  61. */
  62. getChildCount() {
  63. return this._children.length;
  64. }
  65. /**
  66. * Gets index of the given child node. Returns `-1` if child node is not found.
  67. *
  68. * @param {engine.treeView.Node} node Child node.
  69. * @returns {Number} Index of the child node.
  70. */
  71. getChildIndex( node ) {
  72. return this._children.indexOf( node );
  73. }
  74. /**
  75. * Gets child nodes iterator.
  76. *
  77. * @returns {Iterable.<engine.treeView.Node>} Child nodes iterator.
  78. */
  79. getChildren() {
  80. return this._children[ Symbol.iterator ]();
  81. }
  82. /**
  83. * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to
  84. * this fragment.
  85. *
  86. * @param {Number} index Position where nodes should be inserted.
  87. * @param {engine.treeView.Node|Iterable.<engine.treeView.Node>} nodes Node or list of nodes to be inserted.
  88. * @returns {Number} Number of inserted nodes.
  89. */
  90. insertChildren( index, nodes ) {
  91. this._fireChange( 'CHILDREN', this );
  92. let count = 0;
  93. if ( !utils.isIterable( nodes ) ) {
  94. nodes = [ nodes ];
  95. }
  96. for ( let node of nodes ) {
  97. node.parent = this;
  98. this._children.splice( index, 0, node );
  99. index++;
  100. count++;
  101. }
  102. return count;
  103. }
  104. /**
  105. * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`.
  106. *
  107. * @param {Number} index Number of the first node to remove.
  108. * @param {Number} [howMany=1] Number of nodes to remove.
  109. * @returns {Array.<engine.treeView.Node>} The array of removed nodes.
  110. */
  111. removeChildren( index, howMany = 1 ) {
  112. this._fireChange( 'CHILDREN', this );
  113. for ( let i = index; i < index + howMany; i++ ) {
  114. this._children[ i ].parent = null;
  115. }
  116. return this._children.splice( index, howMany );
  117. }
  118. /**
  119. * Fires `change` event with given type of the change.
  120. *
  121. * @private
  122. * @param {engine.treeView.ChangeType} type Type of the change.
  123. * @param {engine.treeView.Node} node Changed node.
  124. * @fires engine.treeView.Node#change
  125. */
  126. _fireChange( type, node ) {
  127. this.fire( 'change', type, node );
  128. }
  129. }
  130. utils.mix( DocumentFragment, EmitterMixin );