8
0

tableutils.js 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module table/tableutils
  7. */
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import TableWalker from './tablewalker';
  10. import { createEmptyTableCell, updateNumericAttribute } from './commands/utils';
  11. /**
  12. * The table utilities plugin.
  13. *
  14. * @extends module:core/plugin~Plugin
  15. */
  16. export default class TableUtils extends Plugin {
  17. /**
  18. * @inheritDoc
  19. */
  20. static get pluginName() {
  21. return 'TableUtils';
  22. }
  23. /**
  24. * Returns the table cell location as an object with table row and table column indexes.
  25. *
  26. * For instance in the table below:
  27. *
  28. * 0 1 2 3
  29. * +---+---+---+---+
  30. * 0 | a | b | c |
  31. * + + +---+
  32. * 1 | | | d |
  33. * +---+---+ +---+
  34. * 2 | e | | f |
  35. * +---+---+---+---+
  36. *
  37. * the method will return:
  38. *
  39. * const cellA = table.getNodeByPath( [ 0, 0 ] );
  40. * editor.plugins.get( 'TableUtils' ).getCellLocation( cellA );
  41. * // will return { row: 0, column: 0 }
  42. *
  43. * const cellD = table.getNodeByPath( [ 1, 0 ] );
  44. * editor.plugins.get( 'TableUtils' ).getCellLocation( cellD );
  45. * // will return { row: 1, column: 3 }
  46. *
  47. * @param {module:engine/model/element~Element} tableCell
  48. * @returns {Object} Returns a `{row, column}` object.
  49. */
  50. getCellLocation( tableCell ) {
  51. const tableRow = tableCell.parent;
  52. const table = tableRow.parent;
  53. const rowIndex = table.getChildIndex( tableRow );
  54. const tableWalker = new TableWalker( table, { startRow: rowIndex, endRow: rowIndex } );
  55. for ( const { cell, row, column } of tableWalker ) {
  56. if ( cell === tableCell ) {
  57. return { row, column };
  58. }
  59. }
  60. }
  61. /**
  62. * Creates an empty table with proper structure. The table needs to be inserted into the model,
  63. * ie. using {@link module:engine/model/model~Model#insertContent} function.
  64. *
  65. * model.change( ( writer ) => {
  66. * // Create a table of 2 rows and 7 columns:
  67. * const table = tableUtils.createTable( writer, 2, 7);
  68. *
  69. * // Insert table to the model at the best position taking current selection:
  70. * model.insertContent( table );
  71. * }
  72. *
  73. * @param {module:engine/model/writer~Writer} writer The model writer.
  74. * @param {Number} rows The number of rows to create.
  75. * @param {Number} columns The number of columns to create.
  76. * @returns {module:engine/model/element~Element} The created table element.
  77. */
  78. createTable( writer, rows, columns ) {
  79. const table = writer.createElement( 'table' );
  80. createEmptyRows( writer, table, 0, rows, columns );
  81. return table;
  82. }
  83. /**
  84. * Inserts rows into a table.
  85. *
  86. * editor.plugins.get( 'TableUtils' ).insertRows( table, { at: 1, rows: 2 } );
  87. *
  88. * Assuming the table on the left, the above code will transform it to the table on the right:
  89. *
  90. * row index
  91. * 0 +---+---+---+ `at` = 1, +---+---+---+ 0
  92. * | a | b | c | `rows` = 2, | a | b | c |
  93. * 1 + +---+---+ <-- insert here + +---+---+ 1
  94. * | | d | e | | | | |
  95. * 2 + +---+---+ will give: + +---+---+ 2
  96. * | | f | g | | | | |
  97. * 3 +---+---+---+ + +---+---+ 3
  98. * | | d | e |
  99. * +---+---+---+ 4
  100. * + + f | g |
  101. * +---+---+---+ 5
  102. *
  103. * @param {module:engine/model/element~Element} table The table model element where the rows will be inserted.
  104. * @param {Object} options
  105. * @param {Number} [options.at=0] Row index at which the rows will be inserted.
  106. * @param {Number} [options.rows=1] The number of rows to insert.
  107. */
  108. insertRows( table, options = {} ) {
  109. const model = this.editor.model;
  110. const insertAt = options.at || 0;
  111. const rowsToInsert = options.rows || 1;
  112. model.change( writer => {
  113. const headingRows = table.getAttribute( 'headingRows' ) || 0;
  114. // Inserting rows inside heading section requires to update `headingRows` attribute as the heading section will grow.
  115. if ( headingRows > insertAt ) {
  116. writer.setAttribute( 'headingRows', headingRows + rowsToInsert, table );
  117. }
  118. // Inserting at the end and at the beginning of a table doesn't require to calculate anything special.
  119. if ( insertAt === 0 || insertAt === table.childCount ) {
  120. createEmptyRows( writer, table, insertAt, rowsToInsert, this.getColumns( table ) );
  121. return;
  122. }
  123. // Iterate over all rows above inserted rows in order to check for rowspanned cells.
  124. const tableIterator = new TableWalker( table, { endRow: insertAt } );
  125. // Will hold number of cells needed to insert in created rows.
  126. // The number might be different then table cell width when there are rowspanned cells.
  127. let cellsToInsert = 0;
  128. for ( const { row, rowspan, colspan, cell } of tableIterator ) {
  129. const isBeforeInsertedRow = row < insertAt;
  130. const overlapsInsertedRow = row + rowspan > insertAt;
  131. if ( isBeforeInsertedRow && overlapsInsertedRow ) {
  132. // This cell overlaps inserted rows so we need to expand it further.
  133. writer.setAttribute( 'rowspan', rowspan + rowsToInsert, cell );
  134. }
  135. // Calculate how many cells to insert based on the width of cells in a row at insert position.
  136. // It might be lower then table width as some cells might overlaps inserted row.
  137. // In the table above the cell 'a' overlaps inserted row so only two empty cells are need to be created.
  138. if ( row === insertAt ) {
  139. cellsToInsert += colspan;
  140. }
  141. }
  142. createEmptyRows( writer, table, insertAt, rowsToInsert, cellsToInsert );
  143. } );
  144. }
  145. /**
  146. * Inserts columns into a table.
  147. *
  148. * editor.plugins.get( 'TableUtils' ).insertColumns( table, { at: 1, columns: 2 } );
  149. *
  150. * Assuming the table on the left, the above code will transform it to the table on the right:
  151. *
  152. * 0 1 2 3 0 1 2 3 4 5
  153. * +---+---+---+ +---+---+---+---+---+
  154. * | a | b | | a | b |
  155. * + +---+ + +---+
  156. * | | c | | | c |
  157. * +---+---+---+ will give: +---+---+---+---+---+
  158. * | d | e | f | | d | | | e | f |
  159. * +---+ +---+ +---+---+---+ +---+
  160. * | g | | h | | g | | | | h |
  161. * +---+---+---+ +---+---+---+---+---+
  162. * | i | | i |
  163. * +---+---+---+ +---+---+---+---+---+
  164. * ^---- insert here, `at` = 1, `columns` = 2
  165. *
  166. * @param {module:engine/model/element~Element} table The table model element where the columns will be inserted.
  167. * @param {Object} options
  168. * @param {Number} [options.at=0] Column index at which the columns will be inserted.
  169. * @param {Number} [options.columns=1] The number of columns to insert.
  170. */
  171. insertColumns( table, options = {} ) {
  172. const model = this.editor.model;
  173. const insertAt = options.at || 0;
  174. const columnsToInsert = options.columns || 1;
  175. model.change( writer => {
  176. const headingColumns = table.getAttribute( 'headingColumns' );
  177. // Inserting columns inside heading section requires to update `headingColumns` attribute as the heading section will grow.
  178. if ( insertAt < headingColumns ) {
  179. writer.setAttribute( 'headingColumns', headingColumns + columnsToInsert, table );
  180. }
  181. const tableColumns = this.getColumns( table );
  182. // Inserting at the end and at the beginning of a table doesn't require to calculate anything special.
  183. if ( insertAt === 0 || tableColumns === insertAt ) {
  184. for ( const tableRow of table.getChildren() ) {
  185. createCells( columnsToInsert, writer, writer.createPositionAt( tableRow, insertAt ? 'end' : 0 ) );
  186. }
  187. return;
  188. }
  189. const tableWalker = new TableWalker( table, { column: insertAt, includeSpanned: true } );
  190. for ( const { row, column, cell, colspan, rowspan, cellIndex } of tableWalker ) {
  191. // When iterating over column the table walker outputs either:
  192. // - cells at given column index (cell "e" from method docs),
  193. // - spanned columns (spanned cell from row between cells "g" and "h" - spanned by "e", only if `includeSpanned: true`),
  194. // - or a cell from the same row which spans over this column (cell "a").
  195. if ( column !== insertAt ) {
  196. // If column is different than `insertAt`, it is a cell that spans over an inserted column (cell "a" & "i").
  197. // For such cells expand them by a number of columns inserted.
  198. writer.setAttribute( 'colspan', colspan + columnsToInsert, cell );
  199. // The `includeSpanned` option will output the "empty"/spanned column so skip this row already.
  200. tableWalker.skipRow( row );
  201. // This cell will overlap cells in rows below so skip them also (because of `includeSpanned` option) - (cell "a")
  202. if ( rowspan > 1 ) {
  203. for ( let i = row + 1; i < row + rowspan; i++ ) {
  204. tableWalker.skipRow( i );
  205. }
  206. }
  207. } else {
  208. // It's either cell at this column index or spanned cell by a rowspanned cell from row above.
  209. // In table above it's cell "e" and a spanned position from row below (empty cell between cells "g" and "h")
  210. const insertPosition = writer.createPositionAt( table.getChild( row ), cellIndex );
  211. createCells( columnsToInsert, writer, insertPosition );
  212. }
  213. }
  214. } );
  215. }
  216. /**
  217. * Divides a table cell vertically into several ones.
  218. *
  219. * The cell will be visually split into more cells by updating colspans of other cells in a column
  220. * and inserting cells (columns) after that cell.
  221. *
  222. * In the table below, if cell "a" is split to 3 cells:
  223. *
  224. * +---+---+---+
  225. * | a | b | c |
  226. * +---+---+---+
  227. * | d | e | f |
  228. * +---+---+---+
  229. *
  230. * it will result in the table below:
  231. *
  232. * +---+---+---+---+---+
  233. * | a | | | b | c |
  234. * +---+---+---+---+---+
  235. * | d | e | f |
  236. * +---+---+---+---+---+
  237. *
  238. * So cell "d" will get its `colspan` updated to `3` and 2 cells will be added (2 columns will be created).
  239. *
  240. * Splitting a cell that already has a `colspan` attribute set will distribute the cell `colspan` evenly and the remainder
  241. * will be left to the original cell:
  242. *
  243. * +---+---+---+
  244. * | a |
  245. * +---+---+---+
  246. * | b | c | d |
  247. * +---+---+---+
  248. *
  249. * Splitting cell "a" with `colspan=3` to 2 cells will create 1 cell with a `colspan=a` and cell "a" that will have `colspan=2`:
  250. *
  251. * +---+---+---+
  252. * | a | |
  253. * +---+---+---+
  254. * | b | c | d |
  255. * +---+---+---+
  256. *
  257. * @param {module:engine/model/element~Element} tableCell
  258. * @param {Number} numberOfCells
  259. */
  260. splitCellVertically( tableCell, numberOfCells = 2 ) {
  261. const model = this.editor.model;
  262. const tableRow = tableCell.parent;
  263. const table = tableRow.parent;
  264. const rowspan = parseInt( tableCell.getAttribute( 'rowspan' ) || 1 );
  265. const colspan = parseInt( tableCell.getAttribute( 'colspan' ) || 1 );
  266. model.change( writer => {
  267. // First check - the cell spans over multiple rows so before doing anything else just split this cell.
  268. if ( colspan > 1 ) {
  269. // Get spans of new (inserted) cells and span to update of split cell.
  270. const { newCellsSpan, updatedSpan } = breakSpanEvenly( colspan, numberOfCells );
  271. updateNumericAttribute( 'colspan', updatedSpan, tableCell, writer );
  272. // Each inserted cell will have the same attributes:
  273. const newCellsAttributes = {};
  274. // Do not store default value in the model.
  275. if ( newCellsSpan > 1 ) {
  276. newCellsAttributes.colspan = newCellsSpan;
  277. }
  278. // Copy rowspan of split cell.
  279. if ( rowspan > 1 ) {
  280. newCellsAttributes.rowspan = rowspan;
  281. }
  282. const cellsToInsert = colspan > numberOfCells ? numberOfCells - 1 : colspan - 1;
  283. createCells( cellsToInsert, writer, writer.createPositionAfter( tableCell ), newCellsAttributes );
  284. }
  285. // Second check - the cell has colspan of 1 or we need to create more cells then the currently one spans over.
  286. if ( colspan < numberOfCells ) {
  287. const cellsToInsert = numberOfCells - colspan;
  288. // First step: expand cells on the same column as split cell.
  289. const tableMap = [ ...new TableWalker( table ) ];
  290. // Get the column index of split cell.
  291. const { column: splitCellColumn } = tableMap.find( ( { cell } ) => cell === tableCell );
  292. // Find cells which needs to be expanded vertically - those on the same column or those that spans over split cell's column.
  293. const cellsToUpdate = tableMap.filter( ( { cell, colspan, column } ) => {
  294. const isOnSameColumn = cell !== tableCell && column === splitCellColumn;
  295. const spansOverColumn = ( column < splitCellColumn && column + colspan > splitCellColumn );
  296. return isOnSameColumn || spansOverColumn;
  297. } );
  298. // Expand cells vertically.
  299. for ( const { cell, colspan } of cellsToUpdate ) {
  300. writer.setAttribute( 'colspan', colspan + cellsToInsert, cell );
  301. }
  302. // Second step: create columns after split cell.
  303. // Each inserted cell will have the same attributes:
  304. const newCellsAttributes = {};
  305. // Do not store default value in the model.
  306. // Copy rowspan of split cell.
  307. if ( rowspan > 1 ) {
  308. newCellsAttributes.rowspan = rowspan;
  309. }
  310. createCells( cellsToInsert, writer, writer.createPositionAfter( tableCell ), newCellsAttributes );
  311. const headingColumns = table.getAttribute( 'headingColumns' ) || 0;
  312. // Update heading section if split cell is in heading section.
  313. if ( headingColumns > splitCellColumn ) {
  314. updateNumericAttribute( 'headingColumns', headingColumns + cellsToInsert, table, writer );
  315. }
  316. }
  317. } );
  318. }
  319. /**
  320. * Divides a table cell horizontally into several ones.
  321. *
  322. * The cell will be visually split into more cells by updating rowspans of other cells in the row and inserting rows with a single cell
  323. * below.
  324. *
  325. * If in the table below cell "b" is split to 3 cells:
  326. *
  327. * +---+---+---+
  328. * | a | b | c |
  329. * +---+---+---+
  330. * | d | e | f |
  331. * +---+---+---+
  332. *
  333. * It will result in the table below:
  334. *
  335. * +---+---+---+
  336. * | a | b | c |
  337. * + +---+ +
  338. * | | | |
  339. * + +---+ +
  340. * | | | |
  341. * +---+---+---+
  342. * | d | e | f |
  343. * +---+---+---+
  344. *
  345. * So cells "a" and "b" will get their `rowspan` updated to `3` and 2 rows with a single cell will be added.
  346. *
  347. * Splitting a cell that already has a `rowspan` attribute set will distribute the cell `rowspan` evenly and the remainder
  348. * will be left to the original cell:
  349. *
  350. * +---+---+---+
  351. * | a | b | c |
  352. * + +---+---+
  353. * | | d | e |
  354. * + +---+---+
  355. * | | f | g |
  356. * + +---+---+
  357. * | | h | i |
  358. * +---+---+---+
  359. *
  360. * Splitting cell "a" with `rowspan=4` to 3 cells will create 2 cells with a `rowspan=1` and cell "a" will have `rowspan=2`:
  361. *
  362. * +---+---+---+
  363. * | a | b | c |
  364. * + +---+---+
  365. * | | d | e |
  366. * +---+---+---+
  367. * | | f | g |
  368. * +---+---+---+
  369. * | | h | i |
  370. * +---+---+---+
  371. *
  372. * @param {module:engine/model/element~Element} tableCell
  373. * @param {Number} numberOfCells
  374. */
  375. splitCellHorizontally( tableCell, numberOfCells = 2 ) {
  376. const model = this.editor.model;
  377. const tableRow = tableCell.parent;
  378. const table = tableRow.parent;
  379. const splitCellRow = table.getChildIndex( tableRow );
  380. const rowspan = parseInt( tableCell.getAttribute( 'rowspan' ) || 1 );
  381. const colspan = parseInt( tableCell.getAttribute( 'colspan' ) || 1 );
  382. model.change( writer => {
  383. // First check - the cell spans over multiple rows so before doing anything else just split this cell.
  384. if ( rowspan > 1 ) {
  385. // Cache table map before updating table.
  386. const tableMap = [ ...new TableWalker( table, {
  387. startRow: splitCellRow,
  388. endRow: splitCellRow + rowspan - 1,
  389. includeSpanned: true
  390. } ) ];
  391. // Get spans of new (inserted) cells and span to update of split cell.
  392. const { newCellsSpan, updatedSpan } = breakSpanEvenly( rowspan, numberOfCells );
  393. updateNumericAttribute( 'rowspan', updatedSpan, tableCell, writer );
  394. const { column: cellColumn } = tableMap.find( ( { cell } ) => cell === tableCell );
  395. // Each inserted cell will have the same attributes:
  396. const newCellsAttributes = {};
  397. // Do not store default value in the model.
  398. if ( newCellsSpan > 1 ) {
  399. newCellsAttributes.rowspan = newCellsSpan;
  400. }
  401. // Copy colspan of split cell.
  402. if ( colspan > 1 ) {
  403. newCellsAttributes.colspan = colspan;
  404. }
  405. for ( const { column, row, cellIndex } of tableMap ) {
  406. // As both newly created cells and the split cell might have rowspan,
  407. // the insertion of new cells must go to appropriate rows:
  408. //
  409. // 1. It's a row after split cell + it's height.
  410. const isAfterSplitCell = row >= splitCellRow + updatedSpan;
  411. // 2. Is on the same column.
  412. const isOnSameColumn = column === cellColumn;
  413. // 3. And it's row index is after previous cell height.
  414. const isInEvenlySplitRow = ( row + splitCellRow + updatedSpan ) % newCellsSpan === 0;
  415. if ( isAfterSplitCell && isOnSameColumn && isInEvenlySplitRow ) {
  416. const position = writer.createPositionAt( table.getChild( row ), cellIndex );
  417. createCells( 1, writer, position, newCellsAttributes );
  418. }
  419. }
  420. }
  421. // Second check - the cell has rowspan of 1 or we need to create more cells than the current cell spans over.
  422. if ( rowspan < numberOfCells ) {
  423. // We already split the cell in check one so here we split to the remaining number of cells only.
  424. const cellsToInsert = numberOfCells - rowspan;
  425. // This check is needed since we need to check if there are any cells from previous rows than spans over this cell's row.
  426. const tableMap = [ ...new TableWalker( table, { startRow: 0, endRow: splitCellRow } ) ];
  427. // First step: expand cells.
  428. for ( const { cell, rowspan, row } of tableMap ) {
  429. // Expand rowspan of cells that are either:
  430. // - on the same row as current cell,
  431. // - or are below split cell row and overlaps that row.
  432. if ( cell !== tableCell && row + rowspan > splitCellRow ) {
  433. const rowspanToSet = rowspan + cellsToInsert;
  434. writer.setAttribute( 'rowspan', rowspanToSet, cell );
  435. }
  436. }
  437. // Second step: create rows with single cell below split cell.
  438. const newCellsAttributes = {};
  439. // Copy colspan of split cell.
  440. if ( colspan > 1 ) {
  441. newCellsAttributes.colspan = colspan;
  442. }
  443. createEmptyRows( writer, table, splitCellRow + 1, cellsToInsert, 1, newCellsAttributes );
  444. // Update heading section if split cell is in heading section.
  445. const headingRows = table.getAttribute( 'headingRows' ) || 0;
  446. if ( headingRows > splitCellRow ) {
  447. updateNumericAttribute( 'headingRows', headingRows + cellsToInsert, table, writer );
  448. }
  449. }
  450. } );
  451. }
  452. /**
  453. * Returns the number of columns for a given table.
  454. *
  455. * editor.plugins.get( 'TableUtils' ).getColumns( table );
  456. *
  457. * @param {module:engine/model/element~Element} table The table to analyze.
  458. * @returns {Number}
  459. */
  460. getColumns( table ) {
  461. // Analyze first row only as all the rows should have the same width.
  462. const row = table.getChild( 0 );
  463. return [ ...row.getChildren() ].reduce( ( columns, row ) => {
  464. const columnWidth = parseInt( row.getAttribute( 'colspan' ) || 1 );
  465. return columns + columnWidth;
  466. }, 0 );
  467. }
  468. }
  469. // Creates empty rows at the given index in an existing table.
  470. //
  471. // @param {module:engine/model/writer~Writer} writer
  472. // @param {module:engine/model/element~Element} table
  473. // @param {Number} insertAt Row index of row insertion.
  474. // @param {Number} rows Number of rows to create.
  475. // @param {Number} tableCellToInsert Number of cells to insert in each row.
  476. function createEmptyRows( writer, table, insertAt, rows, tableCellToInsert, attributes = {} ) {
  477. for ( let i = 0; i < rows; i++ ) {
  478. const tableRow = writer.createElement( 'tableRow' );
  479. writer.insert( tableRow, table, insertAt );
  480. createCells( tableCellToInsert, writer, writer.createPositionAt( tableRow, 'end' ), attributes );
  481. }
  482. }
  483. // Creates cells at a given position.
  484. //
  485. // @param {Number} columns Number of columns to create
  486. // @param {module:engine/model/writer~Writer} writer
  487. // @param {module:engine/model/position~Position} insertPosition
  488. function createCells( cells, writer, insertPosition, attributes = {} ) {
  489. for ( let i = 0; i < cells; i++ ) {
  490. createEmptyTableCell( writer, insertPosition, attributes );
  491. }
  492. }
  493. // Evenly distributes the span of a cell to a number of provided cells.
  494. // The resulting spans will always be integer values.
  495. //
  496. // For instance breaking a span of 7 into 3 cells will return:
  497. //
  498. // { newCellsSpan: 2, updatedSpan: 3 }
  499. //
  500. // as two cells will have a span of 2 and the remainder will go the first cell so its span will change to 3.
  501. //
  502. // @param {Number} span Span value do break.
  503. // @param {Number} numberOfCells Number of resulting spans.
  504. // @returns {{newCellsSpan: Number, updatedSpan: Number}}
  505. function breakSpanEvenly( span, numberOfCells ) {
  506. if ( span < numberOfCells ) {
  507. return { newCellsSpan: 1, updatedSpan: 1 };
  508. }
  509. const newCellsSpan = Math.floor( span / numberOfCells );
  510. const updatedSpan = ( span - newCellsSpan * numberOfCells ) + newCellsSpan;
  511. return { newCellsSpan, updatedSpan };
  512. }