selection.js 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import Model from '../../src/model/model';
  6. import Element from '../../src/model/element';
  7. import Text from '../../src/model/text';
  8. import Range from '../../src/model/range';
  9. import Position from '../../src/model/position';
  10. import LiveRange from '../../src/model/liverange';
  11. import Selection from '../../src/model/selection';
  12. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  13. import count from '@ckeditor/ckeditor5-utils/src/count';
  14. import { parse, setData } from '../../src/dev-utils/model';
  15. import Schema from '../../src/model/schema';
  16. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  17. describe( 'Selection', () => {
  18. let model, doc, root, selection, liveRange, range, range1, range2, range3;
  19. testUtils.createSinonSandbox();
  20. beforeEach( () => {
  21. model = new Model();
  22. doc = model.document;
  23. root = doc.createRoot();
  24. root._appendChild( [
  25. new Element( 'p' ),
  26. new Element( 'p' ),
  27. new Element( 'p', [], new Text( 'foobar' ) ),
  28. new Element( 'p' ),
  29. new Element( 'p' ),
  30. new Element( 'p' ),
  31. new Element( 'p', [], new Text( 'foobar' ) )
  32. ] );
  33. selection = new Selection();
  34. liveRange = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  35. range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 2, 2 ] ) );
  36. range1 = new Range( new Position( root, [ 1 ] ), new Position( root, [ 4 ] ) );
  37. range2 = new Range( new Position( root, [ 4 ] ), new Position( root, [ 5 ] ) );
  38. range3 = new Range( new Position( root, [ 6 ] ), new Position( root, [ 7 ] ) );
  39. } );
  40. afterEach( () => {
  41. model.destroy();
  42. liveRange.detach();
  43. } );
  44. describe( 'constructor()', () => {
  45. it( 'should be able to create an empty selection', () => {
  46. const selection = new Selection();
  47. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [] );
  48. } );
  49. it( 'should be able to create a selection from the given ranges', () => {
  50. const ranges = [ range1, range2, range3 ];
  51. const selection = new Selection( ranges );
  52. expect( Array.from( selection.getRanges() ) ).to.deep.equal( ranges );
  53. } );
  54. it( 'should be able to create a selection from the given range and isLastBackward flag', () => {
  55. const selection = new Selection( range1, { backward: true } );
  56. expect( selection.isBackward ).to.be.true;
  57. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1 ] );
  58. } );
  59. it( 'should be able to create a selection from the given ranges and isLastBackward flag', () => {
  60. const ranges = new Set( [ range1, range2, range3 ] );
  61. const selection = new Selection( ranges, { backward: true } );
  62. expect( selection.isBackward ).to.be.true;
  63. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2, range3 ] );
  64. } );
  65. it( 'should be able to create a selection from the other selection', () => {
  66. const ranges = [ range1, range2, range3 ];
  67. const otherSelection = new Selection( ranges, { backward: true } );
  68. const selection = new Selection( otherSelection );
  69. expect( selection.isBackward ).to.be.true;
  70. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2, range3 ] );
  71. } );
  72. it( 'should be able to create a selection at the start position of an item', () => {
  73. const selection = new Selection( root, 0 );
  74. const focus = selection.focus;
  75. expect( selection ).to.have.property( 'isCollapsed', true );
  76. expect( focus ).to.have.property( 'parent', root );
  77. expect( focus ).to.have.property( 'offset', 0 );
  78. } );
  79. it( 'should be able to create a selection before the specified element', () => {
  80. const selection = new Selection( root.getChild( 1 ), 'before' );
  81. const focus = selection.focus;
  82. expect( selection ).to.have.property( 'isCollapsed', true );
  83. expect( focus ).to.have.property( 'parent', root );
  84. expect( focus ).to.have.property( 'offset', 1 );
  85. } );
  86. it( 'should throw an error if added ranges intersects', () => {
  87. expectToThrowCKEditorError( () => {
  88. // eslint-disable-next-line no-new
  89. new Selection( [
  90. liveRange,
  91. new Range(
  92. new Position( root, [ 0, 4 ] ),
  93. new Position( root, [ 1, 2 ] )
  94. )
  95. ] );
  96. }, /model-selection-range-intersects/, model );
  97. } );
  98. it( 'should throw an error when trying to set selection to not selectable', () => {
  99. expectToThrowCKEditorError( () => {
  100. // eslint-disable-next-line no-new
  101. new Selection( {} );
  102. }, /model-selection-setTo-not-selectable/ );
  103. } );
  104. } );
  105. describe( 'isCollapsed', () => {
  106. it( 'should return false for empty selection', () => {
  107. expect( selection.isCollapsed ).to.be.false;
  108. } );
  109. it( 'should return true when there is single collapsed ranges', () => {
  110. selection.setTo( new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) );
  111. expect( selection.isCollapsed ).to.be.true;
  112. } );
  113. it( 'should return false when there are multiple ranges', () => {
  114. selection.setTo( [
  115. new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ),
  116. new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) )
  117. ] );
  118. expect( selection.isCollapsed ).to.be.false;
  119. } );
  120. it( 'should return false when there is not collapsed range', () => {
  121. selection.setTo( range );
  122. expect( selection.isCollapsed ).to.be.false;
  123. } );
  124. } );
  125. describe( 'rangeCount', () => {
  126. it( 'should return proper range count', () => {
  127. expect( selection.rangeCount ).to.equal( 0 );
  128. selection.setTo( new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) );
  129. expect( selection.rangeCount ).to.equal( 1 );
  130. selection.setTo( [
  131. new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ),
  132. new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) )
  133. ] );
  134. expect( selection.rangeCount ).to.equal( 2 );
  135. } );
  136. } );
  137. describe( 'isBackward', () => {
  138. it( 'is defined by the last added range', () => {
  139. selection.setTo( [ range ], { backward: true } );
  140. expect( selection ).to.have.property( 'isBackward', true );
  141. selection.setTo( liveRange );
  142. expect( selection ).to.have.property( 'isBackward', false );
  143. } );
  144. it( 'is false when last range is collapsed', () => {
  145. const pos = Position._createAt( root, 0 );
  146. selection.setTo( pos );
  147. expect( selection.isBackward ).to.be.false;
  148. } );
  149. } );
  150. describe( 'focus', () => {
  151. let r1, r2, r3;
  152. beforeEach( () => {
  153. r1 = new Range( Position._createAt( root, 2 ), Position._createAt( root, 4 ) );
  154. r2 = new Range( Position._createAt( root, 4 ), Position._createAt( root, 6 ) );
  155. r3 = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  156. selection.setTo( [ r1, r2 ] );
  157. } );
  158. it( 'should return correct focus when last added range is not backward one', () => {
  159. selection.setTo( [ r1, r2, r3 ] );
  160. expect( selection.focus.isEqual( r3.end ) ).to.be.true;
  161. } );
  162. it( 'should return correct focus when last added range is backward one', () => {
  163. selection.setTo( [ r1, r2, r3 ], { backward: true } );
  164. expect( selection.focus.isEqual( r3.start ) ).to.be.true;
  165. } );
  166. it( 'should return null if no ranges in selection', () => {
  167. selection.setTo( null );
  168. expect( selection.focus ).to.be.null;
  169. } );
  170. } );
  171. describe( 'setTo()', () => {
  172. it( 'should set selection to be same as given selection, using _setRanges method', () => {
  173. const spy = sinon.spy( selection, '_setRanges' );
  174. const otherSelection = new Selection( [ range1, range2 ], { backward: true } );
  175. selection.setTo( otherSelection );
  176. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2 ] );
  177. expect( selection.isBackward ).to.be.true;
  178. expect( selection._setRanges.calledOnce ).to.be.true;
  179. spy.restore();
  180. } );
  181. it( 'should set selection on the given Range using _setRanges method', () => {
  182. const spy = sinon.spy( selection, '_setRanges' );
  183. selection.setTo( range1 );
  184. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1 ] );
  185. expect( selection.isBackward ).to.be.false;
  186. expect( selection._setRanges.calledOnce ).to.be.true;
  187. spy.restore();
  188. } );
  189. it( 'should set selection on the given iterable of Ranges using _setRanges method', () => {
  190. const spy = sinon.spy( selection, '_setRanges' );
  191. selection.setTo( new Set( [ range1, range2 ] ) );
  192. expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2 ] );
  193. expect( selection.isBackward ).to.be.false;
  194. expect( selection._setRanges.calledOnce ).to.be.true;
  195. spy.restore();
  196. } );
  197. it( 'should set collapsed selection on the given Position using _setRanges method', () => {
  198. const spy = sinon.spy( selection, '_setRanges' );
  199. const position = new Position( root, [ 4 ] );
  200. selection.setTo( position );
  201. expect( Array.from( selection.getRanges() ).length ).to.equal( 1 );
  202. expect( Array.from( selection.getRanges() )[ 0 ].start ).to.deep.equal( position );
  203. expect( selection.isBackward ).to.be.false;
  204. expect( selection.isCollapsed ).to.be.true;
  205. expect( selection._setRanges.calledOnce ).to.be.true;
  206. spy.restore();
  207. } );
  208. it( 'should throw an error if added ranges intersects', () => {
  209. expectToThrowCKEditorError( () => {
  210. selection.setTo( [
  211. liveRange,
  212. new Range(
  213. new Position( root, [ 0, 4 ] ),
  214. new Position( root, [ 1, 2 ] )
  215. )
  216. ] );
  217. }, /model-selection-range-intersects/, model );
  218. } );
  219. it( 'should throw an error when trying to set selection to not selectable', () => {
  220. expectToThrowCKEditorError( () => {
  221. selection.setTo( {} );
  222. }, /model-selection-setTo-not-selectable/ );
  223. } );
  224. it( 'should throw an error when trying to set selection to not selectable #2', () => {
  225. expectToThrowCKEditorError( () => {
  226. selection.setTo();
  227. }, /model-selection-setTo-not-selectable/ );
  228. } );
  229. it( 'should allow setting selection inside an element', () => {
  230. const element = new Element( 'p', null, [ new Text( 'foo' ), new Text( 'bar' ) ] );
  231. selection.setTo( element, 'in' );
  232. const ranges = Array.from( selection.getRanges() );
  233. expect( ranges.length ).to.equal( 1 );
  234. expect( ranges[ 0 ].start.parent ).to.equal( element );
  235. expect( ranges[ 0 ].start.offset ).to.deep.equal( 0 );
  236. expect( ranges[ 0 ].end.parent ).to.equal( element );
  237. expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 );
  238. } );
  239. it( 'should allow setting selection on an item', () => {
  240. const textNode1 = new Text( 'foo' );
  241. const textNode2 = new Text( 'bar' );
  242. const textNode3 = new Text( 'baz' );
  243. const element = new Element( 'p', null, [ textNode1, textNode2, textNode3 ] );
  244. selection.setTo( textNode2, 'on' );
  245. const ranges = Array.from( selection.getRanges() );
  246. expect( ranges.length ).to.equal( 1 );
  247. expect( ranges[ 0 ].start.parent ).to.equal( element );
  248. expect( ranges[ 0 ].start.offset ).to.deep.equal( 3 );
  249. expect( ranges[ 0 ].end.parent ).to.equal( element );
  250. expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 );
  251. } );
  252. it( 'should allow setting backward selection on an item', () => {
  253. const textNode1 = new Text( 'foo' );
  254. const textNode2 = new Text( 'bar' );
  255. const textNode3 = new Text( 'baz' );
  256. const element = new Element( 'p', null, [ textNode1, textNode2, textNode3 ] );
  257. selection.setTo( textNode2, 'on', { backward: true } );
  258. const ranges = Array.from( selection.getRanges() );
  259. expect( ranges.length ).to.equal( 1 );
  260. expect( ranges[ 0 ].start.parent ).to.equal( element );
  261. expect( ranges[ 0 ].start.offset ).to.deep.equal( 3 );
  262. expect( ranges[ 0 ].end.parent ).to.equal( element );
  263. expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 );
  264. expect( selection.isBackward ).to.be.true;
  265. } );
  266. // TODO - backward
  267. // TODO - throwing
  268. describe( 'setting selection to position or item', () => {
  269. it( 'should fire change:range', () => {
  270. const spy = sinon.spy();
  271. selection.on( 'change:range', spy );
  272. selection.setTo( root, 0 );
  273. expect( spy.calledOnce ).to.be.true;
  274. } );
  275. it( 'should throw if second parameter is not passed', () => {
  276. expectToThrowCKEditorError( () => {
  277. selection.setTo( root );
  278. }, /model-selection-setTo-required-second-parameter/, model );
  279. } );
  280. it( 'should set selection at given offset in given parent', () => {
  281. selection.setTo( root, 3 );
  282. expect( selection ).to.have.property( 'isCollapsed', true );
  283. const focus = selection.focus;
  284. expect( focus ).to.have.property( 'parent', root );
  285. expect( focus ).to.have.property( 'offset', 3 );
  286. } );
  287. it( 'should set selection at the end of the given parent', () => {
  288. selection.setTo( root, 'end' );
  289. expect( selection ).to.have.property( 'isCollapsed', true );
  290. const focus = selection.focus;
  291. expect( focus ).to.have.property( 'parent', root );
  292. expect( focus ).to.have.property( 'offset', root.maxOffset );
  293. } );
  294. it( 'should set selection before the specified element', () => {
  295. selection.setTo( root.getChild( 1 ), 'before' );
  296. expect( selection ).to.have.property( 'isCollapsed', true );
  297. const focus = selection.focus;
  298. expect( focus ).to.have.property( 'parent', root );
  299. expect( focus ).to.have.property( 'offset', 1 );
  300. } );
  301. it( 'should set selection after the specified element', () => {
  302. selection.setTo( root.getChild( 1 ), 'after' );
  303. expect( selection ).to.have.property( 'isCollapsed', true );
  304. const focus = selection.focus;
  305. expect( focus ).to.have.property( 'parent', root );
  306. expect( focus ).to.have.property( 'offset', 2 );
  307. } );
  308. it( 'should set selection at the specified position', () => {
  309. const pos = Position._createAt( root, 3 );
  310. selection.setTo( pos );
  311. expect( selection ).to.have.property( 'isCollapsed', true );
  312. const focus = selection.focus;
  313. expect( focus ).to.have.property( 'parent', root );
  314. expect( focus ).to.have.property( 'offset', 3 );
  315. } );
  316. } );
  317. } );
  318. describe( 'setFocus()', () => {
  319. it( 'keeps all existing ranges and fires no change:range when no modifications needed', () => {
  320. selection.setTo( [ range, liveRange ] );
  321. const spy = sinon.spy();
  322. selection.on( 'change:range', spy );
  323. selection.setFocus( selection.focus );
  324. expect( count( selection.getRanges() ) ).to.equal( 2 );
  325. expect( spy.callCount ).to.equal( 0 );
  326. } );
  327. it( 'fires change:range', () => {
  328. selection.setTo( range );
  329. const spy = sinon.spy();
  330. selection.on( 'change:range', spy );
  331. selection.setFocus( Position._createAt( root, 'end' ) );
  332. expect( spy.calledOnce ).to.be.true;
  333. } );
  334. it( 'throws if there are no ranges in selection', () => {
  335. const endPos = Position._createAt( root, 'end' );
  336. expectToThrowCKEditorError( () => {
  337. selection.setFocus( endPos );
  338. }, /model-selection-setFocus-no-ranges/, model );
  339. } );
  340. it( 'modifies existing collapsed selection', () => {
  341. const startPos = Position._createAt( root, 1 );
  342. const endPos = Position._createAt( root, 2 );
  343. selection.setTo( startPos );
  344. selection.setFocus( endPos );
  345. expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
  346. expect( selection.focus.compareWith( endPos ) ).to.equal( 'same' );
  347. } );
  348. it( 'makes existing collapsed selection a backward selection', () => {
  349. const startPos = Position._createAt( root, 1 );
  350. const endPos = Position._createAt( root, 0 );
  351. selection.setTo( startPos );
  352. selection.setFocus( endPos );
  353. expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
  354. expect( selection.focus.compareWith( endPos ) ).to.equal( 'same' );
  355. expect( selection.isBackward ).to.be.true;
  356. } );
  357. it( 'modifies existing non-collapsed selection', () => {
  358. const startPos = Position._createAt( root, 1 );
  359. const endPos = Position._createAt( root, 2 );
  360. const newEndPos = Position._createAt( root, 3 );
  361. selection.setTo( new Range( startPos, endPos ) );
  362. selection.setFocus( newEndPos );
  363. expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
  364. expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
  365. } );
  366. it( 'makes existing non-collapsed selection a backward selection', () => {
  367. const startPos = Position._createAt( root, 1 );
  368. const endPos = Position._createAt( root, 2 );
  369. const newEndPos = Position._createAt( root, 0 );
  370. selection.setTo( new Range( startPos, endPos ) );
  371. selection.setFocus( newEndPos );
  372. expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
  373. expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
  374. expect( selection.isBackward ).to.be.true;
  375. } );
  376. it( 'makes existing backward selection a forward selection', () => {
  377. const startPos = Position._createAt( root, 1 );
  378. const endPos = Position._createAt( root, 2 );
  379. const newEndPos = Position._createAt( root, 3 );
  380. selection.setTo( new Range( startPos, endPos ), { backward: true } );
  381. selection.setFocus( newEndPos );
  382. expect( selection.anchor.compareWith( endPos ) ).to.equal( 'same' );
  383. expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
  384. expect( selection.isBackward ).to.be.false;
  385. } );
  386. it( 'modifies existing backward selection', () => {
  387. const startPos = Position._createAt( root, 1 );
  388. const endPos = Position._createAt( root, 2 );
  389. const newEndPos = Position._createAt( root, 0 );
  390. selection.setTo( new Range( startPos, endPos ), { backward: true } );
  391. selection.setFocus( newEndPos );
  392. expect( selection.anchor.compareWith( endPos ) ).to.equal( 'same' );
  393. expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
  394. expect( selection.isBackward ).to.be.true;
  395. } );
  396. it( 'modifies only the last range', () => {
  397. // Offsets are chosen in this way that the order of adding ranges must count, not their document order.
  398. const startPos1 = Position._createAt( root, 4 );
  399. const endPos1 = Position._createAt( root, 5 );
  400. const startPos2 = Position._createAt( root, 1 );
  401. const endPos2 = Position._createAt( root, 2 );
  402. const newEndPos = Position._createAt( root, 0 );
  403. selection.setTo( [
  404. new Range( startPos1, endPos1 ),
  405. new Range( startPos2, endPos2 )
  406. ] );
  407. const spy = sinon.spy();
  408. selection.on( 'change:range', spy );
  409. selection.setFocus( newEndPos );
  410. const ranges = Array.from( selection.getRanges() );
  411. expect( ranges ).to.have.lengthOf( 2 );
  412. expect( ranges[ 0 ].start.compareWith( startPos1 ) ).to.equal( 'same' );
  413. expect( ranges[ 0 ].end.compareWith( endPos1 ) ).to.equal( 'same' );
  414. expect( selection.anchor.compareWith( startPos2 ) ).to.equal( 'same' );
  415. expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
  416. expect( selection.isBackward ).to.be.true;
  417. expect( spy.calledOnce ).to.be.true;
  418. } );
  419. it( 'collapses the selection when extending to the anchor', () => {
  420. const startPos = Position._createAt( root, 1 );
  421. const endPos = Position._createAt( root, 2 );
  422. selection.setTo( new Range( startPos, endPos ) );
  423. selection.setFocus( startPos );
  424. expect( selection.focus.compareWith( startPos ) ).to.equal( 'same' );
  425. expect( selection.isCollapsed ).to.be.true;
  426. } );
  427. } );
  428. describe( 'setTo - selection set to null', () => {
  429. let spy;
  430. it( 'should remove all stored ranges', () => {
  431. selection.setTo( [ liveRange, range ] );
  432. selection.setTo( null );
  433. expect( Array.from( selection.getRanges() ).length ).to.equal( 0 );
  434. } );
  435. it( 'should fire exactly one change:range event', () => {
  436. selection.setTo( [ liveRange, range ] );
  437. spy = sinon.spy();
  438. selection.on( 'change:range', spy );
  439. selection.setTo( null );
  440. expect( spy.calledOnce ).to.be.true;
  441. } );
  442. it( 'should not fire change:range event if there were no ranges', () => {
  443. spy = sinon.spy();
  444. selection.on( 'change:range', spy );
  445. selection.setTo( null );
  446. expect( spy.called ).to.be.false;
  447. } );
  448. } );
  449. describe( '_setRanges()', () => {
  450. let newRanges, spy;
  451. beforeEach( () => {
  452. newRanges = [
  453. new Range( new Position( root, [ 4 ] ), new Position( root, [ 5 ] ) ),
  454. new Range( new Position( root, [ 5, 0 ] ), new Position( root, [ 6, 0 ] ) )
  455. ];
  456. selection.setTo( [ liveRange, range ] );
  457. spy = sinon.spy();
  458. selection.on( 'change:range', spy );
  459. } );
  460. it( 'should throw an error when range is invalid', () => {
  461. expectToThrowCKEditorError( () => {
  462. selection._setRanges( [ { invalid: 'range' } ] );
  463. }, /model-selection-set-ranges-not-range/, model );
  464. } );
  465. it( 'should remove all ranges and add given ranges', () => {
  466. selection._setRanges( newRanges );
  467. const ranges = Array.from( selection.getRanges() );
  468. expect( ranges ).to.deep.equal( newRanges );
  469. } );
  470. it( 'should use last range from given array to get anchor and focus position', () => {
  471. selection._setRanges( newRanges );
  472. expect( selection.anchor.path ).to.deep.equal( [ 5, 0 ] );
  473. expect( selection.focus.path ).to.deep.equal( [ 6, 0 ] );
  474. } );
  475. it( 'should acknowledge backward flag when setting anchor and focus', () => {
  476. selection._setRanges( newRanges, { backward: true } );
  477. expect( selection.anchor.path ).to.deep.equal( [ 6, 0 ] );
  478. expect( selection.focus.path ).to.deep.equal( [ 5, 0 ] );
  479. } );
  480. it( 'should fire exactly one change:range event', () => {
  481. selection._setRanges( newRanges );
  482. expect( spy.calledOnce ).to.be.true;
  483. } );
  484. it( 'should fire change:range event with correct parameters', () => {
  485. selection.on( 'change:range', ( evt, data ) => {
  486. expect( data.directChange ).to.be.true;
  487. } );
  488. selection._setRanges( newRanges );
  489. } );
  490. it( 'should not fire change:range event if given ranges are the same', () => {
  491. selection._setRanges( [ liveRange, range ] );
  492. expect( spy.calledOnce ).to.be.false;
  493. } );
  494. it( 'should copy added ranges and store multiple ranges', () => {
  495. selection._setRanges( [ liveRange, range ] );
  496. const ranges = selection._ranges;
  497. expect( ranges.length ).to.equal( 2 );
  498. expect( ranges[ 0 ].isEqual( liveRange ) ).to.be.true;
  499. expect( ranges[ 1 ].isEqual( range ) ).to.be.true;
  500. expect( ranges[ 0 ] ).not.to.be.equal( liveRange );
  501. expect( ranges[ 1 ] ).not.to.be.equal( range );
  502. } );
  503. it( 'should set anchor and focus to the start and end of the last added range', () => {
  504. selection._setRanges( [ liveRange, range ] );
  505. expect( selection.anchor.path ).to.deep.equal( [ 2 ] );
  506. expect( selection.focus.path ).to.deep.equal( [ 2, 2 ] );
  507. } );
  508. it( 'should set anchor and focus to the end and start of the most recently added range if backward flag was used', () => {
  509. selection._setRanges( [ liveRange, range ], { backward: true } );
  510. expect( selection.anchor.path ).to.deep.equal( [ 2 ] );
  511. expect( selection.focus.path ).to.deep.equal( [ 2, 2 ] );
  512. } );
  513. } );
  514. describe( 'getFirstRange()', () => {
  515. it( 'should return null if no ranges were added', () => {
  516. expect( selection.getFirstRange() ).to.be.null;
  517. } );
  518. it( 'should return a range which start position is before all other ranges\' start positions', () => {
  519. selection.setTo( [
  520. // This will not be the first range despite being added as first
  521. range2,
  522. // This should be the first range.
  523. range1,
  524. // A random range that is not first.
  525. range3
  526. ] );
  527. const range = selection.getFirstRange();
  528. expect( range.start.path ).to.deep.equal( [ 1 ] );
  529. expect( range.end.path ).to.deep.equal( [ 4 ] );
  530. } );
  531. } );
  532. describe( 'getFirstPosition()', () => {
  533. it( 'should return null if no ranges were added', () => {
  534. expect( selection.getFirstPosition() ).to.be.null;
  535. } );
  536. it( 'should return a position that is in selection and is before any other position from the selection', () => {
  537. selection.setTo( [
  538. // This will not be the first range despite being added as first
  539. range2,
  540. // This should be the first range.
  541. range1,
  542. // A random range that is not first.
  543. range3
  544. ] );
  545. const position = selection.getFirstPosition();
  546. expect( position.path ).to.deep.equal( [ 1 ] );
  547. } );
  548. } );
  549. describe( 'getLastRange()', () => {
  550. it( 'should return null if no ranges were added', () => {
  551. expect( selection.getLastRange() ).to.be.null;
  552. } );
  553. it( 'should return a range which start position is before all other ranges\' start positions', () => {
  554. selection.setTo( [ range3, range1, range2 ] );
  555. const range = selection.getLastRange();
  556. expect( range.start.path ).to.deep.equal( [ 6 ] );
  557. expect( range.end.path ).to.deep.equal( [ 7 ] );
  558. } );
  559. } );
  560. describe( 'getLastPosition()', () => {
  561. it( 'should return null if no ranges were added', () => {
  562. expect( selection.getLastPosition() ).to.be.null;
  563. } );
  564. it( 'should return a position that is in selection and is before any other position from the selection', () => {
  565. selection.setTo( [ range3, range1, range2 ] );
  566. const position = selection.getLastPosition();
  567. expect( position.path ).to.deep.equal( [ 7 ] );
  568. } );
  569. } );
  570. describe( 'isEqual()', () => {
  571. it( 'should return true if selections equal', () => {
  572. selection.setTo( [ range1, range2 ] );
  573. const otherSelection = new Selection( [ range1, range2 ] );
  574. expect( selection.isEqual( otherSelection ) ).to.be.true;
  575. } );
  576. it( 'should return true if backward selections equal', () => {
  577. selection.setTo( [ range1 ], { backward: true } );
  578. const otherSelection = new Selection( [ range1 ], { backward: true } );
  579. expect( selection.isEqual( otherSelection ) ).to.be.true;
  580. } );
  581. it( 'should return true if both selections have no ranges', () => {
  582. const otherSelection = new Selection();
  583. expect( selection.isEqual( otherSelection ) ).to.be.true;
  584. } );
  585. it( 'should return false if ranges count does not equal', () => {
  586. selection.setTo( [ range1, range2 ] );
  587. const otherSelection = new Selection( [ range2 ] );
  588. expect( selection.isEqual( otherSelection ) ).to.be.false;
  589. } );
  590. it( 'should return false if ranges (other than the last added range) do not equal', () => {
  591. selection.setTo( [ range1, range3 ] );
  592. const otherSelection = new Selection( [ range2, range3 ] );
  593. expect( selection.isEqual( otherSelection ) ).to.be.false;
  594. } );
  595. it( 'should return false if directions do not equal', () => {
  596. selection.setTo( range1 );
  597. const otherSelection = new Selection( [ range1 ], { backward: true } );
  598. expect( selection.isEqual( otherSelection ) ).to.be.false;
  599. } );
  600. } );
  601. describe( 'is', () => {
  602. it( 'should return true for selection', () => {
  603. expect( selection.is( 'selection' ) ).to.be.true;
  604. } );
  605. it( 'should return false for other values', () => {
  606. expect( selection.is( 'documentSelection' ) ).to.be.false;
  607. expect( selection.is( 'node' ) ).to.be.false;
  608. expect( selection.is( 'text' ) ).to.be.false;
  609. expect( selection.is( 'textProxy' ) ).to.be.false;
  610. expect( selection.is( 'element' ) ).to.be.false;
  611. expect( selection.is( 'rootElement' ) ).to.be.false;
  612. } );
  613. } );
  614. describe( 'setTo - used to collapse at start', () => {
  615. it( 'should collapse to start position and fire change event', () => {
  616. selection.setTo( [ range2, range1, range3 ] );
  617. const spy = sinon.spy();
  618. selection.on( 'change:range', spy );
  619. selection.setTo( selection.getFirstPosition() );
  620. expect( selection.rangeCount ).to.equal( 1 );
  621. expect( selection.isCollapsed ).to.be.true;
  622. expect( selection.getFirstPosition().isEqual( range1.start ) ).to.be.true;
  623. expect( spy.calledOnce ).to.be.true;
  624. } );
  625. it( 'should do nothing if selection was already collapsed', () => {
  626. selection.setTo( range1.start );
  627. const spy = sinon.spy( selection, 'fire' );
  628. selection.setTo( selection.getFirstPosition() );
  629. expect( spy.notCalled ).to.be.true;
  630. spy.restore();
  631. } );
  632. it( 'should do nothing if no ranges present', () => {
  633. const spy = sinon.spy( selection, 'fire' );
  634. selection.setTo( selection.getFirstPosition() );
  635. spy.restore();
  636. expect( spy.notCalled ).to.be.true;
  637. } );
  638. } );
  639. describe( 'setTo - used to collapse at end', () => {
  640. it( 'should collapse to start position and fire change:range event', () => {
  641. selection.setTo( [ range2, range3, range1 ] );
  642. const spy = sinon.spy();
  643. selection.on( 'change:range', spy );
  644. selection.setTo( selection.getLastPosition() );
  645. expect( selection.rangeCount ).to.equal( 1 );
  646. expect( selection.isCollapsed ).to.be.true;
  647. expect( selection.getLastPosition().isEqual( range3.end ) ).to.be.true;
  648. expect( spy.calledOnce ).to.be.true;
  649. } );
  650. it( 'should do nothing if selection was already collapsed', () => {
  651. selection.setTo( range1.start );
  652. const spy = sinon.spy( selection, 'fire' );
  653. selection.setTo( selection.getLastPosition() );
  654. expect( spy.notCalled ).to.be.true;
  655. spy.restore();
  656. } );
  657. it( 'should do nothing if selection has no ranges', () => {
  658. const spy = sinon.spy( selection, 'fire' );
  659. selection.setTo( selection.getLastPosition() );
  660. expect( spy.notCalled ).to.be.true;
  661. spy.restore();
  662. } );
  663. } );
  664. describe( 'getSelectedElement()', () => {
  665. let schema;
  666. beforeEach( () => {
  667. schema = new Schema();
  668. schema.register( '$root' );
  669. schema.register( 'p', { allowIn: '$root' } );
  670. schema.register( '$text', { allowIn: 'p' } );
  671. } );
  672. it( 'should return selected element', () => {
  673. const { selection, model } = parse( '<p>foo</p>[<p>bar</p>]<p>baz</p>', schema );
  674. const p = model.getChild( 1 );
  675. expect( selection.getSelectedElement() ).to.equal( p );
  676. } );
  677. it( 'should return null if there is more than one range', () => {
  678. const { selection } = parse( '[<p>foo</p>][<p>bar</p>]<p>baz</p>', schema );
  679. expect( selection.getSelectedElement() ).to.be.null;
  680. } );
  681. it( 'should return null if there is no selection', () => {
  682. expect( selection.getSelectedElement() ).to.be.null;
  683. } );
  684. it( 'should return null if selection is not over single element #1', () => {
  685. const { selection } = parse( '<p>foo</p>[<p>bar</p><p>baz}</p>', schema );
  686. expect( selection.getSelectedElement() ).to.be.null;
  687. } );
  688. it( 'should return null if selection is not over single element #2', () => {
  689. const { selection } = parse( '<p>{bar}</p>', schema );
  690. expect( selection.getSelectedElement() ).to.be.null;
  691. } );
  692. } );
  693. describe( 'getSelectedBlocks()', () => {
  694. beforeEach( () => {
  695. model.schema.register( 'p', { inheritAllFrom: '$block' } );
  696. model.schema.register( 'h', { inheritAllFrom: '$block' } );
  697. model.schema.register( 'blockquote' );
  698. model.schema.extend( 'blockquote', { allowIn: '$root' } );
  699. model.schema.extend( '$block', { allowIn: 'blockquote' } );
  700. model.schema.register( 'image', {
  701. allowIn: [ '$root', '$block' ]
  702. } );
  703. model.schema.extend( '$text', { allowIn: 'image' } );
  704. // Special block which can contain another blocks.
  705. model.schema.register( 'nestedBlock', { inheritAllFrom: '$block' } );
  706. model.schema.extend( 'nestedBlock', { allowIn: '$block' } );
  707. } );
  708. it( 'returns an iterator', () => {
  709. setData( model, '<p>a</p><p>[]b</p><p>c</p>' );
  710. expect( doc.selection.getSelectedBlocks().next ).to.be.a( 'function' );
  711. } );
  712. it( 'returns block for a collapsed selection', () => {
  713. setData( model, '<p>a</p><p>[]b</p><p>c</p>' );
  714. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] );
  715. } );
  716. it( 'returns block for a collapsed selection (empty block)', () => {
  717. setData( model, '<p>a</p><p>[]</p><p>c</p>' );
  718. const blocks = Array.from( doc.selection.getSelectedBlocks() );
  719. expect( blocks ).to.have.length( 1 );
  720. expect( blocks[ 0 ].childCount ).to.equal( 0 );
  721. } );
  722. it( 'returns block for a non collapsed selection', () => {
  723. setData( model, '<p>a</p><p>[b]</p><p>c</p>' );
  724. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] );
  725. } );
  726. it( 'returns two blocks for a non collapsed selection', () => {
  727. setData( model, '<p>a</p><h>[b</h><p>c]</p><p>d</p>' );
  728. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'c' ] );
  729. } );
  730. it( 'returns two blocks for a non collapsed selection (starts at block end)', () => {
  731. setData( model, '<p>a</p><h>b[</h><p>c]</p><p>d</p>' );
  732. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'c' ] );
  733. } );
  734. it( 'returns proper block for a multi-range selection', () => {
  735. setData( model, '<p>a</p><h>[b</h><p>c]</p><p>d</p><p>[e]</p>' );
  736. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'c', 'e' ] );
  737. } );
  738. it( 'does not return a block twice if two ranges are anchored in it', () => {
  739. setData( model, '<p>[a]b[c]</p>' );
  740. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'abc' ] );
  741. } );
  742. it( 'returns only blocks', () => {
  743. setData( model, '<p>[a</p><image>b</image><p>c]</p>' );
  744. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'c' ] );
  745. } );
  746. it( 'gets deeper into the tree', () => {
  747. setData( model, '<p>[a</p><blockquote><p>b</p><p>c</p></blockquote><p>d]</p>' );
  748. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b', 'c', 'd' ] );
  749. } );
  750. it( 'gets deeper into the tree (end deeper)', () => {
  751. setData( model, '<p>[a</p><blockquote><p>b]</p><p>c</p></blockquote><p>d</p>' );
  752. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b' ] );
  753. } );
  754. it( 'gets deeper into the tree (start deeper)', () => {
  755. setData( model, '<p>a</p><blockquote><p>b</p><p>[c</p></blockquote><p>d]</p>' );
  756. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'c', 'd' ] );
  757. } );
  758. it( 'returns an empty array if none of the selected elements is a block', () => {
  759. setData( model, '<p>a</p><image>[a</image><image>b]</image><p>b</p>' );
  760. expect( toText( doc.selection.getSelectedBlocks() ) ).to.be.empty;
  761. } );
  762. it( 'returns an empty array if the selected element is not a block', () => {
  763. setData( model, '<p>a</p><image>[]a</image><p>b</p>' );
  764. expect( toText( doc.selection.getSelectedBlocks() ) ).to.be.empty;
  765. } );
  766. // Super edge case – should not happen (blocks should never be nested),
  767. // but since the code handles it already it's worth testing.
  768. it( 'returns only the lowest block if blocks are nested', () => {
  769. setData( model, '<nestedBlock>a<nestedBlock>[]b</nestedBlock></nestedBlock>' );
  770. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] );
  771. } );
  772. // Like above but trickier.
  773. it( 'returns only the lowest block if blocks are nested', () => {
  774. setData(
  775. model,
  776. '<nestedBlock>a<nestedBlock>[b</nestedBlock></nestedBlock>' +
  777. '<nestedBlock>c<nestedBlock>d]</nestedBlock></nestedBlock>'
  778. );
  779. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'd' ] );
  780. } );
  781. it( 'returns nothing if directly in a root', () => {
  782. doc.createRoot( 'p', 'inlineOnlyRoot' );
  783. setData( model, 'a[b]c', { rootName: 'inlineOnlyRoot' } );
  784. expect( toText( doc.selection.getSelectedBlocks() ) ).to.be.empty;
  785. } );
  786. describe( '#984', () => {
  787. it( 'does not return the last block if none of its content is selected', () => {
  788. setData( model, '<p>[a</p><p>b</p><p>]c</p>' );
  789. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b' ] );
  790. } );
  791. it( 'returns only the first block for a non collapsed selection if only end of selection is touching a block', () => {
  792. setData( model, '<p>a</p><h>b[</h><p>]c</p><p>d</p>' );
  793. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] );
  794. } );
  795. it( 'does not return the last block if none of its content is selected (nested case)', () => {
  796. setData( model, '<p>[a</p><nestedBlock><nestedBlock>]b</nestedBlock></nestedBlock>' );
  797. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a' ] );
  798. } );
  799. // Like a super edge case, we can live with this behavior as I don't even know what we could expect here
  800. // since only the innermost block is considerd a block to return (so the <nB>b...</nB> needs to be ignored).
  801. it( 'does not return the last block if none of its content is selected (nested case, wrapper with a content)', () => {
  802. setData( model, '<p>[a</p><nestedBlock>b<nestedBlock>]c</nestedBlock></nestedBlock>' );
  803. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a' ] );
  804. } );
  805. it( 'returns the last block if at least one of its child nodes is selected', () => {
  806. setData( model, '<p>[a</p><p>b</p><p><image></image>]c</p>' );
  807. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
  808. } );
  809. // I needed these last 2 cases to justify the use of isTouching() instead of simple `offset == 0` check.
  810. it( 'returns the last block if at least one of its child nodes is selected (end in an inline element)', () => {
  811. setData( model, '<p>[a</p><p>b</p><p><image>x]</image>c</p>' );
  812. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
  813. } );
  814. it(
  815. 'does not return the last block if at least one of its child nodes is selected ' +
  816. '(end in an inline element, no content selected)',
  817. () => {
  818. setData( model, '<p>[a</p><p>b</p><p><image>]x</image>c</p>' );
  819. expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b' ] );
  820. }
  821. );
  822. } );
  823. it( 'does not go beyond limit elements', () => {
  824. model.schema.register( 'table', { isBlock: true, isLimit: true, isObject: true, allowIn: '$root' } );
  825. model.schema.register( 'tableRow', { allowIn: 'table', isLimit: true } );
  826. model.schema.register( 'tableCell', { allowIn: 'tableRow', isObject: true } );
  827. model.schema.register( 'blk', { allowIn: [ '$root', 'tableCell' ], isObject: true, isBlock: true } );
  828. model.schema.extend( 'p', { allowIn: 'tableCell' } );
  829. setData( model, '<table><tableRow><tableCell><p>foo</p>[<blk></blk><p>bar]</p></tableCell></tableRow></table>' );
  830. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'blk', 'p#bar' ] );
  831. } );
  832. // Map all elements to data of its first child text node.
  833. function toText( elements ) {
  834. return Array.from( elements ).map( el => {
  835. return Array.from( el.getChildren() ).find( child => child.data ).data;
  836. } );
  837. }
  838. } );
  839. describe( 'getTopMostBlocks()', () => {
  840. beforeEach( () => {
  841. model.schema.register( 'p', { inheritAllFrom: '$block' } );
  842. model.schema.register( 'table', { isBlock: true, isLimit: true, isObject: true, allowIn: '$root' } );
  843. model.schema.register( 'tableRow', { allowIn: 'table', isLimit: true } );
  844. model.schema.register( 'tableCell', { allowIn: 'tableRow', isObject: true } );
  845. model.schema.extend( 'p', { allowIn: 'tableCell' } );
  846. } );
  847. it( 'returns an iterator', () => {
  848. setData( model, '<p>a</p><p>[]b</p><p>c</p>' );
  849. expect( doc.selection.getTopMostBlocks().next ).to.be.a( 'function' );
  850. } );
  851. it( 'returns block for a collapsed selection', () => {
  852. setData( model, '<p>a</p><p>[]b</p><p>c</p>' );
  853. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'p#b' ] );
  854. } );
  855. it( 'returns block for a collapsed selection (empty block)', () => {
  856. setData( model, '<p>a</p><p>[]</p><p>c</p>' );
  857. const blocks = Array.from( doc.selection.getTopMostBlocks() );
  858. expect( blocks ).to.have.length( 1 );
  859. expect( blocks[ 0 ].childCount ).to.equal( 0 );
  860. } );
  861. it( 'returns block for a non collapsed selection', () => {
  862. setData( model, '<p>a</p><p>[b]</p><p>c</p>' );
  863. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'p#b' ] );
  864. } );
  865. it( 'returns two blocks for a non collapsed selection', () => {
  866. setData( model, '<p>a</p><p>[b</p><p>c]</p><p>d</p>' );
  867. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'p#b', 'p#c' ] );
  868. } );
  869. it( 'returns only top most blocks', () => {
  870. setData( model, '[<p>foo</p><table><tableRow><tableCell><p>bar</p></tableCell></tableRow></table><p>baz</p>]' );
  871. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'p#foo', 'table', 'p#baz' ] );
  872. } );
  873. it( 'returns only selected blocks even if nested in other blocks', () => {
  874. setData( model, '<p>foo</p><table><tableRow><tableCell><p>[b]ar</p></tableCell></tableRow></table><p>baz</p>' );
  875. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'p#bar' ] );
  876. } );
  877. it( 'returns only selected blocks even if nested in other blocks (selection on the block)', () => {
  878. model.schema.register( 'blk', { allowIn: [ '$root', 'tableCell' ], isObject: true, isBlock: true } );
  879. setData( model, '<table><tableRow><tableCell><p>foo</p>[<blk></blk><p>bar]</p></tableCell></tableRow></table>' );
  880. expect( stringifyBlocks( doc.selection.getTopMostBlocks() ) ).to.deep.equal( [ 'blk', 'p#bar' ] );
  881. } );
  882. } );
  883. describe( 'attributes interface', () => {
  884. let rangeInFullP;
  885. beforeEach( () => {
  886. root._insertChild( 0, [
  887. new Element( 'p', [], new Text( 'foobar' ) ),
  888. new Element( 'p', [], [] )
  889. ] );
  890. rangeInFullP = new Range( new Position( root, [ 0, 4 ] ), new Position( root, [ 0, 4 ] ) );
  891. } );
  892. describe( 'setAttribute()', () => {
  893. it( 'should set given attribute on the selection', () => {
  894. selection.setTo( [ rangeInFullP ] );
  895. selection.setAttribute( 'foo', 'bar' );
  896. expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
  897. } );
  898. it( 'should fire change:attribute event with correct parameters', () => {
  899. selection.on( 'change:attribute', ( evt, data ) => {
  900. expect( data.directChange ).to.be.true;
  901. expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] );
  902. } );
  903. selection.setAttribute( 'foo', 'bar' );
  904. } );
  905. it( 'should not fire change:attribute event if attribute with same key and value was already set', () => {
  906. selection.setAttribute( 'foo', 'bar' );
  907. const spy = sinon.spy();
  908. selection.on( 'change:attribute', spy );
  909. selection.setAttribute( 'foo', 'bar' );
  910. expect( spy.called ).to.be.false;
  911. } );
  912. } );
  913. describe( 'getAttribute()', () => {
  914. it( 'should return undefined if element does not contain given attribute', () => {
  915. expect( selection.getAttribute( 'abc' ) ).to.be.undefined;
  916. } );
  917. } );
  918. describe( 'getAttributes()', () => {
  919. it( 'should return an iterator that iterates over all attributes set on selection', () => {
  920. selection.setTo( [ rangeInFullP ] );
  921. selection.setAttribute( 'foo', 'bar' );
  922. selection.setAttribute( 'abc', 'xyz' );
  923. const attrs = Array.from( selection.getAttributes() );
  924. expect( attrs ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'abc', 'xyz' ] ] );
  925. } );
  926. } );
  927. describe( 'getAttributeKeys()', () => {
  928. it( 'should return iterator that iterates over all attribute keys set on selection', () => {
  929. selection.setTo( [ rangeInFullP ] );
  930. selection.setAttribute( 'foo', 'bar' );
  931. selection.setAttribute( 'abc', 'xyz' );
  932. const attrs = Array.from( selection.getAttributeKeys() );
  933. expect( attrs ).to.deep.equal( [ 'foo', 'abc' ] );
  934. } );
  935. } );
  936. describe( 'hasAttribute()', () => {
  937. it( 'should return true if element contains attribute with given key', () => {
  938. selection.setTo( [ rangeInFullP ] );
  939. selection.setAttribute( 'foo', 'bar' );
  940. expect( selection.hasAttribute( 'foo' ) ).to.be.true;
  941. } );
  942. it( 'should return false if element does not contain attribute with given key', () => {
  943. expect( selection.hasAttribute( 'abc' ) ).to.be.false;
  944. } );
  945. } );
  946. describe( 'removeAttribute()', () => {
  947. it( 'should remove attribute', () => {
  948. selection.setTo( [ rangeInFullP ] );
  949. selection.setAttribute( 'foo', 'bar' );
  950. selection.removeAttribute( 'foo' );
  951. expect( selection.getAttribute( 'foo' ) ).to.be.undefined;
  952. } );
  953. it( 'should fire change:attribute event with correct parameters', () => {
  954. selection.setAttribute( 'foo', 'bar' );
  955. selection.on( 'change:attribute', ( evt, data ) => {
  956. expect( data.directChange ).to.be.true;
  957. expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] );
  958. } );
  959. selection.removeAttribute( 'foo' );
  960. } );
  961. it( 'should not fire change:attribute event if such attribute did not exist', () => {
  962. const spy = sinon.spy();
  963. selection.on( 'change:attribute', spy );
  964. selection.removeAttribute( 'foo' );
  965. expect( spy.called ).to.be.false;
  966. } );
  967. } );
  968. } );
  969. describe( 'containsEntireContent()', () => {
  970. beforeEach( () => {
  971. model.schema.register( 'p', { inheritAllFrom: '$block' } );
  972. model.schema.extend( 'p', { allowIn: '$root' } );
  973. } );
  974. it( 'returns true if the entire content in $root is selected', () => {
  975. setData( model, '<p>[Foo</p><p>Bom</p><p>Bar]</p>' );
  976. expect( doc.selection.containsEntireContent() ).to.equal( true );
  977. } );
  978. it( 'returns false when only a fragment of the content in $root is selected', () => {
  979. setData( model, '<p>Fo[o</p><p>Bom</p><p>Bar]</p>' );
  980. expect( doc.selection.containsEntireContent() ).to.equal( false );
  981. } );
  982. it( 'returns true if the entire content in specified element is selected', () => {
  983. setData( model, '<p>Foo</p><p>[Bom]</p><p>Bar</p>' );
  984. const root = doc.getRoot();
  985. const secondParagraph = root.getNodeByPath( [ 1 ] );
  986. expect( doc.selection.containsEntireContent( secondParagraph ) ).to.equal( true );
  987. } );
  988. it( 'returns false if the entire content in specified element is not selected', () => {
  989. setData( model, '<p>Foo</p><p>[Bom</p><p>B]ar</p>' );
  990. const root = doc.getRoot();
  991. const secondParagraph = root.getNodeByPath( [ 1 ] );
  992. expect( doc.selection.containsEntireContent( secondParagraph ) ).to.equal( false );
  993. } );
  994. it( 'returns false when the entire content except an empty element is selected', () => {
  995. model.schema.register( 'img', {
  996. allowIn: 'p'
  997. } );
  998. setData( model, '<p><img></img>[Foo]</p>' );
  999. expect( doc.selection.containsEntireContent() ).to.equal( false );
  1000. } );
  1001. it( 'returns true if the content is empty', () => {
  1002. setData( model, '[]' );
  1003. expect( doc.selection.containsEntireContent() ).to.equal( true );
  1004. } );
  1005. it( 'returns false if empty selection is at the end of non-empty content', () => {
  1006. setData( model, '<p>Foo bar bom.</p>[]' );
  1007. expect( doc.selection.containsEntireContent() ).to.equal( false );
  1008. } );
  1009. } );
  1010. // Map all elements to names. If element contains child text node it will be appended to name with '#'.
  1011. function stringifyBlocks( elements ) {
  1012. return Array.from( elements ).map( el => {
  1013. const name = el.name;
  1014. const firstChild = el.getChild( 0 );
  1015. const hasText = firstChild && firstChild.data;
  1016. return hasText ? `${ name }#${ firstChild.data }` : name;
  1017. } );
  1018. }
  1019. } );