selection.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treeview */
  6. 'use strict';
  7. import Selection from '/ckeditor5/engine/treeview/selection.js';
  8. import Range from '/ckeditor5/engine/treeview/range.js';
  9. import Element from '/ckeditor5/engine/treeview/element.js';
  10. import CKEditorError from '/ckeditor5/utils/ckeditorerror.js';
  11. describe( 'Selection', () => {
  12. let selection;
  13. let el;
  14. let range1, range2, range3;
  15. beforeEach( () => {
  16. selection = new Selection();
  17. el = new Element( 'p' );
  18. range1 = Range.createFromParentsAndOffsets( el, 5, el, 10 );
  19. range2 = Range.createFromParentsAndOffsets( el, 1, el, 2 );
  20. range3 = Range.createFromParentsAndOffsets( el, 12, el, 14 );
  21. } );
  22. describe( 'anchor', () => {
  23. it( 'should return null if no ranges in selection', () => {
  24. expect( selection.anchor ).to.be.null;
  25. } );
  26. it( 'should return start of single range in selection', () => {
  27. selection.addRange( range1 );
  28. const anchor = selection.anchor;
  29. expect( anchor.isEqual( range1.start ) ).to.be.true;
  30. expect( anchor ).to.not.equal( range1.start );
  31. } );
  32. it( 'should return end of single range in selection when added as backward', () => {
  33. selection.addRange( range1, true );
  34. const anchor = selection.anchor;
  35. expect( anchor.isEqual( range1.end ) ).to.be.true;
  36. expect( anchor ).to.not.equal( range1.end );
  37. } );
  38. it( 'should get anchor from last inserted range', () => {
  39. selection.addRange( range1 );
  40. selection.addRange( range2 );
  41. expect( selection.anchor.isEqual( range2.start ) ).to.be.true;
  42. } );
  43. } );
  44. describe( 'focus', () => {
  45. it( 'should return null if no ranges in selection', () => {
  46. expect( selection.focus ).to.be.null;
  47. } );
  48. it( 'should return end of single range in selection', () => {
  49. selection.addRange( range1 );
  50. const focus = selection.focus;
  51. expect( focus.isEqual( range1.end ) ).to.be.true;
  52. } );
  53. it( 'should return start of single range in selection when added as backward', () => {
  54. selection.addRange( range1, true );
  55. const focus = selection.focus;
  56. expect( focus.isEqual( range1.start ) ).to.be.true;
  57. expect( focus ).to.not.equal( range1.start );
  58. } );
  59. it( 'should get focus from last inserted range', () => {
  60. selection.addRange( range1 );
  61. selection.addRange( range2 );
  62. expect( selection.focus.isEqual( range2.end ) ).to.be.true;
  63. } );
  64. } );
  65. describe( 'isCollapsed', () => {
  66. it( 'should return true when there is single collapsed range', () => {
  67. const range = Range.createFromParentsAndOffsets( el, 5, el, 5 );
  68. selection.addRange( range );
  69. expect( selection.isCollapsed ).to.be.true;
  70. } );
  71. it( 'should return false when there are multiple ranges', () => {
  72. const range1 = Range.createFromParentsAndOffsets( el, 5, el, 5 );
  73. const range2 = Range.createFromParentsAndOffsets( el, 15, el, 15 );
  74. selection.addRange( range1 );
  75. selection.addRange( range2 );
  76. expect( selection.isCollapsed ).to.be.false;
  77. } );
  78. it( 'should return false when there is not collapsed range', () => {
  79. const range = Range.createFromParentsAndOffsets( el, 15, el, 16 );
  80. selection.addRange( range );
  81. expect( selection.isCollapsed ).to.be.false;
  82. } );
  83. } );
  84. describe( 'rangeCount', () => {
  85. it( 'should return proper range count', () => {
  86. expect( selection.rangeCount ).to.equal( 0 );
  87. selection.addRange( range1 );
  88. expect( selection.rangeCount ).to.equal( 1 );
  89. selection.addRange( range2 );
  90. expect( selection.rangeCount ).to.equal( 2 );
  91. } );
  92. } );
  93. describe( 'isBackward', () => {
  94. it( 'is defined by the last added range', () => {
  95. const range1 = Range.createFromParentsAndOffsets( el, 5, el, 10 );
  96. const range2 = Range.createFromParentsAndOffsets( el, 15, el, 16 );
  97. selection.addRange( range1, true );
  98. expect( selection ).to.have.property( 'isBackward', true );
  99. selection.addRange( range2 );
  100. expect( selection ).to.have.property( 'isBackward', false );
  101. } );
  102. it( 'is false when last range is collapsed', () => {
  103. const range = Range.createFromParentsAndOffsets( el, 5, el, 5 );
  104. selection.addRange( range, true );
  105. expect( selection.isBackward ).to.be.false;
  106. } );
  107. } );
  108. describe( 'addRange', () => {
  109. it( 'should add range to selection ranges', () => {
  110. selection.addRange( range1 );
  111. expect( selection._ranges[ 0 ].isEqual( range1 ) ).to.be.true;
  112. } );
  113. it( 'should fire change event', ( done ) => {
  114. selection.once( 'change', () => {
  115. expect( selection._ranges[ 0 ].isEqual( range1 ) ).to.be.true;
  116. done();
  117. } );
  118. selection.addRange( range1 );
  119. } );
  120. it( 'should throw when range is intersecting with already added range', () => {
  121. const range2 = Range.createFromParentsAndOffsets( el, 7, el, 15 );
  122. selection.addRange( range1 );
  123. expect( () => {
  124. selection.addRange( range2 );
  125. } ).to.throw( CKEditorError, 'view-selection-range-intersects' );
  126. expect( () => {
  127. selection.addRange( range1 );
  128. } ).to.throw( CKEditorError, 'view-selection-range-intersects' );
  129. } );
  130. } );
  131. describe( 'getRanges', () => {
  132. it( 'should return iterator with copies of all ranges', () => {
  133. selection.addRange( range1 );
  134. selection.addRange( range2 );
  135. const iterable = selection.getRanges();
  136. const ranges = Array.from( iterable );
  137. expect( ranges.length ).to.equal( 2 );
  138. expect( ranges[ 0 ].isEqual( range1 ) ).to.be.true;
  139. expect( ranges[ 0 ] ).to.not.equal( range1 );
  140. expect( ranges[ 1 ].isEqual( range2 ) ).to.be.true;
  141. expect( ranges[ 1 ] ).to.not.equal( range2 );
  142. } );
  143. } );
  144. describe( 'getFirstRange', () => {
  145. it( 'should return copy of range with first position', () => {
  146. selection.addRange( range1 );
  147. selection.addRange( range2 );
  148. selection.addRange( range3 );
  149. const range = selection.getFirstRange();
  150. expect( range.isEqual( range2 ) ).to.be.true;
  151. expect( range ).to.not.equal( range2 );
  152. } );
  153. it( 'should return null if no ranges are present', () => {
  154. expect( selection.getFirstRange() ).to.be.null;
  155. } );
  156. } );
  157. describe( 'getLastRange', () => {
  158. it( 'should return copy of range with last position', () => {
  159. selection.addRange( range1 );
  160. selection.addRange( range2 );
  161. selection.addRange( range3 );
  162. const range = selection.getLastRange();
  163. expect( range.isEqual( range3 ) ).to.be.true;
  164. expect( range ).to.not.equal( range3 );
  165. } );
  166. it( 'should return null if no ranges are present', () => {
  167. expect( selection.getLastRange() ).to.be.null;
  168. } );
  169. } );
  170. describe( 'getFirstPosition', () => {
  171. it( 'should return copy of first position', () => {
  172. selection.addRange( range1 );
  173. selection.addRange( range2 );
  174. selection.addRange( range3 );
  175. const position = selection.getFirstPosition();
  176. expect( position.isEqual( range2.start ) ).to.be.true;
  177. expect( position ).to.not.equal( range2.start );
  178. } );
  179. it( 'should return null if no ranges are present', () => {
  180. expect( selection.getFirstPosition() ).to.be.null;
  181. } );
  182. } );
  183. describe( 'getLastPosition', () => {
  184. it( 'should return copy of range with last position', () => {
  185. selection.addRange( range1 );
  186. selection.addRange( range2 );
  187. selection.addRange( range3 );
  188. const position = selection.getLastPosition();
  189. expect( position.isEqual( range3.end ) ).to.be.true;
  190. expect( position ).to.not.equal( range3.end );
  191. } );
  192. it( 'should return null if no ranges are present', () => {
  193. expect( selection.getLastPosition() ).to.be.null;
  194. } );
  195. } );
  196. describe( 'isEqual', () => {
  197. it( 'should return true if selections equal', () => {
  198. selection.addRange( range1 );
  199. selection.addRange( range2 );
  200. const otherSelection = new Selection();
  201. otherSelection.addRange( range1 );
  202. otherSelection.addRange( range2 );
  203. expect( selection.isEqual( otherSelection ) ).to.be.true;
  204. } );
  205. it( 'should return true if backward selections equal', () => {
  206. selection.addRange( range1, true );
  207. const otherSelection = new Selection();
  208. otherSelection.addRange( range1, true );
  209. expect( selection.isEqual( otherSelection ) ).to.be.true;
  210. } );
  211. it( 'should return false if ranges count does not equal', () => {
  212. selection.addRange( range1 );
  213. selection.addRange( range2 );
  214. const otherSelection = new Selection();
  215. otherSelection.addRange( range1 );
  216. expect( selection.isEqual( otherSelection ) ).to.be.false;
  217. } );
  218. it( 'should return false if ranges do not equal', () => {
  219. selection.addRange( range1 );
  220. const otherSelection = new Selection();
  221. otherSelection.addRange( range2 );
  222. expect( selection.isEqual( otherSelection ) ).to.be.false;
  223. } );
  224. it( 'should return false if directions do not equal', () => {
  225. selection.addRange( range1 );
  226. const otherSelection = new Selection();
  227. otherSelection.addRange( range2, true );
  228. expect( selection.isEqual( otherSelection ) ).to.be.false;
  229. } );
  230. } );
  231. describe( 'removeAllRanges', () => {
  232. it( 'should remove all ranges and fire change event', ( done ) => {
  233. selection.addRange( range1 );
  234. selection.addRange( range2 );
  235. selection.once( 'change', () => {
  236. expect( selection.rangeCount ).to.equal( 0 );
  237. done();
  238. } );
  239. selection.removeAllRanges();
  240. } );
  241. it( 'should do nothing when no ranges are present', () => {
  242. const fireSpy = sinon.spy( selection, 'fire' );
  243. selection.removeAllRanges();
  244. fireSpy.restore();
  245. expect( fireSpy.notCalled ).to.be.true;
  246. } );
  247. } );
  248. describe( 'setRanges', () => {
  249. it( 'should add ranges and fire change event', ( done ) => {
  250. selection.addRange( range1 );
  251. selection.once( 'change', () => {
  252. expect( selection.rangeCount ).to.equal( 2 );
  253. expect( selection._ranges[ 0 ].isEqual( range2 ) ).to.be.true;
  254. expect( selection._ranges[ 0 ] ).is.not.equal( range2 );
  255. expect( selection._ranges[ 1 ].isEqual( range3 ) ).to.be.true;
  256. expect( selection._ranges[ 1 ] ).is.not.equal( range3 );
  257. done();
  258. } );
  259. selection.setRanges( [ range2, range3 ] );
  260. } );
  261. } );
  262. describe( 'setTo', () => {
  263. it( 'should return true if selections equal', () => {
  264. selection.addRange( range1 );
  265. const otherSelection = new Selection();
  266. otherSelection.addRange( range2 );
  267. otherSelection.addRange( range3, true );
  268. selection.setTo( otherSelection );
  269. expect( selection.rangeCount ).to.equal( 2 );
  270. expect( selection._ranges[ 0 ].isEqual( range2 ) ).to.be.true;
  271. expect( selection._ranges[ 0 ] ).is.not.equal( range2 );
  272. expect( selection._ranges[ 1 ].isEqual( range3 ) ).to.be.true;
  273. expect( selection._ranges[ 1 ] ).is.not.equal( range3 );
  274. expect( selection.anchor.isEqual( range3.end ) ).to.be.true;
  275. } );
  276. } );
  277. describe( 'collapseToStart', () => {
  278. it( 'should collapse to start position and fire change event', ( done ) => {
  279. selection.setRanges( [ range1, range2, range3 ] );
  280. selection.once( 'change', () => {
  281. expect( selection.rangeCount ).to.equal( 1 );
  282. expect( selection.isCollapsed ).to.be.true;
  283. expect( selection._ranges[ 0 ].start.isEqual( range2.start ) ).to.be.true;
  284. done();
  285. } );
  286. selection.collapseToStart();
  287. } );
  288. it( 'should do nothing if no ranges present', () => {
  289. const fireSpy = sinon.spy( selection, 'fire' );
  290. selection.collapseToStart();
  291. fireSpy.restore();
  292. expect( fireSpy.notCalled ).to.be.true;
  293. } );
  294. } );
  295. describe( 'collapseToEnd', () => {
  296. it( 'should collapse to end position and fire change event', ( done ) => {
  297. selection.setRanges( [ range1, range2, range3 ] );
  298. selection.once( 'change', () => {
  299. expect( selection.rangeCount ).to.equal( 1 );
  300. expect( selection.isCollapsed ).to.be.true;
  301. expect( selection._ranges[ 0 ].end.isEqual( range3.end ) ).to.be.true;
  302. done();
  303. } );
  304. selection.collapseToEnd();
  305. } );
  306. it( 'should do nothing if no ranges present', () => {
  307. const fireSpy = sinon.spy( selection, 'fire' );
  308. selection.collapseToEnd();
  309. fireSpy.restore();
  310. expect( fireSpy.notCalled ).to.be.true;
  311. } );
  312. } );
  313. } );