8
0

selectionobserver.js 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: view, browser-only */
  6. 'use strict';
  7. import ViewRange from '/ckeditor5/engine/view/range.js';
  8. import testUtils from '/tests/ckeditor5/_utils/utils.js';
  9. import ViewSelection from '/ckeditor5/engine/view/selection.js';
  10. import ViewDocument from '/ckeditor5/engine/view/document.js';
  11. import SelectionObserver from '/ckeditor5/engine/view/observer/selectionobserver.js';
  12. import MutationObserver from '/ckeditor5/engine/view/observer/mutationobserver.js';
  13. import EmitterMixin from '/ckeditor5/utils/emittermixin.js';
  14. import log from '/ckeditor5/utils/log.js';
  15. import { parse } from '/tests/engine/_utils/view.js';
  16. testUtils.createSinonSandbox();
  17. describe( 'SelectionObserver', () => {
  18. let viewDocument, viewRoot, mutationObserver, selectionObserver, listenter;
  19. before( () => {
  20. listenter = Object.create( EmitterMixin );
  21. viewDocument = new ViewDocument();
  22. viewDocument.createRoot( document.getElementById( 'main' ) );
  23. mutationObserver = viewDocument.addObserver( MutationObserver );
  24. selectionObserver = viewDocument.addObserver( SelectionObserver );
  25. viewRoot = viewDocument.getRoot();
  26. viewRoot.appendChildren( parse(
  27. '<container:p>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</container:p>' +
  28. '<container:p>yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy</container:p>' ) );
  29. viewDocument.render();
  30. } );
  31. beforeEach( ( done ) => {
  32. viewDocument.selection.removeAllRanges();
  33. document.getSelection().removeAllRanges();
  34. viewDocument.selectedEditable = viewRoot;
  35. viewDocument.isFocused = true;
  36. viewDocument.getObserver( SelectionObserver ).enable();
  37. // Ensure selectionchange will not be fired.
  38. setTimeout( () => done(), 100 );
  39. } );
  40. afterEach( () => {
  41. listenter.stopListening();
  42. } );
  43. it( 'should fire selectionChange when it is the only change', ( done ) => {
  44. listenter.listenTo( viewDocument, 'selectionChange', ( evt, data ) => {
  45. expect( data ).to.have.property( 'domSelection' ).that.equals( document.getSelection() );
  46. expect( data ).to.have.property( 'oldSelection' ).that.is.instanceof( ViewSelection );
  47. expect( data.oldSelection.rangeCount ).to.equal( 0 );
  48. expect( data ).to.have.property( 'newSelection' ).that.is.instanceof( ViewSelection );
  49. expect( data.newSelection.rangeCount ).to.equal( 1 );
  50. const newViewRange = data.newSelection.getFirstRange();
  51. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  52. expect( newViewRange.start.parent ).to.equal( viewFoo );
  53. expect( newViewRange.start.offset ).to.equal( 1 );
  54. expect( newViewRange.end.parent ).to.equal( viewFoo );
  55. expect( newViewRange.end.offset ).to.equal( 2 );
  56. done();
  57. } );
  58. changeDomSelection();
  59. } );
  60. it( 'should add only one listener to one document', ( done ) => {
  61. // Add second roots to ensure that listener is added once.
  62. viewDocument.createRoot( document.getElementById( 'additional' ), 'additional' );
  63. listenter.listenTo( viewDocument, 'selectionChange', () => {
  64. done();
  65. } );
  66. changeDomSelection();
  67. } );
  68. it( 'should not fire selectionChange on render', ( done ) => {
  69. listenter.listenTo( viewDocument, 'selectionChange', () => {
  70. throw 'selectionChange on render';
  71. } );
  72. setTimeout( () => done(), 70 );
  73. const viewBar = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  74. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewBar, 1, viewBar, 2 ) );
  75. viewDocument.render();
  76. } );
  77. it( 'should not fired if observer is disabled', ( done ) => {
  78. viewDocument.getObserver( SelectionObserver ).disable();
  79. listenter.listenTo( viewDocument, 'selectionChange', () => {
  80. throw 'selectionChange on render';
  81. } );
  82. setTimeout( () => done(), 70 );
  83. changeDomSelection();
  84. } );
  85. it( 'should not fired if there is no focus', ( done ) => {
  86. viewDocument.isFocused = false;
  87. listenter.listenTo( viewDocument, 'selectionChange', () => {
  88. throw 'selectionChange on render';
  89. } );
  90. setTimeout( () => done(), 70 );
  91. changeDomSelection();
  92. } );
  93. it( 'should warn and not enter infinite loop', ( done ) => {
  94. let counter = 30;
  95. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  96. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewFoo, 0, viewFoo, 0 ) );
  97. listenter.listenTo( viewDocument, 'selectionChange', () => {
  98. counter--;
  99. if ( counter > 0 ) {
  100. setTimeout( changeDomSelection );
  101. } else {
  102. throw( 'Infinite loop!' );
  103. }
  104. } );
  105. let warnedOnce = false;
  106. testUtils.sinon.stub( log, 'warn', ( msg ) => {
  107. if ( !warnedOnce ) {
  108. warnedOnce = true;
  109. setTimeout( () => {
  110. expect( msg ).to.match( /^selectionchange-infinite-loop/ );
  111. done();
  112. }, 200 );
  113. }
  114. } );
  115. changeDomSelection();
  116. } );
  117. it( 'should not be treated as an infinite loop if the position is different', ( done ) => {
  118. let counter = 30;
  119. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  120. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewFoo, 0, viewFoo, 0 ) );
  121. listenter.listenTo( viewDocument, 'selectionChange', () => {
  122. counter--;
  123. if ( counter > 0 ) {
  124. setTimeout( () => changeCollapsedDomSelection( counter ) );
  125. } else {
  126. done();
  127. }
  128. } );
  129. changeCollapsedDomSelection( counter );
  130. } );
  131. it( 'should not be treated as an infinite loop if it is less then 3 times', ( done ) => {
  132. let counter = 3;
  133. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  134. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewFoo, 0, viewFoo, 0 ) );
  135. listenter.listenTo( viewDocument, 'selectionChange', () => {
  136. counter--;
  137. if ( counter > 0 ) {
  138. setTimeout( () => changeDomSelection() );
  139. } else {
  140. done();
  141. }
  142. } );
  143. changeDomSelection();
  144. } );
  145. it( 'should call render after selection change which reset selection if it was not changed', ( done ) => {
  146. const viewBar = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  147. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewBar, 0, viewBar, 1 ) );
  148. listenter.listenTo( viewDocument, 'selectionChange', () => {
  149. setTimeout( () => {
  150. const domSelection = document.getSelection();
  151. expect( domSelection.rangeCount ).to.equal( 1 );
  152. const domRange = domSelection.getRangeAt( 0 );
  153. const domBar = document.getElementById( 'main' ).childNodes[ 1 ].childNodes[ 0 ];
  154. expect( domRange.startContainer ).to.equal( domBar );
  155. expect( domRange.startOffset ).to.equal( 0 );
  156. expect( domRange.endContainer ).to.equal( domBar );
  157. expect( domRange.endOffset ).to.equal( 1 );
  158. done();
  159. } );
  160. } );
  161. changeDomSelection();
  162. } );
  163. } );
  164. function changeCollapsedDomSelection( pos = 1 ) {
  165. const domSelection = document.getSelection();
  166. domSelection.removeAllRanges();
  167. const domFoo = document.getElementById( 'main' ).childNodes[ 0 ].childNodes[ 0 ];
  168. const domRange = new Range();
  169. domRange.setStart( domFoo, pos );
  170. domRange.setEnd( domFoo, pos );
  171. domSelection.addRange( domRange );
  172. }
  173. function changeDomSelection() {
  174. const domSelection = document.getSelection();
  175. domSelection.removeAllRanges();
  176. const domFoo = document.getElementById( 'main' ).childNodes[ 0 ].childNodes[ 0 ];
  177. const domRange = new Range();
  178. domRange.setStart( domFoo, 1 );
  179. domRange.setEnd( domFoo, 2 );
  180. domSelection.addRange( domRange );
  181. }