tableselection.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  8. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  9. import { assertEqualMarkup } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  10. import TableEditing from '../src/tableediting';
  11. import TableSelection from '../src/tableselection';
  12. import { modelTable, viewTable } from './_utils/utils';
  13. describe.only( 'table selection', () => {
  14. let editor, model, tableSelection, modelRoot;
  15. beforeEach( async () => {
  16. editor = await VirtualTestEditor.create( {
  17. plugins: [ TableEditing, TableSelection, Paragraph ]
  18. } );
  19. model = editor.model;
  20. modelRoot = model.document.getRoot();
  21. tableSelection = editor.plugins.get( TableSelection );
  22. setModelData( model, modelTable( [
  23. [ '11', '12', '13' ],
  24. [ '21', '22', '23' ],
  25. [ '31', '32', '33' ]
  26. ] ) );
  27. } );
  28. afterEach( async () => {
  29. await editor.destroy();
  30. } );
  31. describe( 'TableSelection', () => {
  32. describe( 'hasValidSelection()', () => {
  33. it( 'should be false if selection is not started', () => {
  34. expect( tableSelection.hasValidSelection ).to.be.false;
  35. } );
  36. it( 'should be true if selection is selecting two different cells', () => {
  37. tableSelection.startSelectingFrom( modelRoot.getNodeByPath( [ 0, 0, 0 ] ) );
  38. tableSelection.setSelectingTo( modelRoot.getNodeByPath( [ 0, 0, 1 ] ) );
  39. expect( tableSelection.hasValidSelection ).to.be.true;
  40. } );
  41. it( 'should be false if selection start/end is selecting the same table cell', () => {
  42. tableSelection.startSelectingFrom( modelRoot.getNodeByPath( [ 0, 0, 0 ] ) );
  43. tableSelection.setSelectingTo( modelRoot.getNodeByPath( [ 0, 0, 0 ] ) );
  44. expect( tableSelection.hasValidSelection ).to.be.false;
  45. } );
  46. it( 'should be false if selection has no end cell', () => {
  47. tableSelection.startSelectingFrom( modelRoot.getNodeByPath( [ 0, 0, 0 ] ) );
  48. expect( tableSelection.hasValidSelection ).to.be.false;
  49. } );
  50. it( 'should be false if selection has ended', () => {
  51. tableSelection.startSelectingFrom( modelRoot.getNodeByPath( [ 0, 0, 0 ] ) );
  52. tableSelection.setSelectingTo( modelRoot.getNodeByPath( [ 0, 0, 1 ] ) );
  53. tableSelection.stopSelection();
  54. expect( tableSelection.hasValidSelection ).to.be.false;
  55. } );
  56. } );
  57. } );
  58. describe( 'mouse selection', () => {
  59. let view, domEvtDataStub;
  60. beforeEach( () => {
  61. view = editor.editing.view;
  62. domEvtDataStub = {
  63. domEvent: {
  64. buttons: 1
  65. },
  66. target: undefined,
  67. preventDefault: sinon.spy(),
  68. stopPropagation: sinon.spy()
  69. };
  70. } );
  71. it( 'should not start table selection when mouse move is inside one table cell', () => {
  72. setModelData( model, modelTable( [
  73. [ '[]00', '01' ],
  74. [ '10', '11' ]
  75. ] ) );
  76. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  77. view.document.fire( 'mousedown', domEvtDataStub );
  78. assertEqualMarkup( getModelData( model ), modelTable( [
  79. [ '[]00', '01' ],
  80. [ '10', '11' ]
  81. ] ) );
  82. view.document.fire( 'mousemove', domEvtDataStub );
  83. assertEqualMarkup( getModelData( model ), modelTable( [
  84. [ '[]00', '01' ],
  85. [ '10', '11' ]
  86. ] ) );
  87. } );
  88. it( 'should start table selection when mouse move expands over two cells', () => {
  89. setModelData( model, modelTable( [
  90. [ '[]00', '01' ],
  91. [ '10', '11' ]
  92. ] ) );
  93. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  94. view.document.fire( 'mousedown', domEvtDataStub );
  95. assertEqualMarkup( getModelData( model ), modelTable( [
  96. [ '[]00', '01' ],
  97. [ '10', '11' ]
  98. ] ) );
  99. selectTableCell( domEvtDataStub, view, 0, 0, 0, 1 );
  100. view.document.fire( 'mousemove', domEvtDataStub );
  101. assertEqualMarkup( getModelData( model ), modelTable( [
  102. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  103. [ '10', '11' ]
  104. ] ) );
  105. assertEqualMarkup( getViewData( view ), viewTable( [
  106. [ { contents: '00', class: 'selected', isSelected: true }, { contents: '01', class: 'selected', isSelected: true } ],
  107. [ '10', '11' ]
  108. ], { asWidget: true } ) );
  109. } );
  110. it( 'should select rectangular table cells when mouse moved to diagonal cell (up -> down)', () => {
  111. setModelData( model, modelTable( [
  112. [ '[]00', '01' ],
  113. [ '10', '11' ]
  114. ] ) );
  115. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  116. view.document.fire( 'mousedown', domEvtDataStub );
  117. assertEqualMarkup( getModelData( model ), modelTable( [
  118. [ '[]00', '01' ],
  119. [ '10', '11' ]
  120. ] ) );
  121. selectTableCell( domEvtDataStub, view, 0, 0, 1, 1 );
  122. view.document.fire( 'mousemove', domEvtDataStub );
  123. assertEqualMarkup( getModelData( model ), modelTable( [
  124. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  125. [ { contents: '10', isSelected: true }, { contents: '11', isSelected: true } ]
  126. ] ) );
  127. assertEqualMarkup( getViewData( view ), viewTable( [
  128. [ { contents: '00', class: 'selected', isSelected: true }, { contents: '01', class: 'selected', isSelected: true } ],
  129. [ { contents: '10', class: 'selected', isSelected: true }, { contents: '11', class: 'selected', isSelected: true } ]
  130. ], { asWidget: true } ) );
  131. } );
  132. it( 'should select rectangular table cells when mouse moved to diagonal cell (down -> up)', () => {
  133. setModelData( model, modelTable( [
  134. [ '00', '01' ],
  135. [ '10', '[]11' ]
  136. ] ) );
  137. selectTableCell( domEvtDataStub, view, 0, 0, 1, 1 );
  138. view.document.fire( 'mousedown', domEvtDataStub );
  139. assertEqualMarkup( getModelData( model ), modelTable( [
  140. [ '00', '01' ],
  141. [ '10', '[]11' ]
  142. ] ) );
  143. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  144. view.document.fire( 'mousemove', domEvtDataStub );
  145. assertEqualMarkup( getModelData( model ), modelTable( [
  146. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  147. [ { contents: '10', isSelected: true }, { contents: '11', isSelected: true } ]
  148. ] ) );
  149. assertEqualMarkup( getViewData( view ), viewTable( [
  150. [ { contents: '00', class: 'selected', isSelected: true }, { contents: '01', class: 'selected', isSelected: true } ],
  151. [ { contents: '10', class: 'selected', isSelected: true }, { contents: '11', class: 'selected', isSelected: true } ]
  152. ], { asWidget: true } ) );
  153. } );
  154. it( 'should update view selection after changing selection rect', () => {
  155. setModelData( model, modelTable( [
  156. [ '[]00', '01', '02' ],
  157. [ '10', '11', '12' ],
  158. [ '20', '21', '22' ]
  159. ] ) );
  160. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  161. view.document.fire( 'mousedown', domEvtDataStub );
  162. selectTableCell( domEvtDataStub, view, 0, 0, 2, 2 );
  163. view.document.fire( 'mousemove', domEvtDataStub );
  164. assertEqualMarkup( getModelData( model ), modelTable( [
  165. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true }, { contents: '02', isSelected: true } ],
  166. [ { contents: '10', isSelected: true }, { contents: '11', isSelected: true }, { contents: '12', isSelected: true } ],
  167. [ { contents: '20', isSelected: true }, { contents: '21', isSelected: true }, { contents: '22', isSelected: true } ]
  168. ] ) );
  169. assertEqualMarkup( getViewData( view ), viewTable( [
  170. [
  171. { contents: '00', class: 'selected', isSelected: true },
  172. { contents: '01', class: 'selected', isSelected: true },
  173. { contents: '02', class: 'selected', isSelected: true }
  174. ],
  175. [
  176. { contents: '10', class: 'selected', isSelected: true },
  177. { contents: '11', class: 'selected', isSelected: true },
  178. { contents: '12', class: 'selected', isSelected: true }
  179. ],
  180. [
  181. { contents: '20', class: 'selected', isSelected: true },
  182. { contents: '21', class: 'selected', isSelected: true },
  183. { contents: '22', class: 'selected', isSelected: true }
  184. ]
  185. ], { asWidget: true } ) );
  186. selectTableCell( domEvtDataStub, view, 0, 0, 1, 1 );
  187. view.document.fire( 'mousemove', domEvtDataStub );
  188. assertEqualMarkup( getModelData( model ), modelTable( [
  189. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true }, '02' ],
  190. [ { contents: '10', isSelected: true }, { contents: '11', isSelected: true }, '12' ],
  191. [ '20', '21', '22' ]
  192. ] ) );
  193. assertEqualMarkup( getViewData( view ), viewTable( [
  194. [
  195. { contents: '00', class: 'selected', isSelected: true },
  196. { contents: '01', class: 'selected', isSelected: true },
  197. '02'
  198. ],
  199. [
  200. { contents: '10', class: 'selected', isSelected: true },
  201. { contents: '11', class: 'selected', isSelected: true },
  202. '12'
  203. ],
  204. [
  205. '20',
  206. '21',
  207. '22'
  208. ]
  209. ], { asWidget: true } ) );
  210. } );
  211. it( 'should stop selecting after "mouseup" event', () => {
  212. setModelData( model, modelTable( [
  213. [ '[]00', '01' ],
  214. [ '10', '11' ]
  215. ] ) );
  216. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  217. view.document.fire( 'mousedown', domEvtDataStub );
  218. assertEqualMarkup( getModelData( model ), modelTable( [
  219. [ '[]00', '01' ],
  220. [ '10', '11' ]
  221. ] ) );
  222. selectTableCell( domEvtDataStub, view, 0, 0, 0, 1 );
  223. view.document.fire( 'mousemove', domEvtDataStub );
  224. view.document.fire( 'mouseup', domEvtDataStub );
  225. assertEqualMarkup( getModelData( model ), modelTable( [
  226. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  227. [ '10', '11' ]
  228. ] ) );
  229. assertEqualMarkup( getViewData( view ), viewTable( [
  230. [ { contents: '00', class: 'selected', isSelected: true }, { contents: '01', class: 'selected', isSelected: true } ],
  231. [ '10', '11' ]
  232. ], { asWidget: true } ) );
  233. selectTableCell( domEvtDataStub, view, 0, 0, 1, 1 );
  234. view.document.fire( 'mousemove', domEvtDataStub );
  235. assertEqualMarkup( getModelData( model ), modelTable( [
  236. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  237. [ '10', '11' ]
  238. ] ) );
  239. } );
  240. it( 'should stop selection mode on "mouseleve" event', () => {
  241. setModelData( model, modelTable( [
  242. [ '[]00', '01' ],
  243. [ '10', '11' ]
  244. ] ) );
  245. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  246. view.document.fire( 'mousedown', domEvtDataStub );
  247. assertEqualMarkup( getModelData( model ), modelTable( [
  248. [ '[]00', '01' ],
  249. [ '10', '11' ]
  250. ] ) );
  251. selectTableCell( domEvtDataStub, view, 0, 0, 0, 1 );
  252. view.document.fire( 'mousemove', domEvtDataStub );
  253. view.document.fire( 'mouseleave', domEvtDataStub );
  254. assertEqualMarkup( getModelData( model ), modelTable( [
  255. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  256. [ '10', '11' ]
  257. ] ) );
  258. assertEqualMarkup( getViewData( view ), viewTable( [
  259. [ { contents: '00', class: 'selected', isSelected: true }, { contents: '01', class: 'selected', isSelected: true } ],
  260. [ '10', '11' ]
  261. ], { asWidget: true } ) );
  262. selectTableCell( domEvtDataStub, view, 0, 0, 1, 1 );
  263. view.document.fire( 'mousemove', domEvtDataStub );
  264. assertEqualMarkup( getModelData( model ), modelTable( [
  265. [ { contents: '00', isSelected: true }, { contents: '01', isSelected: true } ],
  266. [ '10', '11' ]
  267. ] ) );
  268. } );
  269. it( 'should clear view table selection after mouse click outside table', () => {
  270. setModelData( model, modelTable( [
  271. [ '[]00', '01' ],
  272. [ '10', '11' ]
  273. ] ) + '<paragraph>foo</paragraph>' );
  274. selectTableCell( domEvtDataStub, view, 0, 0, 0, 0 );
  275. view.document.fire( 'mousedown', domEvtDataStub );
  276. assertEqualMarkup( getModelData( model ), modelTable( [
  277. [ '[]00', '01' ],
  278. [ '10', '11' ]
  279. ] ) + '<paragraph>foo</paragraph>' );
  280. selectTableCell( domEvtDataStub, view, 0, 0, 0, 1 );
  281. view.document.fire( 'mousemove', domEvtDataStub );
  282. domEvtDataStub.target = view.document.getRoot().getChild( 1 );
  283. view.document.fire( 'mousemove', domEvtDataStub );
  284. view.document.fire( 'mousedown', domEvtDataStub );
  285. view.document.fire( 'mouseup', domEvtDataStub );
  286. // The click in the DOM would trigger selection change and it will set the selection:
  287. model.change( writer => {
  288. writer.setSelection( writer.createRange( writer.createPositionAt( model.document.getRoot().getChild( 1 ), 0 ) ) );
  289. } );
  290. assertEqualMarkup( getViewData( view ), viewTable( [
  291. [ '00', '01' ],
  292. [ '10', '11' ]
  293. ], { asWidget: true } ) + '<p>{}foo</p>' );
  294. } );
  295. } );
  296. } );
  297. function selectTableCell( domEvtDataStub, view, tableIndex, sectionIndex, rowInSectionIndex, tableCellIndex ) {
  298. domEvtDataStub.target = view.document.getRoot()
  299. .getChild( tableIndex )
  300. .getChild( 1 ) // Table is second in widget
  301. .getChild( sectionIndex )
  302. .getChild( rowInSectionIndex )
  303. .getChild( tableCellIndex );
  304. }