tableutils.js 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887
  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. /**
  6. * @module table/tableutils
  7. */
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import TableWalker from './tablewalker';
  10. import { createEmptyTableCell, updateNumericAttribute } from './utils/common';
  11. import { removeEmptyColumns, removeEmptyRows } from './utils/structure';
  12. /**
  13. * The table utilities plugin.
  14. *
  15. * @extends module:core/plugin~Plugin
  16. */
  17. export default class TableUtils extends Plugin {
  18. /**
  19. * @inheritDoc
  20. */
  21. static get pluginName() {
  22. return 'TableUtils';
  23. }
  24. /**
  25. * Returns the table cell location as an object with table row and table column indexes.
  26. *
  27. * For instance, in the table below:
  28. *
  29. * 0 1 2 3
  30. * +---+---+---+---+
  31. * 0 | a | b | c |
  32. * + + +---+
  33. * 1 | | | d |
  34. * +---+---+ +---+
  35. * 2 | e | | f |
  36. * +---+---+---+---+
  37. *
  38. * the method will return:
  39. *
  40. * const cellA = table.getNodeByPath( [ 0, 0 ] );
  41. * editor.plugins.get( 'TableUtils' ).getCellLocation( cellA );
  42. * // will return { row: 0, column: 0 }
  43. *
  44. * const cellD = table.getNodeByPath( [ 1, 0 ] );
  45. * editor.plugins.get( 'TableUtils' ).getCellLocation( cellD );
  46. * // will return { row: 1, column: 3 }
  47. *
  48. * @param {module:engine/model/element~Element} tableCell
  49. * @returns {Object} Returns a `{row, column}` object.
  50. */
  51. getCellLocation( tableCell ) {
  52. const tableRow = tableCell.parent;
  53. const table = tableRow.parent;
  54. const rowIndex = table.getChildIndex( tableRow );
  55. const tableWalker = new TableWalker( table, { row: rowIndex } );
  56. for ( const { cell, row, column } of tableWalker ) {
  57. if ( cell === tableCell ) {
  58. return { row, column };
  59. }
  60. }
  61. }
  62. /**
  63. * Creates an empty table with a proper structure. The table needs to be inserted into the model,
  64. * for example, by using the {@link module:engine/model/model~Model#insertContent} function.
  65. *
  66. * model.change( ( writer ) => {
  67. * // Create a table of 2 rows and 7 columns:
  68. * const table = tableUtils.createTable( writer, 2, 7);
  69. *
  70. * // Insert a table to the model at the best position taking the current selection:
  71. * model.insertContent( table );
  72. * }
  73. *
  74. * @param {module:engine/model/writer~Writer} writer The model writer.
  75. * @param {Number} rows The number of rows to create.
  76. * @param {Number} columns The number of columns to create.
  77. * @returns {module:engine/model/element~Element} The created table element.
  78. */
  79. createTable( writer, rows, columns ) {
  80. const table = writer.createElement( 'table' );
  81. createEmptyRows( writer, table, 0, rows, columns );
  82. return table;
  83. }
  84. /**
  85. * Inserts rows into a table.
  86. *
  87. * editor.plugins.get( 'TableUtils' ).insertRows( table, { at: 1, rows: 2 } );
  88. *
  89. * Assuming the table on the left, the above code will transform it to the table on the right:
  90. *
  91. * row index
  92. * 0 +---+---+---+ `at` = 1, +---+---+---+ 0
  93. * | a | b | c | `rows` = 2, | a | b | c |
  94. * 1 + +---+---+ <-- insert here + +---+---+ 1
  95. * | | d | e | | | | |
  96. * 2 + +---+---+ will give: + +---+---+ 2
  97. * | | f | g | | | | |
  98. * 3 +---+---+---+ + +---+---+ 3
  99. * | | d | e |
  100. * + +---+---+ 4
  101. * + + f | g |
  102. * +---+---+---+ 5
  103. *
  104. * @param {module:engine/model/element~Element} table The table model element where the rows will be inserted.
  105. * @param {Object} options
  106. * @param {Number} [options.at=0] The row index at which the rows will be inserted.
  107. * @param {Number} [options.rows=1] The number of rows to insert.
  108. * @param {Boolean|undefined} [options.copyStructureFromAbove] The flag for copying row structure. Note that
  109. * the row structure will not be copied if this option is not provided.
  110. */
  111. insertRows( table, options = {} ) {
  112. const model = this.editor.model;
  113. const insertAt = options.at || 0;
  114. const rowsToInsert = options.rows || 1;
  115. const isCopyStructure = options.copyStructureFromAbove !== undefined;
  116. const copyStructureFrom = options.copyStructureFromAbove ? insertAt - 1 : insertAt;
  117. const rows = this.getRows( table );
  118. const columns = this.getColumns( table );
  119. model.change( writer => {
  120. const headingRows = table.getAttribute( 'headingRows' ) || 0;
  121. // Inserting rows inside heading section requires to update `headingRows` attribute as the heading section will grow.
  122. if ( headingRows > insertAt ) {
  123. writer.setAttribute( 'headingRows', headingRows + rowsToInsert, table );
  124. }
  125. // Inserting at the end or at the beginning of a table doesn't require to calculate anything special.
  126. if ( !isCopyStructure && ( insertAt === 0 || insertAt === rows ) ) {
  127. createEmptyRows( writer, table, insertAt, rowsToInsert, columns );
  128. return;
  129. }
  130. // Iterate over all the rows above the inserted rows in order to check for the row-spanned cells.
  131. const walkerEndRow = isCopyStructure ? Math.max( insertAt, copyStructureFrom ) : insertAt;
  132. const tableIterator = new TableWalker( table, { endRow: walkerEndRow } );
  133. // Store spans of the reference row to reproduce it's structure. This array is column number indexed.
  134. const rowColSpansMap = new Array( columns ).fill( 1 );
  135. for ( const { row, column, cellHeight, cellWidth, cell } of tableIterator ) {
  136. const lastCellRow = row + cellHeight - 1;
  137. const isOverlappingInsertedRow = row < insertAt && insertAt <= lastCellRow;
  138. const isReferenceRow = row <= copyStructureFrom && copyStructureFrom <= lastCellRow;
  139. // If the cell is row-spanned and overlaps the inserted row, then reserve space for it in the row map.
  140. if ( isOverlappingInsertedRow ) {
  141. // This cell overlaps the inserted rows so we need to expand it further.
  142. writer.setAttribute( 'rowspan', cellHeight + rowsToInsert, cell );
  143. // Mark this cell with negative number to indicate how many cells should be skipped when adding the new cells.
  144. rowColSpansMap[ column ] = -cellWidth;
  145. }
  146. // Store the colspan from reference row.
  147. else if ( isCopyStructure && isReferenceRow ) {
  148. rowColSpansMap[ column ] = cellWidth;
  149. }
  150. }
  151. for ( let rowIndex = 0; rowIndex < rowsToInsert; rowIndex++ ) {
  152. const tableRow = writer.createElement( 'tableRow' );
  153. writer.insert( tableRow, table, insertAt );
  154. for ( let cellIndex = 0; cellIndex < rowColSpansMap.length; cellIndex++ ) {
  155. const colspan = rowColSpansMap[ cellIndex ];
  156. const insertPosition = writer.createPositionAt( tableRow, 'end' );
  157. // Insert the empty cell only if this slot is not row-spanned from any other cell.
  158. if ( colspan > 0 ) {
  159. createEmptyTableCell( writer, insertPosition, colspan > 1 ? { colspan } : null );
  160. }
  161. // Skip the col-spanned slots, there won't be any cells.
  162. cellIndex += Math.abs( colspan ) - 1;
  163. }
  164. }
  165. } );
  166. }
  167. /**
  168. * Inserts columns into a table.
  169. *
  170. * editor.plugins.get( 'TableUtils' ).insertColumns( table, { at: 1, columns: 2 } );
  171. *
  172. * Assuming the table on the left, the above code will transform it to the table on the right:
  173. *
  174. * 0 1 2 3 0 1 2 3 4 5
  175. * +---+---+---+ +---+---+---+---+---+
  176. * | a | b | | a | b |
  177. * + +---+ + +---+
  178. * | | c | | | c |
  179. * +---+---+---+ will give: +---+---+---+---+---+
  180. * | d | e | f | | d | | | e | f |
  181. * +---+ +---+ +---+---+---+ +---+
  182. * | g | | h | | g | | | | h |
  183. * +---+---+---+ +---+---+---+---+---+
  184. * | i | | i |
  185. * +---+---+---+ +---+---+---+---+---+
  186. * ^---- insert here, `at` = 1, `columns` = 2
  187. *
  188. * @param {module:engine/model/element~Element} table The table model element where the columns will be inserted.
  189. * @param {Object} options
  190. * @param {Number} [options.at=0] The column index at which the columns will be inserted.
  191. * @param {Number} [options.columns=1] The number of columns to insert.
  192. */
  193. insertColumns( table, options = {} ) {
  194. const model = this.editor.model;
  195. const insertAt = options.at || 0;
  196. const columnsToInsert = options.columns || 1;
  197. model.change( writer => {
  198. const headingColumns = table.getAttribute( 'headingColumns' );
  199. // Inserting columns inside heading section requires to update `headingColumns` attribute as the heading section will grow.
  200. if ( insertAt < headingColumns ) {
  201. writer.setAttribute( 'headingColumns', headingColumns + columnsToInsert, table );
  202. }
  203. const tableColumns = this.getColumns( table );
  204. // Inserting at the end and at the beginning of a table doesn't require to calculate anything special.
  205. if ( insertAt === 0 || tableColumns === insertAt ) {
  206. for ( const tableRow of table.getChildren() ) {
  207. createCells( columnsToInsert, writer, writer.createPositionAt( tableRow, insertAt ? 'end' : 0 ) );
  208. }
  209. return;
  210. }
  211. const tableWalker = new TableWalker( table, { column: insertAt, includeAllSlots: true } );
  212. for ( const tableSlot of tableWalker ) {
  213. const { row, cell, cellAnchorColumn, cellAnchorRow, cellWidth, cellHeight } = tableSlot;
  214. // When iterating over column the table walker outputs either:
  215. // - cells at given column index (cell "e" from method docs),
  216. // - spanned columns (spanned cell from row between cells "g" and "h" - spanned by "e", only if `includeAllSlots: true`),
  217. // - or a cell from the same row which spans over this column (cell "a").
  218. if ( cellAnchorColumn < insertAt ) {
  219. // If cell is anchored in previous column, it is a cell that spans over an inserted column (cell "a" & "i").
  220. // For such cells expand them by a number of columns inserted.
  221. writer.setAttribute( 'colspan', cellWidth + columnsToInsert, cell );
  222. // This cell will overlap cells in rows below so skip them (because of `includeAllSlots` option) - (cell "a")
  223. const lastCellRow = cellAnchorRow + cellHeight - 1;
  224. for ( let i = row; i <= lastCellRow; i++ ) {
  225. tableWalker.skipRow( i );
  226. }
  227. } else {
  228. // It's either cell at this column index or spanned cell by a row-spanned cell from row above.
  229. // In table above it's cell "e" and a spanned position from row below (empty cell between cells "g" and "h")
  230. createCells( columnsToInsert, writer, tableSlot.getPositionBefore() );
  231. }
  232. }
  233. } );
  234. }
  235. /**
  236. * Removes rows from the given `table`.
  237. *
  238. * This method re-calculates the table geometry including `rowspan` attribute of table cells overlapping removed rows
  239. * and table headings values.
  240. *
  241. * editor.plugins.get( 'TableUtils' ).removeRows( table, { at: 1, rows: 2 } );
  242. *
  243. * Executing the above code in the context of the table on the left will transform its structure as presented on the right:
  244. *
  245. * row index
  246. * ┌───┬───┬───┐ `at` = 1 ┌───┬───┬───┐
  247. * 0 │ a │ b │ c │ `rows` = 2 │ a │ b │ c │ 0
  248. * │ ├───┼───┤ │ ├───┼───┤
  249. * 1 │ │ d │ e │ <-- remove from here │ │ d │ g │ 1
  250. * │ │ ├───┤ will give: ├───┼───┼───┤
  251. * 2 │ │ │ f │ │ h │ i │ j │ 2
  252. * │ │ ├───┤ └───┴───┴───┘
  253. * 3 │ │ │ g │
  254. * ├───┼───┼───┤
  255. * 4 │ h │ i │ j │
  256. * └───┴───┴───┘
  257. *
  258. * @param {module:engine/model/element~Element} table
  259. * @param {Object} options
  260. * @param {Number} options.at The row index at which the removing rows will start.
  261. * @param {Number} [options.rows=1] The number of rows to remove.
  262. */
  263. removeRows( table, options ) {
  264. const model = this.editor.model;
  265. const rowsToRemove = options.rows || 1;
  266. const first = options.at;
  267. const last = first + rowsToRemove - 1;
  268. const batch = options.batch || 'default';
  269. model.enqueueChange( batch, writer => {
  270. // Removing rows from the table require that most calculations to be done prior to changing table structure.
  271. // Preparations must be done in the same enqueueChange callback to use the current table structure.
  272. // 1. Preparation - get row-spanned cells that have to be modified after removing rows.
  273. const { cellsToMove, cellsToTrim } = getCellsToMoveAndTrimOnRemoveRow( table, first, last );
  274. // 2. Execution
  275. // 2a. Move cells from removed rows that extends over a removed section - must be done before removing rows.
  276. // This will fill any gaps in a rows below that previously were empty because of row-spanned cells.
  277. if ( cellsToMove.size ) {
  278. const rowAfterRemovedSection = last + 1;
  279. moveCellsToRow( table, rowAfterRemovedSection, cellsToMove, writer );
  280. }
  281. // 2b. Remove all required rows.
  282. for ( let i = last; i >= first; i-- ) {
  283. writer.remove( table.getChild( i ) );
  284. }
  285. // 2c. Update cells from rows above that overlap removed section. Similar to step 2 but does not involve moving cells.
  286. for ( const { rowspan, cell } of cellsToTrim ) {
  287. updateNumericAttribute( 'rowspan', rowspan, cell, writer );
  288. }
  289. // 2d. Remove empty columns (without anchored cells) if there are any.
  290. removeEmptyColumns( table, this );
  291. // 2e. Adjust heading rows if removed rows were in a heading section.
  292. updateHeadingRows( table, first, last, model, batch );
  293. } );
  294. }
  295. /**
  296. * Removes columns from the given `table`.
  297. *
  298. * This method re-calculates the table geometry including the `colspan` attribute of table cells overlapping removed columns
  299. * and table headings values.
  300. *
  301. * editor.plugins.get( 'TableUtils' ).removeColumns( table, { at: 1, columns: 2 } );
  302. *
  303. * Executing the above code in the context of the table on the left will transform its structure as presented on the right:
  304. *
  305. * 0 1 2 3 4 0 1 2
  306. * ┌───────────────┬───┐ ┌───────┬───┐
  307. * │ a │ b │ │ a │ b │
  308. * │ ├───┤ │ ├───┤
  309. * │ │ c │ │ │ c │
  310. * ├───┬───┬───┬───┼───┤ will give: ├───┬───┼───┤
  311. * │ d │ e │ f │ g │ h │ │ d │ g │ h │
  312. * ├───┼───┼───┤ ├───┤ ├───┤ ├───┤
  313. * │ i │ j │ k │ │ l │ │ i │ │ l │
  314. * ├───┴───┴───┴───┴───┤ ├───┴───┴───┤
  315. * │ m │ │ m │
  316. * └───────────────────┘ └───────────┘
  317. * ^---- remove from here, `at` = 1, `columns` = 2
  318. *
  319. * @param {module:engine/model/element~Element} table
  320. * @param {Object} options
  321. * @param {Number} options.at The row index at which the removing columns will start.
  322. * @param {Number} [options.columns=1] The number of columns to remove.
  323. */
  324. removeColumns( table, options ) {
  325. const model = this.editor.model;
  326. const first = options.at;
  327. const columnsToRemove = options.columns || 1;
  328. const last = options.at + columnsToRemove - 1;
  329. model.change( writer => {
  330. adjustHeadingColumns( table, { first, last }, writer );
  331. for ( let removedColumnIndex = last; removedColumnIndex >= first; removedColumnIndex-- ) {
  332. for ( const { cell, column, cellWidth } of [ ...new TableWalker( table ) ] ) {
  333. // If colspaned cell overlaps removed column decrease its span.
  334. if ( column <= removedColumnIndex && cellWidth > 1 && column + cellWidth > removedColumnIndex ) {
  335. updateNumericAttribute( 'colspan', cellWidth - 1, cell, writer );
  336. } else if ( column === removedColumnIndex ) {
  337. // The cell in removed column has colspan of 1.
  338. writer.remove( cell );
  339. }
  340. }
  341. }
  342. // Remove empty rows that could appear after removing columns.
  343. removeEmptyRows( table, this, writer.batch );
  344. } );
  345. }
  346. /**
  347. * Divides a table cell vertically into several ones.
  348. *
  349. * The cell will be visually split into more cells by updating colspans of other cells in a column
  350. * and inserting cells (columns) after that cell.
  351. *
  352. * In the table below, if cell "a" is split into 3 cells:
  353. *
  354. * +---+---+---+
  355. * | a | b | c |
  356. * +---+---+---+
  357. * | d | e | f |
  358. * +---+---+---+
  359. *
  360. * it will result in the table below:
  361. *
  362. * +---+---+---+---+---+
  363. * | a | | | b | c |
  364. * +---+---+---+---+---+
  365. * | d | e | f |
  366. * +---+---+---+---+---+
  367. *
  368. * So cell "d" will get its `colspan` updated to `3` and 2 cells will be added (2 columns will be created).
  369. *
  370. * Splitting a cell that already has a `colspan` attribute set will distribute the cell `colspan` evenly and the remainder
  371. * will be left to the original cell:
  372. *
  373. * +---+---+---+
  374. * | a |
  375. * +---+---+---+
  376. * | b | c | d |
  377. * +---+---+---+
  378. *
  379. * Splitting cell "a" with `colspan=3` into 2 cells will create 1 cell with a `colspan=a` and cell "a" that will have `colspan=2`:
  380. *
  381. * +---+---+---+
  382. * | a | |
  383. * +---+---+---+
  384. * | b | c | d |
  385. * +---+---+---+
  386. *
  387. * @param {module:engine/model/element~Element} tableCell
  388. * @param {Number} numberOfCells
  389. */
  390. splitCellVertically( tableCell, numberOfCells = 2 ) {
  391. const model = this.editor.model;
  392. const tableRow = tableCell.parent;
  393. const table = tableRow.parent;
  394. const rowspan = parseInt( tableCell.getAttribute( 'rowspan' ) || 1 );
  395. const colspan = parseInt( tableCell.getAttribute( 'colspan' ) || 1 );
  396. model.change( writer => {
  397. // First check - the cell spans over multiple rows so before doing anything else just split this cell.
  398. if ( colspan > 1 ) {
  399. // Get spans of new (inserted) cells and span to update of split cell.
  400. const { newCellsSpan, updatedSpan } = breakSpanEvenly( colspan, numberOfCells );
  401. updateNumericAttribute( 'colspan', updatedSpan, tableCell, writer );
  402. // Each inserted cell will have the same attributes:
  403. const newCellsAttributes = {};
  404. // Do not store default value in the model.
  405. if ( newCellsSpan > 1 ) {
  406. newCellsAttributes.colspan = newCellsSpan;
  407. }
  408. // Copy rowspan of split cell.
  409. if ( rowspan > 1 ) {
  410. newCellsAttributes.rowspan = rowspan;
  411. }
  412. const cellsToInsert = colspan > numberOfCells ? numberOfCells - 1 : colspan - 1;
  413. createCells( cellsToInsert, writer, writer.createPositionAfter( tableCell ), newCellsAttributes );
  414. }
  415. // Second check - the cell has colspan of 1 or we need to create more cells then the currently one spans over.
  416. if ( colspan < numberOfCells ) {
  417. const cellsToInsert = numberOfCells - colspan;
  418. // First step: expand cells on the same column as split cell.
  419. const tableMap = [ ...new TableWalker( table ) ];
  420. // Get the column index of split cell.
  421. const { column: splitCellColumn } = tableMap.find( ( { cell } ) => cell === tableCell );
  422. // Find cells which needs to be expanded vertically - those on the same column or those that spans over split cell's column.
  423. const cellsToUpdate = tableMap.filter( ( { cell, cellWidth, column } ) => {
  424. const isOnSameColumn = cell !== tableCell && column === splitCellColumn;
  425. const spansOverColumn = ( column < splitCellColumn && column + cellWidth > splitCellColumn );
  426. return isOnSameColumn || spansOverColumn;
  427. } );
  428. // Expand cells vertically.
  429. for ( const { cell, cellWidth } of cellsToUpdate ) {
  430. writer.setAttribute( 'colspan', cellWidth + cellsToInsert, cell );
  431. }
  432. // Second step: create columns after split cell.
  433. // Each inserted cell will have the same attributes:
  434. const newCellsAttributes = {};
  435. // Do not store default value in the model.
  436. // Copy rowspan of split cell.
  437. if ( rowspan > 1 ) {
  438. newCellsAttributes.rowspan = rowspan;
  439. }
  440. createCells( cellsToInsert, writer, writer.createPositionAfter( tableCell ), newCellsAttributes );
  441. const headingColumns = table.getAttribute( 'headingColumns' ) || 0;
  442. // Update heading section if split cell is in heading section.
  443. if ( headingColumns > splitCellColumn ) {
  444. updateNumericAttribute( 'headingColumns', headingColumns + cellsToInsert, table, writer );
  445. }
  446. }
  447. } );
  448. }
  449. /**
  450. * Divides a table cell horizontally into several ones.
  451. *
  452. * 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
  453. * below.
  454. *
  455. * If in the table below cell "b" is split into 3 cells:
  456. *
  457. * +---+---+---+
  458. * | a | b | c |
  459. * +---+---+---+
  460. * | d | e | f |
  461. * +---+---+---+
  462. *
  463. * It will result in the table below:
  464. *
  465. * +---+---+---+
  466. * | a | b | c |
  467. * + +---+ +
  468. * | | | |
  469. * + +---+ +
  470. * | | | |
  471. * +---+---+---+
  472. * | d | e | f |
  473. * +---+---+---+
  474. *
  475. * So cells "a" and "b" will get their `rowspan` updated to `3` and 2 rows with a single cell will be added.
  476. *
  477. * Splitting a cell that already has a `rowspan` attribute set will distribute the cell `rowspan` evenly and the remainder
  478. * will be left to the original cell:
  479. *
  480. * +---+---+---+
  481. * | a | b | c |
  482. * + +---+---+
  483. * | | d | e |
  484. * + +---+---+
  485. * | | f | g |
  486. * + +---+---+
  487. * | | h | i |
  488. * +---+---+---+
  489. *
  490. * Splitting cell "a" with `rowspan=4` into 3 cells will create 2 cells with a `rowspan=1` and cell "a" will have `rowspan=2`:
  491. *
  492. * +---+---+---+
  493. * | a | b | c |
  494. * + +---+---+
  495. * | | d | e |
  496. * +---+---+---+
  497. * | | f | g |
  498. * +---+---+---+
  499. * | | h | i |
  500. * +---+---+---+
  501. *
  502. * @param {module:engine/model/element~Element} tableCell
  503. * @param {Number} numberOfCells
  504. */
  505. splitCellHorizontally( tableCell, numberOfCells = 2 ) {
  506. const model = this.editor.model;
  507. const tableRow = tableCell.parent;
  508. const table = tableRow.parent;
  509. const splitCellRow = table.getChildIndex( tableRow );
  510. const rowspan = parseInt( tableCell.getAttribute( 'rowspan' ) || 1 );
  511. const colspan = parseInt( tableCell.getAttribute( 'colspan' ) || 1 );
  512. model.change( writer => {
  513. // First check - the cell spans over multiple rows so before doing anything else just split this cell.
  514. if ( rowspan > 1 ) {
  515. // Cache table map before updating table.
  516. const tableMap = [ ...new TableWalker( table, {
  517. startRow: splitCellRow,
  518. endRow: splitCellRow + rowspan - 1,
  519. includeAllSlots: true
  520. } ) ];
  521. // Get spans of new (inserted) cells and span to update of split cell.
  522. const { newCellsSpan, updatedSpan } = breakSpanEvenly( rowspan, numberOfCells );
  523. updateNumericAttribute( 'rowspan', updatedSpan, tableCell, writer );
  524. const { column: cellColumn } = tableMap.find( ( { cell } ) => cell === tableCell );
  525. // Each inserted cell will have the same attributes:
  526. const newCellsAttributes = {};
  527. // Do not store default value in the model.
  528. if ( newCellsSpan > 1 ) {
  529. newCellsAttributes.rowspan = newCellsSpan;
  530. }
  531. // Copy colspan of split cell.
  532. if ( colspan > 1 ) {
  533. newCellsAttributes.colspan = colspan;
  534. }
  535. for ( const tableSlot of tableMap ) {
  536. const { column, row } = tableSlot;
  537. // As both newly created cells and the split cell might have rowspan,
  538. // the insertion of new cells must go to appropriate rows:
  539. //
  540. // 1. It's a row after split cell + it's height.
  541. const isAfterSplitCell = row >= splitCellRow + updatedSpan;
  542. // 2. Is on the same column.
  543. const isOnSameColumn = column === cellColumn;
  544. // 3. And it's row index is after previous cell height.
  545. const isInEvenlySplitRow = ( row + splitCellRow + updatedSpan ) % newCellsSpan === 0;
  546. if ( isAfterSplitCell && isOnSameColumn && isInEvenlySplitRow ) {
  547. createCells( 1, writer, tableSlot.getPositionBefore(), newCellsAttributes );
  548. }
  549. }
  550. }
  551. // Second check - the cell has rowspan of 1 or we need to create more cells than the current cell spans over.
  552. if ( rowspan < numberOfCells ) {
  553. // We already split the cell in check one so here we split to the remaining number of cells only.
  554. const cellsToInsert = numberOfCells - rowspan;
  555. // This check is needed since we need to check if there are any cells from previous rows than spans over this cell's row.
  556. const tableMap = [ ...new TableWalker( table, { startRow: 0, endRow: splitCellRow } ) ];
  557. // First step: expand cells.
  558. for ( const { cell, cellHeight, row } of tableMap ) {
  559. // Expand rowspan of cells that are either:
  560. // - on the same row as current cell,
  561. // - or are below split cell row and overlaps that row.
  562. if ( cell !== tableCell && row + cellHeight > splitCellRow ) {
  563. const rowspanToSet = cellHeight + cellsToInsert;
  564. writer.setAttribute( 'rowspan', rowspanToSet, cell );
  565. }
  566. }
  567. // Second step: create rows with single cell below split cell.
  568. const newCellsAttributes = {};
  569. // Copy colspan of split cell.
  570. if ( colspan > 1 ) {
  571. newCellsAttributes.colspan = colspan;
  572. }
  573. createEmptyRows( writer, table, splitCellRow + 1, cellsToInsert, 1, newCellsAttributes );
  574. // Update heading section if split cell is in heading section.
  575. const headingRows = table.getAttribute( 'headingRows' ) || 0;
  576. if ( headingRows > splitCellRow ) {
  577. updateNumericAttribute( 'headingRows', headingRows + cellsToInsert, table, writer );
  578. }
  579. }
  580. } );
  581. }
  582. /**
  583. * Returns the number of columns for a given table.
  584. *
  585. * editor.plugins.get( 'TableUtils' ).getColumns( table );
  586. *
  587. * @param {module:engine/model/element~Element} table The table to analyze.
  588. * @returns {Number}
  589. */
  590. getColumns( table ) {
  591. // Analyze first row only as all the rows should have the same width.
  592. const row = table.getChild( 0 );
  593. return [ ...row.getChildren() ].reduce( ( columns, row ) => {
  594. const columnWidth = parseInt( row.getAttribute( 'colspan' ) || 1 );
  595. return columns + columnWidth;
  596. }, 0 );
  597. }
  598. /**
  599. * Returns the number of rows for a given table.
  600. *
  601. * editor.plugins.get( 'TableUtils' ).getRows( table );
  602. *
  603. * @param {module:engine/model/element~Element} table The table to analyze.
  604. * @returns {Number}
  605. */
  606. getRows( table ) {
  607. // Simple row counting, not including rowspan due to #6427.
  608. return table.childCount;
  609. }
  610. }
  611. // Creates empty rows at the given index in an existing table.
  612. //
  613. // @param {module:engine/model/writer~Writer} writer
  614. // @param {module:engine/model/element~Element} table
  615. // @param {Number} insertAt The row index of row insertion.
  616. // @param {Number} rows The number of rows to create.
  617. // @param {Number} tableCellToInsert The number of cells to insert in each row.
  618. function createEmptyRows( writer, table, insertAt, rows, tableCellToInsert, attributes = {} ) {
  619. for ( let i = 0; i < rows; i++ ) {
  620. const tableRow = writer.createElement( 'tableRow' );
  621. writer.insert( tableRow, table, insertAt );
  622. createCells( tableCellToInsert, writer, writer.createPositionAt( tableRow, 'end' ), attributes );
  623. }
  624. }
  625. // Creates cells at a given position.
  626. //
  627. // @param {Number} columns The number of columns to create
  628. // @param {module:engine/model/writer~Writer} writer
  629. // @param {module:engine/model/position~Position} insertPosition
  630. function createCells( cells, writer, insertPosition, attributes = {} ) {
  631. for ( let i = 0; i < cells; i++ ) {
  632. createEmptyTableCell( writer, insertPosition, attributes );
  633. }
  634. }
  635. // Evenly distributes the span of a cell to a number of provided cells.
  636. // The resulting spans will always be integer values.
  637. //
  638. // For instance breaking a span of 7 into 3 cells will return:
  639. //
  640. // { newCellsSpan: 2, updatedSpan: 3 }
  641. //
  642. // as two cells will have a span of 2 and the remainder will go the first cell so its span will change to 3.
  643. //
  644. // @param {Number} span The span value do break.
  645. // @param {Number} numberOfCells The number of resulting spans.
  646. // @returns {{newCellsSpan: Number, updatedSpan: Number}}
  647. function breakSpanEvenly( span, numberOfCells ) {
  648. if ( span < numberOfCells ) {
  649. return { newCellsSpan: 1, updatedSpan: 1 };
  650. }
  651. const newCellsSpan = Math.floor( span / numberOfCells );
  652. const updatedSpan = ( span - newCellsSpan * numberOfCells ) + newCellsSpan;
  653. return { newCellsSpan, updatedSpan };
  654. }
  655. // Updates heading columns attribute if removing a row from head section.
  656. function adjustHeadingColumns( table, removedColumnIndexes, writer ) {
  657. const headingColumns = table.getAttribute( 'headingColumns' ) || 0;
  658. if ( headingColumns && removedColumnIndexes.first < headingColumns ) {
  659. const headingsRemoved = Math.min( headingColumns - 1 /* Other numbers are 0-based */, removedColumnIndexes.last ) -
  660. removedColumnIndexes.first + 1;
  661. writer.setAttribute( 'headingColumns', headingColumns - headingsRemoved, table );
  662. }
  663. }
  664. // Calculates a new heading rows value for removing rows from heading section.
  665. function updateHeadingRows( table, first, last, model, batch ) {
  666. // Must be done after the changes in table structure (removing rows).
  667. // Otherwise the downcast converter for headingRows attribute will fail.
  668. // See https://github.com/ckeditor/ckeditor5/issues/6391.
  669. //
  670. // Must be completely wrapped in enqueueChange to get the current table state (after applying other enqueued changes).
  671. model.enqueueChange( batch, writer => {
  672. const headingRows = table.getAttribute( 'headingRows' ) || 0;
  673. if ( first < headingRows ) {
  674. const newRows = last < headingRows ? headingRows - ( last - first + 1 ) : first;
  675. updateNumericAttribute( 'headingRows', newRows, table, writer, 0 );
  676. }
  677. } );
  678. }
  679. // Finds cells that will be:
  680. // - trimmed - Cells that are "above" removed rows sections and overlap the removed section - their rowspan must be trimmed.
  681. // - moved - Cells from removed rows section might stick out of. These cells are moved to the next row after a removed section.
  682. //
  683. // Sample table with overlapping & sticking out cells:
  684. //
  685. // +----+----+----+----+----+
  686. // | 00 | 01 | 02 | 03 | 04 |
  687. // +----+ + + + +
  688. // | 10 | | | | |
  689. // +----+----+ + + +
  690. // | 20 | 21 | | | | <-- removed row
  691. // + + +----+ + +
  692. // | | | 32 | | | <-- removed row
  693. // +----+ + +----+ +
  694. // | 40 | | | 43 | |
  695. // +----+----+----+----+----+
  696. //
  697. // In a table above:
  698. // - cells to trim: '02', '03' & '04'.
  699. // - cells to move: '21' & '32'.
  700. function getCellsToMoveAndTrimOnRemoveRow( table, first, last ) {
  701. const cellsToMove = new Map();
  702. const cellsToTrim = [];
  703. for ( const { row, column, cellHeight, cell } of new TableWalker( table, { endRow: last } ) ) {
  704. const lastRowOfCell = row + cellHeight - 1;
  705. const isCellStickingOutFromRemovedRows = row >= first && row <= last && lastRowOfCell > last;
  706. if ( isCellStickingOutFromRemovedRows ) {
  707. const rowspanInRemovedSection = last - row + 1;
  708. const rowSpanToSet = cellHeight - rowspanInRemovedSection;
  709. cellsToMove.set( column, {
  710. cell,
  711. rowspan: rowSpanToSet
  712. } );
  713. }
  714. const isCellOverlappingRemovedRows = row < first && lastRowOfCell >= first;
  715. if ( isCellOverlappingRemovedRows ) {
  716. let rowspanAdjustment;
  717. // Cell fully covers removed section - trim it by removed rows count.
  718. if ( lastRowOfCell >= last ) {
  719. rowspanAdjustment = last - first + 1;
  720. }
  721. // Cell partially overlaps removed section - calculate cell's span that is in removed section.
  722. else {
  723. rowspanAdjustment = lastRowOfCell - first + 1;
  724. }
  725. cellsToTrim.push( {
  726. cell,
  727. rowspan: cellHeight - rowspanAdjustment
  728. } );
  729. }
  730. }
  731. return { cellsToMove, cellsToTrim };
  732. }
  733. function moveCellsToRow( table, targetRowIndex, cellsToMove, writer ) {
  734. const tableWalker = new TableWalker( table, {
  735. includeAllSlots: true,
  736. row: targetRowIndex
  737. } );
  738. const tableRowMap = [ ...tableWalker ];
  739. const row = table.getChild( targetRowIndex );
  740. let previousCell;
  741. for ( const { column, cell, isAnchor } of tableRowMap ) {
  742. if ( cellsToMove.has( column ) ) {
  743. const { cell: cellToMove, rowspan } = cellsToMove.get( column );
  744. const targetPosition = previousCell ?
  745. writer.createPositionAfter( previousCell ) :
  746. writer.createPositionAt( row, 0 );
  747. writer.move( writer.createRangeOn( cellToMove ), targetPosition );
  748. updateNumericAttribute( 'rowspan', rowspan, cellToMove, writer );
  749. previousCell = cellToMove;
  750. } else if ( isAnchor ) {
  751. // If cell is spanned then `cell` holds reference to overlapping cell. See ckeditor/ckeditor5#6502.
  752. previousCell = cell;
  753. }
  754. }
  755. }