mouseselectionhandler.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525
  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 { assertSelectedCells, modelTable, viewTable } from '../_utils/utils';
  13. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  14. describe( 'table selection', () => {
  15. let editor, model, view, viewDoc;
  16. testUtils.createSinonSandbox();
  17. beforeEach( async () => {
  18. editor = await VirtualTestEditor.create( {
  19. plugins: [ TableEditing, TableSelection, Paragraph ]
  20. } );
  21. model = editor.model;
  22. view = editor.editing.view;
  23. viewDoc = view.document;
  24. setModelData( model, modelTable( [
  25. [ '11[]', '12', '13' ],
  26. [ '21', '22', '23' ],
  27. [ '31', '32', '33' ]
  28. ] ) );
  29. } );
  30. afterEach( async () => {
  31. await editor.destroy();
  32. } );
  33. describe( 'MouseSelectionHandler', () => {
  34. it( 'should not start table selection when mouse move is inside one table cell', () => {
  35. setModelData( model, modelTable( [
  36. [ '[]00', '01' ],
  37. [ '10', '11' ]
  38. ] ) );
  39. pressMouseButtonOver( getTableCell( '00' ) );
  40. assertEqualMarkup( getModelData( model ), modelTable( [
  41. [ '[]00', '01' ],
  42. [ '10', '11' ]
  43. ] ) );
  44. movePressedMouseOver( getTableCell( '00' ) );
  45. assertEqualMarkup( getModelData( model ), modelTable( [
  46. [ '[]00', '01' ],
  47. [ '10', '11' ]
  48. ] ) );
  49. } );
  50. it( 'should start table selection when mouse move expands over two cells', () => {
  51. setModelData( model, modelTable( [
  52. [ '[]00', '01' ],
  53. [ '10', '11' ]
  54. ] ) );
  55. pressMouseButtonOver( getTableCell( '00' ) );
  56. assertEqualMarkup( getModelData( model ), modelTable( [
  57. [ '[]00', '01' ],
  58. [ '10', '11' ]
  59. ] ) );
  60. movePressedMouseOver( getTableCell( '01' ) );
  61. assertSelectedCells( model, [
  62. [ 1, 1 ],
  63. [ 0, 0 ]
  64. ] );
  65. assertEqualMarkup( getViewData( view ), viewTable( [
  66. [
  67. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  68. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true }
  69. ],
  70. [ '10', '11' ]
  71. ], { asWidget: true } ) );
  72. } );
  73. it( 'should select rectangular table cells when mouse moved to diagonal cell (up -> down)', () => {
  74. setModelData( model, modelTable( [
  75. [ '[]00', '01' ],
  76. [ '10', '11' ]
  77. ] ) );
  78. pressMouseButtonOver( getTableCell( '00' ) );
  79. assertEqualMarkup( getModelData( model ), modelTable( [
  80. [ '[]00', '01' ],
  81. [ '10', '11' ]
  82. ] ) );
  83. movePressedMouseOver( getTableCell( '11' ) );
  84. assertSelectedCells( model, [
  85. [ 1, 1 ],
  86. [ 1, 1 ]
  87. ] );
  88. assertEqualMarkup( getViewData( view ), viewTable( [
  89. [
  90. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  91. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true }
  92. ],
  93. [
  94. { contents: '10', class: 'ck-editor__editable_selected', isSelected: true },
  95. { contents: '11', class: 'ck-editor__editable_selected', isSelected: true }
  96. ]
  97. ], { asWidget: true } ) );
  98. } );
  99. it( 'should select rectangular table cells when mouse moved to diagonal cell (down -> up)', () => {
  100. setModelData( model, modelTable( [
  101. [ '00', '01' ],
  102. [ '10', '[]11' ]
  103. ] ) );
  104. pressMouseButtonOver( getTableCell( '11' ) );
  105. assertEqualMarkup( getModelData( model ), modelTable( [
  106. [ '00', '01' ],
  107. [ '10', '[]11' ]
  108. ] ) );
  109. movePressedMouseOver( getTableCell( '00' ) );
  110. assertSelectedCells( model, [
  111. [ 1, 1 ],
  112. [ 1, 1 ]
  113. ] );
  114. assertEqualMarkup( getViewData( view ), viewTable( [
  115. [
  116. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  117. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true }
  118. ],
  119. [
  120. { contents: '10', class: 'ck-editor__editable_selected', isSelected: true },
  121. { contents: '11', class: 'ck-editor__editable_selected', isSelected: true }
  122. ]
  123. ], { asWidget: true } ) );
  124. } );
  125. it( 'should update view selection after changing selection rect', () => {
  126. setModelData( model, modelTable( [
  127. [ '[]00', '01', '02' ],
  128. [ '10', '11', '12' ],
  129. [ '20', '21', '22' ]
  130. ] ) );
  131. pressMouseButtonOver( getTableCell( '00' ) );
  132. movePressedMouseOver( getTableCell( '22' ) );
  133. assertSelectedCells( model, [
  134. [ 1, 1, 1 ],
  135. [ 1, 1, 1 ],
  136. [ 1, 1, 1 ]
  137. ] );
  138. assertEqualMarkup( getViewData( view ), viewTable( [
  139. [
  140. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  141. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true },
  142. { contents: '02', class: 'ck-editor__editable_selected', isSelected: true }
  143. ],
  144. [
  145. { contents: '10', class: 'ck-editor__editable_selected', isSelected: true },
  146. { contents: '11', class: 'ck-editor__editable_selected', isSelected: true },
  147. { contents: '12', class: 'ck-editor__editable_selected', isSelected: true }
  148. ],
  149. [
  150. { contents: '20', class: 'ck-editor__editable_selected', isSelected: true },
  151. { contents: '21', class: 'ck-editor__editable_selected', isSelected: true },
  152. { contents: '22', class: 'ck-editor__editable_selected', isSelected: true }
  153. ]
  154. ], { asWidget: true } ) );
  155. movePressedMouseOver( getTableCell( '11' ) );
  156. assertSelectedCells( model, [
  157. [ 1, 1, 0 ],
  158. [ 1, 1, 0 ],
  159. [ 0, 0, 0 ]
  160. ] );
  161. assertEqualMarkup( getViewData( view ), viewTable( [
  162. [
  163. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  164. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true },
  165. '02'
  166. ],
  167. [
  168. { contents: '10', class: 'ck-editor__editable_selected', isSelected: true },
  169. { contents: '11', class: 'ck-editor__editable_selected', isSelected: true },
  170. '12'
  171. ],
  172. [
  173. '20',
  174. '21',
  175. '22'
  176. ]
  177. ], { asWidget: true } ) );
  178. } );
  179. it( 'should stop selecting after "mouseup" event', () => {
  180. setModelData( model, modelTable( [
  181. [ '[]00', '01' ],
  182. [ '10', '11' ]
  183. ] ) );
  184. pressMouseButtonOver( getTableCell( '00' ) );
  185. assertEqualMarkup( getModelData( model ), modelTable( [
  186. [ '[]00', '01' ],
  187. [ '10', '11' ]
  188. ] ) );
  189. movePressedMouseOver( getTableCell( '01' ) );
  190. releaseMouseButtonOver( getTableCell( '01' ) );
  191. assertSelectedCells( model, [
  192. [ 1, 1 ],
  193. [ 0, 0 ]
  194. ] );
  195. assertEqualMarkup( getViewData( view ), viewTable( [
  196. [
  197. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  198. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true }
  199. ],
  200. [ '10', '11' ]
  201. ], { asWidget: true } ) );
  202. moveReleasedMouseOver( getTableCell( '11' ) );
  203. assertSelectedCells( model, [
  204. [ 1, 1 ],
  205. [ 0, 0 ]
  206. ] );
  207. } );
  208. it( 'should do nothing on "mouseup" event', () => {
  209. setModelData( model, modelTable( [
  210. [ '[]00', '01' ],
  211. [ '10', '11' ]
  212. ] ) );
  213. releaseMouseButtonOver( getTableCell( '01' ) );
  214. assertSelectedCells( model, [
  215. [ 0, 0 ],
  216. [ 0, 0 ]
  217. ] );
  218. } );
  219. it( 'should stop selection mode on "mouseleve" event if next "mousemove" has no button pressed', () => {
  220. setModelData( model, modelTable( [
  221. [ '[]00', '01' ],
  222. [ '10', '11' ]
  223. ] ) );
  224. pressMouseButtonOver( getTableCell( '00' ) );
  225. assertEqualMarkup( getModelData( model ), modelTable( [
  226. [ '[]00', '01' ],
  227. [ '10', '11' ]
  228. ] ) );
  229. movePressedMouseOver( getTableCell( '01' ) );
  230. makeMouseLeave();
  231. assertSelectedCells( model, [
  232. [ 1, 1 ],
  233. [ 0, 0 ]
  234. ] );
  235. assertEqualMarkup( getViewData( view ), viewTable( [
  236. [
  237. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  238. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true }
  239. ],
  240. [ '10', '11' ]
  241. ], { asWidget: true } ) );
  242. moveReleasedMouseOver( getTableCell( '11' ) );
  243. assertSelectedCells( model, [
  244. [ 1, 1 ],
  245. [ 0, 0 ]
  246. ] );
  247. } );
  248. it( 'should continue selection mode on "mouseleve" and "mousemove" if mouse button is pressed', () => {
  249. setModelData( model, modelTable( [
  250. [ '[]00', '01' ],
  251. [ '10', '11' ]
  252. ] ) );
  253. pressMouseButtonOver( getTableCell( '00' ) );
  254. assertEqualMarkup( getModelData( model ), modelTable( [
  255. [ '[]00', '01' ],
  256. [ '10', '11' ]
  257. ] ) );
  258. movePressedMouseOver( getTableCell( '01' ) );
  259. makeMouseLeave();
  260. assertSelectedCells( model, [
  261. [ 1, 1 ],
  262. [ 0, 0 ]
  263. ] );
  264. assertEqualMarkup( getViewData( view ), viewTable( [
  265. [
  266. { contents: '00', class: 'ck-editor__editable_selected', isSelected: true },
  267. { contents: '01', class: 'ck-editor__editable_selected', isSelected: true }
  268. ],
  269. [ '10', '11' ]
  270. ], { asWidget: true } ) );
  271. movePressedMouseOver( getTableCell( '11' ) );
  272. assertSelectedCells( model, [
  273. [ 1, 1 ],
  274. [ 1, 1 ]
  275. ] );
  276. } );
  277. it( 'should do nothing on "mouseleve" event', () => {
  278. setModelData( model, modelTable( [
  279. [ '[]00', '01' ],
  280. [ '10', '11' ]
  281. ] ) );
  282. makeMouseLeave();
  283. assertSelectedCells( model, [
  284. [ 0, 0 ],
  285. [ 0, 0 ]
  286. ] );
  287. } );
  288. it( 'should do nothing on "mousedown" event over ui element (click on selection handle)', () => {
  289. setModelData( model, modelTable( [
  290. [ '[]00', '01' ],
  291. [ '10', '11' ]
  292. ] ) );
  293. const uiElement = viewDoc.getRoot()
  294. .getChild( 0 )
  295. .getChild( 0 ); // selection handler;
  296. fireEvent( view, 'mousedown', addTarget( uiElement ), mouseButtonPressed );
  297. assertEqualMarkup( getModelData( model ), modelTable( [
  298. [ '[]00', '01' ],
  299. [ '10', '11' ]
  300. ] ) );
  301. } );
  302. it( 'should do nothing on "mousemove" event over ui element (click on selection handle)', () => {
  303. setModelData( model, modelTable( [
  304. [ '[]00', '01' ],
  305. [ '10', '11' ]
  306. ] ) );
  307. const uiElement = viewDoc.getRoot()
  308. .getChild( 0 )
  309. .getChild( 0 ); // selection handler;
  310. fireEvent( view, 'mousemove', addTarget( uiElement ), mouseButtonPressed );
  311. assertEqualMarkup( getModelData( model ), modelTable( [
  312. [ '[]00', '01' ],
  313. [ '10', '11' ]
  314. ] ) );
  315. } );
  316. it( 'should clear view table selection after mouse click outside table', () => {
  317. setModelData( model, modelTable( [
  318. [ '[]00', '01' ],
  319. [ '10', '11' ]
  320. ] ) + '<paragraph>foo</paragraph>' );
  321. pressMouseButtonOver( getTableCell( '00' ) );
  322. assertEqualMarkup( getModelData( model ), modelTable( [
  323. [ '[]00', '01' ],
  324. [ '10', '11' ]
  325. ] ) + '<paragraph>foo</paragraph>' );
  326. movePressedMouseOver( getTableCell( '01' ) );
  327. const paragraph = viewDoc.getRoot().getChild( 1 );
  328. fireEvent( view, 'mousemove', addTarget( paragraph ) );
  329. fireEvent( view, 'mousedown', addTarget( paragraph ) );
  330. fireEvent( view, 'mouseup', addTarget( paragraph ) );
  331. // The click in the DOM would trigger selection change and it will set the selection:
  332. model.change( writer => {
  333. writer.setSelection( writer.createRange( writer.createPositionAt( model.document.getRoot().getChild( 1 ), 0 ) ) );
  334. } );
  335. assertEqualMarkup( getViewData( view ), viewTable( [
  336. [ '00', '01' ],
  337. [ '10', '11' ]
  338. ], { asWidget: true } ) + '<p>{}foo</p>' );
  339. } );
  340. // https://github.com/ckeditor/ckeditor5/issues/6353
  341. it( 'should do nothing on successive "mouseup" events beyond the table after the selection was fininished', () => {
  342. const spy = testUtils.sinon.spy( editor.plugins.get( 'TableSelection' ), 'stopSelection' );
  343. setModelData( model, modelTable( [
  344. [ '[]00', '01' ],
  345. [ '10', '11' ]
  346. ] ) );
  347. pressMouseButtonOver( getTableCell( '00' ) );
  348. movePressedMouseOver( getTableCell( '11' ) );
  349. releaseMouseButtonOver( getTableCell( '11' ) );
  350. sinon.assert.calledOnce( spy );
  351. pressMouseButtonOver( viewDoc.getRoot() );
  352. releaseMouseButtonOver( viewDoc.getRoot() );
  353. sinon.assert.calledOnce( spy );
  354. } );
  355. // https://github.com/ckeditor/ckeditor5/issues/6114
  356. it( 'should prevent default the "mousemove" event to prevent the native DOM selection from changing', () => {
  357. setModelData( model, modelTable( [
  358. [ '[]00', '01' ],
  359. [ '10', '11' ]
  360. ] ) );
  361. pressMouseButtonOver( getTableCell( '00' ) );
  362. const domEvtData = movePressedMouseOver( getTableCell( '11' ) );
  363. releaseMouseButtonOver( getTableCell( '11' ) );
  364. sinon.assert.calledOnce( domEvtData.preventDefault );
  365. } );
  366. } );
  367. function getTableCell( data ) {
  368. for ( const value of view.createRangeIn( viewDoc.getRoot() ) ) {
  369. if ( value.type === 'text' && value.item.data === data ) {
  370. return value.item.parent.parent;
  371. }
  372. }
  373. }
  374. function makeMouseLeave() {
  375. fireEvent( view, 'mouseleave' );
  376. }
  377. function pressMouseButtonOver( target ) {
  378. fireEvent( view, 'mousedown', addTarget( target ), mouseButtonPressed );
  379. }
  380. function movePressedMouseOver( target ) {
  381. return moveMouseOver( target, mouseButtonPressed );
  382. }
  383. function moveReleasedMouseOver( target ) {
  384. moveMouseOver( target, mouseButtonReleased );
  385. }
  386. function moveMouseOver( target, ...decorators ) {
  387. return fireEvent( view, 'mousemove', addTarget( target ), ...decorators );
  388. }
  389. function releaseMouseButtonOver( target ) {
  390. fireEvent( view, 'mouseup', addTarget( target ), mouseButtonReleased );
  391. }
  392. function addTarget( target ) {
  393. return domEventData => {
  394. domEventData.target = target;
  395. };
  396. }
  397. function mouseButtonPressed( domEventData ) {
  398. domEventData.domEvent.buttons = 1;
  399. }
  400. function mouseButtonReleased( domEventData ) {
  401. domEventData.domEvent.buttons = 0;
  402. }
  403. function fireEvent( view, eventName, ...decorators ) {
  404. const domEvtDataStub = {
  405. domEvent: {
  406. buttons: 0
  407. },
  408. target: undefined,
  409. preventDefault: sinon.spy(),
  410. stopPropagation: sinon.spy()
  411. };
  412. for ( const decorator of decorators ) {
  413. decorator( domEvtDataStub );
  414. }
  415. viewDoc.fire( eventName, domEvtDataStub );
  416. return domEvtDataStub;
  417. }
  418. } );