@ckeditor/ckeditor5-table 40.0.0 → 40.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/CHANGELOG.md +15 -15
  2. package/LICENSE.md +3 -3
  3. package/build/table.js +1 -1
  4. package/build/translations/fi.js +1 -1
  5. package/lang/translations/fi.po +3 -3
  6. package/package.json +2 -2
  7. package/src/augmentation.d.ts +76 -76
  8. package/src/augmentation.js +5 -5
  9. package/src/commands/insertcolumncommand.d.ts +55 -55
  10. package/src/commands/insertcolumncommand.js +67 -67
  11. package/src/commands/insertrowcommand.d.ts +54 -54
  12. package/src/commands/insertrowcommand.js +66 -66
  13. package/src/commands/inserttablecommand.d.ts +44 -44
  14. package/src/commands/inserttablecommand.js +69 -69
  15. package/src/commands/mergecellcommand.d.ts +68 -68
  16. package/src/commands/mergecellcommand.js +198 -198
  17. package/src/commands/mergecellscommand.d.ts +28 -28
  18. package/src/commands/mergecellscommand.js +94 -94
  19. package/src/commands/removecolumncommand.d.ts +29 -29
  20. package/src/commands/removecolumncommand.js +109 -109
  21. package/src/commands/removerowcommand.d.ts +29 -29
  22. package/src/commands/removerowcommand.js +82 -82
  23. package/src/commands/selectcolumncommand.d.ts +33 -33
  24. package/src/commands/selectcolumncommand.js +60 -60
  25. package/src/commands/selectrowcommand.d.ts +33 -33
  26. package/src/commands/selectrowcommand.js +56 -56
  27. package/src/commands/setheadercolumncommand.d.ts +50 -50
  28. package/src/commands/setheadercolumncommand.js +71 -71
  29. package/src/commands/setheaderrowcommand.d.ts +53 -53
  30. package/src/commands/setheaderrowcommand.js +79 -79
  31. package/src/commands/splitcellcommand.d.ts +43 -43
  32. package/src/commands/splitcellcommand.js +54 -54
  33. package/src/converters/downcast.d.ts +63 -63
  34. package/src/converters/downcast.js +146 -146
  35. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  36. package/src/converters/table-caption-post-fixer.js +53 -53
  37. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  38. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  39. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  40. package/src/converters/table-cell-refresh-handler.js +45 -45
  41. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  42. package/src/converters/table-headings-refresh-handler.js +49 -49
  43. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  44. package/src/converters/table-layout-post-fixer.js +367 -367
  45. package/src/converters/tableproperties.d.ts +54 -54
  46. package/src/converters/tableproperties.js +159 -159
  47. package/src/converters/upcasttable.d.ts +49 -49
  48. package/src/converters/upcasttable.js +243 -243
  49. package/src/index.d.ts +60 -60
  50. package/src/index.js +30 -30
  51. package/src/plaintableoutput.d.ts +26 -26
  52. package/src/plaintableoutput.js +123 -123
  53. package/src/table.d.ts +40 -40
  54. package/src/table.js +44 -44
  55. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  56. package/src/tablecaption/tablecaptionediting.js +122 -122
  57. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  58. package/src/tablecaption/tablecaptionui.js +57 -57
  59. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  60. package/src/tablecaption/toggletablecaptioncommand.js +105 -104
  61. package/src/tablecaption/utils.d.ts +38 -42
  62. package/src/tablecaption/utils.js +57 -67
  63. package/src/tablecaption.d.ts +24 -24
  64. package/src/tablecaption.js +28 -28
  65. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  66. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  67. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  68. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  69. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  70. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  71. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  72. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  73. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  74. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  75. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  76. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  77. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  78. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  79. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  80. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  81. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  82. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  83. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  84. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  85. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  86. package/src/tablecellproperties/tablecellpropertiesui.js +330 -330
  87. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +228 -228
  88. package/src/tablecellproperties/ui/tablecellpropertiesview.js +548 -548
  89. package/src/tablecellproperties.d.ts +30 -30
  90. package/src/tablecellproperties.js +34 -34
  91. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  92. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  93. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  94. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  95. package/src/tableclipboard.d.ts +65 -65
  96. package/src/tableclipboard.js +450 -450
  97. package/src/tablecolumnresize/constants.d.ts +20 -20
  98. package/src/tablecolumnresize/constants.js +20 -20
  99. package/src/tablecolumnresize/converters.d.ts +18 -18
  100. package/src/tablecolumnresize/converters.js +46 -46
  101. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  102. package/src/tablecolumnresize/tablecolumnresizeediting.js +583 -583
  103. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  104. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  105. package/src/tablecolumnresize/utils.d.ts +148 -148
  106. package/src/tablecolumnresize/utils.js +358 -358
  107. package/src/tablecolumnresize.d.ts +26 -26
  108. package/src/tablecolumnresize.js +30 -30
  109. package/src/tableconfig.d.ts +343 -343
  110. package/src/tableconfig.js +5 -5
  111. package/src/tableediting.d.ts +98 -98
  112. package/src/tableediting.js +191 -191
  113. package/src/tablekeyboard.d.ts +68 -68
  114. package/src/tablekeyboard.js +279 -279
  115. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  116. package/src/tablemouse/mouseeventsobserver.js +35 -35
  117. package/src/tablemouse.d.ts +48 -48
  118. package/src/tablemouse.js +172 -172
  119. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  120. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  121. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  122. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  123. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  124. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  125. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  126. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  127. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  128. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  129. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  130. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  131. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  132. package/src/tableproperties/commands/tablepropertycommand.js +81 -80
  133. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  134. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  135. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  136. package/src/tableproperties/tablepropertiesediting.js +206 -206
  137. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  138. package/src/tableproperties/tablepropertiesui.js +321 -321
  139. package/src/tableproperties/ui/tablepropertiesview.d.ts +207 -207
  140. package/src/tableproperties/ui/tablepropertiesview.js +466 -466
  141. package/src/tableproperties.d.ts +30 -30
  142. package/src/tableproperties.js +34 -34
  143. package/src/tableselection.d.ts +107 -107
  144. package/src/tableselection.js +297 -297
  145. package/src/tabletoolbar.d.ts +32 -32
  146. package/src/tabletoolbar.js +57 -57
  147. package/src/tableui.d.ts +53 -53
  148. package/src/tableui.js +309 -309
  149. package/src/tableutils.d.ts +448 -448
  150. package/src/tableutils.js +1055 -1055
  151. package/src/tablewalker.d.ts +362 -362
  152. package/src/tablewalker.js +393 -393
  153. package/src/ui/colorinputview.d.ts +140 -140
  154. package/src/ui/colorinputview.js +271 -271
  155. package/src/ui/formrowview.d.ts +61 -61
  156. package/src/ui/formrowview.js +57 -57
  157. package/src/ui/inserttableview.d.ts +77 -77
  158. package/src/ui/inserttableview.js +169 -169
  159. package/src/utils/common.d.ts +46 -42
  160. package/src/utils/common.js +68 -57
  161. package/src/utils/structure.d.ts +245 -245
  162. package/src/utils/structure.js +426 -426
  163. package/src/utils/table-properties.d.ts +67 -67
  164. package/src/utils/table-properties.js +86 -86
  165. package/src/utils/ui/contextualballoon.d.ts +34 -34
  166. package/src/utils/ui/contextualballoon.js +110 -106
  167. package/src/utils/ui/table-properties.d.ts +195 -195
  168. package/src/utils/ui/table-properties.js +362 -362
  169. package/src/utils/ui/widget.d.ts +20 -16
  170. package/src/utils/ui/widget.js +48 -38
  171. package/build/table.js.map +0 -1
@@ -1,198 +1,198 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import { Command } from 'ckeditor5/src/core';
6
- import TableWalker from '../tablewalker';
7
- import { isHeadingColumnCell } from '../utils/common';
8
- import { removeEmptyRowsColumns } from '../utils/structure';
9
- /**
10
- * The merge cell command.
11
- *
12
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCellRight'`, `'mergeTableCellLeft'`,
13
- * `'mergeTableCellUp'` and `'mergeTableCellDown'` editor commands.
14
- *
15
- * To merge a table cell at the current selection with another cell, execute the command corresponding with the preferred direction.
16
- *
17
- * For example, to merge with a cell to the right:
18
- *
19
- * ```ts
20
- * editor.execute( 'mergeTableCellRight' );
21
- * ```
22
- *
23
- * **Note**: If a table cell has a different [`rowspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-rowspan)
24
- * (for `'mergeTableCellRight'` and `'mergeTableCellLeft'`) or [`colspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-colspan)
25
- * (for `'mergeTableCellUp'` and `'mergeTableCellDown'`), the command will be disabled.
26
- */
27
- export default class MergeCellCommand extends Command {
28
- /**
29
- * Creates a new `MergeCellCommand` instance.
30
- *
31
- * @param editor The editor on which this command will be used.
32
- * @param options.direction Indicates which cell to merge with the currently selected one.
33
- * Possible values are: `'left'`, `'right'`, `'up'` and `'down'`.
34
- */
35
- constructor(editor, options) {
36
- super(editor);
37
- this.direction = options.direction;
38
- this.isHorizontal = this.direction == 'right' || this.direction == 'left';
39
- }
40
- /**
41
- * @inheritDoc
42
- */
43
- refresh() {
44
- const cellToMerge = this._getMergeableCell();
45
- this.value = cellToMerge;
46
- this.isEnabled = !!cellToMerge;
47
- }
48
- /**
49
- * Executes the command.
50
- *
51
- * Depending on the command's {@link #direction} value, it will merge the cell that is to the `'left'`, `'right'`, `'up'` or `'down'`.
52
- *
53
- * @fires execute
54
- */
55
- execute() {
56
- const model = this.editor.model;
57
- const doc = model.document;
58
- const tableUtils = this.editor.plugins.get('TableUtils');
59
- const tableCell = tableUtils.getTableCellsContainingSelection(doc.selection)[0];
60
- const cellToMerge = this.value;
61
- const direction = this.direction;
62
- model.change(writer => {
63
- const isMergeNext = direction == 'right' || direction == 'down';
64
- // The merge mechanism is always the same so sort cells to be merged.
65
- const cellToExpand = (isMergeNext ? tableCell : cellToMerge);
66
- const cellToRemove = (isMergeNext ? cellToMerge : tableCell);
67
- // Cache the parent of cell to remove for later check.
68
- const removedTableCellRow = cellToRemove.parent;
69
- mergeTableCells(cellToRemove, cellToExpand, writer);
70
- const spanAttribute = this.isHorizontal ? 'colspan' : 'rowspan';
71
- const cellSpan = parseInt(tableCell.getAttribute(spanAttribute) || '1');
72
- const cellToMergeSpan = parseInt(cellToMerge.getAttribute(spanAttribute) || '1');
73
- // Update table cell span attribute and merge set selection on merged contents.
74
- writer.setAttribute(spanAttribute, cellSpan + cellToMergeSpan, cellToExpand);
75
- writer.setSelection(writer.createRangeIn(cellToExpand));
76
- const tableUtils = this.editor.plugins.get('TableUtils');
77
- const table = removedTableCellRow.findAncestor('table');
78
- // Remove empty rows and columns after merging.
79
- removeEmptyRowsColumns(table, tableUtils);
80
- });
81
- }
82
- /**
83
- * Returns a cell that can be merged with the current cell depending on the command's direction.
84
- */
85
- _getMergeableCell() {
86
- const model = this.editor.model;
87
- const doc = model.document;
88
- const tableUtils = this.editor.plugins.get('TableUtils');
89
- const tableCell = tableUtils.getTableCellsContainingSelection(doc.selection)[0];
90
- if (!tableCell) {
91
- return;
92
- }
93
- // First get the cell on proper direction.
94
- const cellToMerge = this.isHorizontal ?
95
- getHorizontalCell(tableCell, this.direction, tableUtils) :
96
- getVerticalCell(tableCell, this.direction, tableUtils);
97
- if (!cellToMerge) {
98
- return;
99
- }
100
- // If found check if the span perpendicular to merge direction is equal on both cells.
101
- const spanAttribute = this.isHorizontal ? 'rowspan' : 'colspan';
102
- const span = parseInt(tableCell.getAttribute(spanAttribute) || '1');
103
- const cellToMergeSpan = parseInt(cellToMerge.getAttribute(spanAttribute) || '1');
104
- if (cellToMergeSpan === span) {
105
- return cellToMerge;
106
- }
107
- }
108
- }
109
- /**
110
- * Returns the cell that can be merged horizontally.
111
- */
112
- function getHorizontalCell(tableCell, direction, tableUtils) {
113
- const tableRow = tableCell.parent;
114
- const table = tableRow.parent;
115
- const horizontalCell = direction == 'right' ? tableCell.nextSibling : tableCell.previousSibling;
116
- const hasHeadingColumns = (table.getAttribute('headingColumns') || 0) > 0;
117
- if (!horizontalCell) {
118
- return;
119
- }
120
- // Sort cells:
121
- const cellOnLeft = (direction == 'right' ? tableCell : horizontalCell);
122
- const cellOnRight = (direction == 'right' ? horizontalCell : tableCell);
123
- // Get their column indexes:
124
- const { column: leftCellColumn } = tableUtils.getCellLocation(cellOnLeft);
125
- const { column: rightCellColumn } = tableUtils.getCellLocation(cellOnRight);
126
- const leftCellSpan = parseInt(cellOnLeft.getAttribute('colspan') || '1');
127
- const isCellOnLeftInHeadingColumn = isHeadingColumnCell(tableUtils, cellOnLeft);
128
- const isCellOnRightInHeadingColumn = isHeadingColumnCell(tableUtils, cellOnRight);
129
- // We cannot merge heading columns cells with regular cells.
130
- if (hasHeadingColumns && isCellOnLeftInHeadingColumn != isCellOnRightInHeadingColumn) {
131
- return;
132
- }
133
- // The cell on the right must have index that is distant to the cell on the left by the left cell's width (colspan).
134
- const cellsAreTouching = leftCellColumn + leftCellSpan === rightCellColumn;
135
- // If the right cell's column index is different it means that there are rowspanned cells between them.
136
- return cellsAreTouching ? horizontalCell : undefined;
137
- }
138
- /**
139
- * Returns the cell that can be merged vertically.
140
- */
141
- function getVerticalCell(tableCell, direction, tableUtils) {
142
- const tableRow = tableCell.parent;
143
- const table = tableRow.parent;
144
- const rowIndex = table.getChildIndex(tableRow);
145
- // Don't search for mergeable cell if direction points out of the table.
146
- if ((direction == 'down' && rowIndex === tableUtils.getRows(table) - 1) || (direction == 'up' && rowIndex === 0)) {
147
- return null;
148
- }
149
- const rowspan = parseInt(tableCell.getAttribute('rowspan') || '1');
150
- const headingRows = table.getAttribute('headingRows') || 0;
151
- const isMergeWithBodyCell = direction == 'down' && (rowIndex + rowspan) === headingRows;
152
- const isMergeWithHeadCell = direction == 'up' && rowIndex === headingRows;
153
- // Don't search for mergeable cell if direction points out of the current table section.
154
- if (headingRows && (isMergeWithBodyCell || isMergeWithHeadCell)) {
155
- return null;
156
- }
157
- const currentCellRowSpan = parseInt(tableCell.getAttribute('rowspan') || '1');
158
- const rowOfCellToMerge = direction == 'down' ? rowIndex + currentCellRowSpan : rowIndex;
159
- const tableMap = [...new TableWalker(table, { endRow: rowOfCellToMerge })];
160
- const currentCellData = tableMap.find(value => value.cell === tableCell);
161
- const mergeColumn = currentCellData.column;
162
- const cellToMergeData = tableMap.find(({ row, cellHeight, column }) => {
163
- if (column !== mergeColumn) {
164
- return false;
165
- }
166
- if (direction == 'down') {
167
- // If merging a cell below the mergeRow is already calculated.
168
- return row === rowOfCellToMerge;
169
- }
170
- else {
171
- // If merging a cell above calculate if it spans to mergeRow.
172
- return rowOfCellToMerge === row + cellHeight;
173
- }
174
- });
175
- return cellToMergeData && cellToMergeData.cell ? cellToMergeData.cell : null;
176
- }
177
- /**
178
- * Merges two table cells. It will ensure that after merging cells with an empty paragraph, the resulting table cell will only have one
179
- * paragraph. If one of the merged table cells is empty, the merged table cell will have the contents of the non-empty table cell.
180
- * If both are empty, the merged table cell will have only one empty paragraph.
181
- */
182
- function mergeTableCells(cellToRemove, cellToExpand, writer) {
183
- if (!isEmpty(cellToRemove)) {
184
- if (isEmpty(cellToExpand)) {
185
- writer.remove(writer.createRangeIn(cellToExpand));
186
- }
187
- writer.move(writer.createRangeIn(cellToRemove), writer.createPositionAt(cellToExpand, 'end'));
188
- }
189
- // Remove merged table cell.
190
- writer.remove(cellToRemove);
191
- }
192
- /**
193
- * Checks if the passed table cell contains an empty paragraph.
194
- */
195
- function isEmpty(tableCell) {
196
- const firstTableChild = tableCell.getChild(0);
197
- return tableCell.childCount == 1 && firstTableChild.is('element', 'paragraph') && firstTableChild.isEmpty;
198
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import { Command } from 'ckeditor5/src/core';
6
+ import TableWalker from '../tablewalker';
7
+ import { isHeadingColumnCell } from '../utils/common';
8
+ import { removeEmptyRowsColumns } from '../utils/structure';
9
+ /**
10
+ * The merge cell command.
11
+ *
12
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCellRight'`, `'mergeTableCellLeft'`,
13
+ * `'mergeTableCellUp'` and `'mergeTableCellDown'` editor commands.
14
+ *
15
+ * To merge a table cell at the current selection with another cell, execute the command corresponding with the preferred direction.
16
+ *
17
+ * For example, to merge with a cell to the right:
18
+ *
19
+ * ```ts
20
+ * editor.execute( 'mergeTableCellRight' );
21
+ * ```
22
+ *
23
+ * **Note**: If a table cell has a different [`rowspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-rowspan)
24
+ * (for `'mergeTableCellRight'` and `'mergeTableCellLeft'`) or [`colspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-colspan)
25
+ * (for `'mergeTableCellUp'` and `'mergeTableCellDown'`), the command will be disabled.
26
+ */
27
+ export default class MergeCellCommand extends Command {
28
+ /**
29
+ * Creates a new `MergeCellCommand` instance.
30
+ *
31
+ * @param editor The editor on which this command will be used.
32
+ * @param options.direction Indicates which cell to merge with the currently selected one.
33
+ * Possible values are: `'left'`, `'right'`, `'up'` and `'down'`.
34
+ */
35
+ constructor(editor, options) {
36
+ super(editor);
37
+ this.direction = options.direction;
38
+ this.isHorizontal = this.direction == 'right' || this.direction == 'left';
39
+ }
40
+ /**
41
+ * @inheritDoc
42
+ */
43
+ refresh() {
44
+ const cellToMerge = this._getMergeableCell();
45
+ this.value = cellToMerge;
46
+ this.isEnabled = !!cellToMerge;
47
+ }
48
+ /**
49
+ * Executes the command.
50
+ *
51
+ * Depending on the command's {@link #direction} value, it will merge the cell that is to the `'left'`, `'right'`, `'up'` or `'down'`.
52
+ *
53
+ * @fires execute
54
+ */
55
+ execute() {
56
+ const model = this.editor.model;
57
+ const doc = model.document;
58
+ const tableUtils = this.editor.plugins.get('TableUtils');
59
+ const tableCell = tableUtils.getTableCellsContainingSelection(doc.selection)[0];
60
+ const cellToMerge = this.value;
61
+ const direction = this.direction;
62
+ model.change(writer => {
63
+ const isMergeNext = direction == 'right' || direction == 'down';
64
+ // The merge mechanism is always the same so sort cells to be merged.
65
+ const cellToExpand = (isMergeNext ? tableCell : cellToMerge);
66
+ const cellToRemove = (isMergeNext ? cellToMerge : tableCell);
67
+ // Cache the parent of cell to remove for later check.
68
+ const removedTableCellRow = cellToRemove.parent;
69
+ mergeTableCells(cellToRemove, cellToExpand, writer);
70
+ const spanAttribute = this.isHorizontal ? 'colspan' : 'rowspan';
71
+ const cellSpan = parseInt(tableCell.getAttribute(spanAttribute) || '1');
72
+ const cellToMergeSpan = parseInt(cellToMerge.getAttribute(spanAttribute) || '1');
73
+ // Update table cell span attribute and merge set selection on merged contents.
74
+ writer.setAttribute(spanAttribute, cellSpan + cellToMergeSpan, cellToExpand);
75
+ writer.setSelection(writer.createRangeIn(cellToExpand));
76
+ const tableUtils = this.editor.plugins.get('TableUtils');
77
+ const table = removedTableCellRow.findAncestor('table');
78
+ // Remove empty rows and columns after merging.
79
+ removeEmptyRowsColumns(table, tableUtils);
80
+ });
81
+ }
82
+ /**
83
+ * Returns a cell that can be merged with the current cell depending on the command's direction.
84
+ */
85
+ _getMergeableCell() {
86
+ const model = this.editor.model;
87
+ const doc = model.document;
88
+ const tableUtils = this.editor.plugins.get('TableUtils');
89
+ const tableCell = tableUtils.getTableCellsContainingSelection(doc.selection)[0];
90
+ if (!tableCell) {
91
+ return;
92
+ }
93
+ // First get the cell on proper direction.
94
+ const cellToMerge = this.isHorizontal ?
95
+ getHorizontalCell(tableCell, this.direction, tableUtils) :
96
+ getVerticalCell(tableCell, this.direction, tableUtils);
97
+ if (!cellToMerge) {
98
+ return;
99
+ }
100
+ // If found check if the span perpendicular to merge direction is equal on both cells.
101
+ const spanAttribute = this.isHorizontal ? 'rowspan' : 'colspan';
102
+ const span = parseInt(tableCell.getAttribute(spanAttribute) || '1');
103
+ const cellToMergeSpan = parseInt(cellToMerge.getAttribute(spanAttribute) || '1');
104
+ if (cellToMergeSpan === span) {
105
+ return cellToMerge;
106
+ }
107
+ }
108
+ }
109
+ /**
110
+ * Returns the cell that can be merged horizontally.
111
+ */
112
+ function getHorizontalCell(tableCell, direction, tableUtils) {
113
+ const tableRow = tableCell.parent;
114
+ const table = tableRow.parent;
115
+ const horizontalCell = direction == 'right' ? tableCell.nextSibling : tableCell.previousSibling;
116
+ const hasHeadingColumns = (table.getAttribute('headingColumns') || 0) > 0;
117
+ if (!horizontalCell) {
118
+ return;
119
+ }
120
+ // Sort cells:
121
+ const cellOnLeft = (direction == 'right' ? tableCell : horizontalCell);
122
+ const cellOnRight = (direction == 'right' ? horizontalCell : tableCell);
123
+ // Get their column indexes:
124
+ const { column: leftCellColumn } = tableUtils.getCellLocation(cellOnLeft);
125
+ const { column: rightCellColumn } = tableUtils.getCellLocation(cellOnRight);
126
+ const leftCellSpan = parseInt(cellOnLeft.getAttribute('colspan') || '1');
127
+ const isCellOnLeftInHeadingColumn = isHeadingColumnCell(tableUtils, cellOnLeft);
128
+ const isCellOnRightInHeadingColumn = isHeadingColumnCell(tableUtils, cellOnRight);
129
+ // We cannot merge heading columns cells with regular cells.
130
+ if (hasHeadingColumns && isCellOnLeftInHeadingColumn != isCellOnRightInHeadingColumn) {
131
+ return;
132
+ }
133
+ // The cell on the right must have index that is distant to the cell on the left by the left cell's width (colspan).
134
+ const cellsAreTouching = leftCellColumn + leftCellSpan === rightCellColumn;
135
+ // If the right cell's column index is different it means that there are rowspanned cells between them.
136
+ return cellsAreTouching ? horizontalCell : undefined;
137
+ }
138
+ /**
139
+ * Returns the cell that can be merged vertically.
140
+ */
141
+ function getVerticalCell(tableCell, direction, tableUtils) {
142
+ const tableRow = tableCell.parent;
143
+ const table = tableRow.parent;
144
+ const rowIndex = table.getChildIndex(tableRow);
145
+ // Don't search for mergeable cell if direction points out of the table.
146
+ if ((direction == 'down' && rowIndex === tableUtils.getRows(table) - 1) || (direction == 'up' && rowIndex === 0)) {
147
+ return null;
148
+ }
149
+ const rowspan = parseInt(tableCell.getAttribute('rowspan') || '1');
150
+ const headingRows = table.getAttribute('headingRows') || 0;
151
+ const isMergeWithBodyCell = direction == 'down' && (rowIndex + rowspan) === headingRows;
152
+ const isMergeWithHeadCell = direction == 'up' && rowIndex === headingRows;
153
+ // Don't search for mergeable cell if direction points out of the current table section.
154
+ if (headingRows && (isMergeWithBodyCell || isMergeWithHeadCell)) {
155
+ return null;
156
+ }
157
+ const currentCellRowSpan = parseInt(tableCell.getAttribute('rowspan') || '1');
158
+ const rowOfCellToMerge = direction == 'down' ? rowIndex + currentCellRowSpan : rowIndex;
159
+ const tableMap = [...new TableWalker(table, { endRow: rowOfCellToMerge })];
160
+ const currentCellData = tableMap.find(value => value.cell === tableCell);
161
+ const mergeColumn = currentCellData.column;
162
+ const cellToMergeData = tableMap.find(({ row, cellHeight, column }) => {
163
+ if (column !== mergeColumn) {
164
+ return false;
165
+ }
166
+ if (direction == 'down') {
167
+ // If merging a cell below the mergeRow is already calculated.
168
+ return row === rowOfCellToMerge;
169
+ }
170
+ else {
171
+ // If merging a cell above calculate if it spans to mergeRow.
172
+ return rowOfCellToMerge === row + cellHeight;
173
+ }
174
+ });
175
+ return cellToMergeData && cellToMergeData.cell ? cellToMergeData.cell : null;
176
+ }
177
+ /**
178
+ * Merges two table cells. It will ensure that after merging cells with an empty paragraph, the resulting table cell will only have one
179
+ * paragraph. If one of the merged table cells is empty, the merged table cell will have the contents of the non-empty table cell.
180
+ * If both are empty, the merged table cell will have only one empty paragraph.
181
+ */
182
+ function mergeTableCells(cellToRemove, cellToExpand, writer) {
183
+ if (!isEmpty(cellToRemove)) {
184
+ if (isEmpty(cellToExpand)) {
185
+ writer.remove(writer.createRangeIn(cellToExpand));
186
+ }
187
+ writer.move(writer.createRangeIn(cellToRemove), writer.createPositionAt(cellToExpand, 'end'));
188
+ }
189
+ // Remove merged table cell.
190
+ writer.remove(cellToRemove);
191
+ }
192
+ /**
193
+ * Checks if the passed table cell contains an empty paragraph.
194
+ */
195
+ function isEmpty(tableCell) {
196
+ const firstTableChild = tableCell.getChild(0);
197
+ return tableCell.childCount == 1 && firstTableChild.is('element', 'paragraph') && firstTableChild.isEmpty;
198
+ }
@@ -1,28 +1,28 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import { Command } from 'ckeditor5/src/core';
6
- /**
7
- * The merge cells command.
8
- *
9
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCells'` editor command.
10
- *
11
- * For example, to merge selected table cells:
12
- *
13
- * ```ts
14
- * editor.execute( 'mergeTableCells' );
15
- * ```
16
- */
17
- export default class MergeCellsCommand extends Command {
18
- /**
19
- * @inheritDoc
20
- */
21
- refresh(): void;
22
- /**
23
- * Executes the command.
24
- *
25
- * @fires execute
26
- */
27
- execute(): void;
28
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import { Command } from 'ckeditor5/src/core';
6
+ /**
7
+ * The merge cells command.
8
+ *
9
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCells'` editor command.
10
+ *
11
+ * For example, to merge selected table cells:
12
+ *
13
+ * ```ts
14
+ * editor.execute( 'mergeTableCells' );
15
+ * ```
16
+ */
17
+ export default class MergeCellsCommand extends Command {
18
+ /**
19
+ * @inheritDoc
20
+ */
21
+ refresh(): void;
22
+ /**
23
+ * Executes the command.
24
+ *
25
+ * @fires execute
26
+ */
27
+ execute(): void;
28
+ }
@@ -1,94 +1,94 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import { Command } from 'ckeditor5/src/core';
6
- import TableUtils from '../tableutils';
7
- import { updateNumericAttribute } from '../utils/common';
8
- import { removeEmptyRowsColumns } from '../utils/structure';
9
- /**
10
- * The merge cells command.
11
- *
12
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCells'` editor command.
13
- *
14
- * For example, to merge selected table cells:
15
- *
16
- * ```ts
17
- * editor.execute( 'mergeTableCells' );
18
- * ```
19
- */
20
- export default class MergeCellsCommand extends Command {
21
- /**
22
- * @inheritDoc
23
- */
24
- refresh() {
25
- const tableUtils = this.editor.plugins.get(TableUtils);
26
- const selectedTableCells = tableUtils.getSelectedTableCells(this.editor.model.document.selection);
27
- this.isEnabled = tableUtils.isSelectionRectangular(selectedTableCells);
28
- }
29
- /**
30
- * Executes the command.
31
- *
32
- * @fires execute
33
- */
34
- execute() {
35
- const model = this.editor.model;
36
- const tableUtils = this.editor.plugins.get(TableUtils);
37
- model.change(writer => {
38
- const selectedTableCells = tableUtils.getSelectedTableCells(model.document.selection);
39
- // All cells will be merged into the first one.
40
- const firstTableCell = selectedTableCells.shift();
41
- // Update target cell dimensions.
42
- const { mergeWidth, mergeHeight } = getMergeDimensions(firstTableCell, selectedTableCells, tableUtils);
43
- updateNumericAttribute('colspan', mergeWidth, firstTableCell, writer);
44
- updateNumericAttribute('rowspan', mergeHeight, firstTableCell, writer);
45
- for (const tableCell of selectedTableCells) {
46
- mergeTableCells(tableCell, firstTableCell, writer);
47
- }
48
- const table = firstTableCell.findAncestor('table');
49
- // Remove rows and columns that become empty (have no anchored cells).
50
- removeEmptyRowsColumns(table, tableUtils);
51
- writer.setSelection(firstTableCell, 'in');
52
- });
53
- }
54
- }
55
- /**
56
- * Merges two table cells. It will ensure that after merging cells with empty paragraphs the resulting table cell will only have one
57
- * paragraph. If one of the merged table cells is empty, the merged table cell will have contents of the non-empty table cell.
58
- * If both are empty, the merged table cell will have only one empty paragraph.
59
- */
60
- function mergeTableCells(cellBeingMerged, targetCell, writer) {
61
- if (!isEmpty(cellBeingMerged)) {
62
- if (isEmpty(targetCell)) {
63
- writer.remove(writer.createRangeIn(targetCell));
64
- }
65
- writer.move(writer.createRangeIn(cellBeingMerged), writer.createPositionAt(targetCell, 'end'));
66
- }
67
- // Remove merged table cell.
68
- writer.remove(cellBeingMerged);
69
- }
70
- /**
71
- * Checks if the passed table cell contains an empty paragraph.
72
- */
73
- function isEmpty(tableCell) {
74
- const firstTableChild = tableCell.getChild(0);
75
- return tableCell.childCount == 1 && firstTableChild.is('element', 'paragraph') && firstTableChild.isEmpty;
76
- }
77
- function getMergeDimensions(firstTableCell, selectedTableCells, tableUtils) {
78
- let maxWidthOffset = 0;
79
- let maxHeightOffset = 0;
80
- for (const tableCell of selectedTableCells) {
81
- const { row, column } = tableUtils.getCellLocation(tableCell);
82
- maxWidthOffset = getMaxOffset(tableCell, column, maxWidthOffset, 'colspan');
83
- maxHeightOffset = getMaxOffset(tableCell, row, maxHeightOffset, 'rowspan');
84
- }
85
- // Update table cell span attribute and merge set selection on a merged contents.
86
- const { row: firstCellRow, column: firstCellColumn } = tableUtils.getCellLocation(firstTableCell);
87
- const mergeWidth = maxWidthOffset - firstCellColumn;
88
- const mergeHeight = maxHeightOffset - firstCellRow;
89
- return { mergeWidth, mergeHeight };
90
- }
91
- function getMaxOffset(tableCell, start, currentMaxOffset, which) {
92
- const dimensionValue = parseInt(tableCell.getAttribute(which) || '1');
93
- return Math.max(currentMaxOffset, start + dimensionValue);
94
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import { Command } from 'ckeditor5/src/core';
6
+ import TableUtils from '../tableutils';
7
+ import { updateNumericAttribute } from '../utils/common';
8
+ import { removeEmptyRowsColumns } from '../utils/structure';
9
+ /**
10
+ * The merge cells command.
11
+ *
12
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCells'` editor command.
13
+ *
14
+ * For example, to merge selected table cells:
15
+ *
16
+ * ```ts
17
+ * editor.execute( 'mergeTableCells' );
18
+ * ```
19
+ */
20
+ export default class MergeCellsCommand extends Command {
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ refresh() {
25
+ const tableUtils = this.editor.plugins.get(TableUtils);
26
+ const selectedTableCells = tableUtils.getSelectedTableCells(this.editor.model.document.selection);
27
+ this.isEnabled = tableUtils.isSelectionRectangular(selectedTableCells);
28
+ }
29
+ /**
30
+ * Executes the command.
31
+ *
32
+ * @fires execute
33
+ */
34
+ execute() {
35
+ const model = this.editor.model;
36
+ const tableUtils = this.editor.plugins.get(TableUtils);
37
+ model.change(writer => {
38
+ const selectedTableCells = tableUtils.getSelectedTableCells(model.document.selection);
39
+ // All cells will be merged into the first one.
40
+ const firstTableCell = selectedTableCells.shift();
41
+ // Update target cell dimensions.
42
+ const { mergeWidth, mergeHeight } = getMergeDimensions(firstTableCell, selectedTableCells, tableUtils);
43
+ updateNumericAttribute('colspan', mergeWidth, firstTableCell, writer);
44
+ updateNumericAttribute('rowspan', mergeHeight, firstTableCell, writer);
45
+ for (const tableCell of selectedTableCells) {
46
+ mergeTableCells(tableCell, firstTableCell, writer);
47
+ }
48
+ const table = firstTableCell.findAncestor('table');
49
+ // Remove rows and columns that become empty (have no anchored cells).
50
+ removeEmptyRowsColumns(table, tableUtils);
51
+ writer.setSelection(firstTableCell, 'in');
52
+ });
53
+ }
54
+ }
55
+ /**
56
+ * Merges two table cells. It will ensure that after merging cells with empty paragraphs the resulting table cell will only have one
57
+ * paragraph. If one of the merged table cells is empty, the merged table cell will have contents of the non-empty table cell.
58
+ * If both are empty, the merged table cell will have only one empty paragraph.
59
+ */
60
+ function mergeTableCells(cellBeingMerged, targetCell, writer) {
61
+ if (!isEmpty(cellBeingMerged)) {
62
+ if (isEmpty(targetCell)) {
63
+ writer.remove(writer.createRangeIn(targetCell));
64
+ }
65
+ writer.move(writer.createRangeIn(cellBeingMerged), writer.createPositionAt(targetCell, 'end'));
66
+ }
67
+ // Remove merged table cell.
68
+ writer.remove(cellBeingMerged);
69
+ }
70
+ /**
71
+ * Checks if the passed table cell contains an empty paragraph.
72
+ */
73
+ function isEmpty(tableCell) {
74
+ const firstTableChild = tableCell.getChild(0);
75
+ return tableCell.childCount == 1 && firstTableChild.is('element', 'paragraph') && firstTableChild.isEmpty;
76
+ }
77
+ function getMergeDimensions(firstTableCell, selectedTableCells, tableUtils) {
78
+ let maxWidthOffset = 0;
79
+ let maxHeightOffset = 0;
80
+ for (const tableCell of selectedTableCells) {
81
+ const { row, column } = tableUtils.getCellLocation(tableCell);
82
+ maxWidthOffset = getMaxOffset(tableCell, column, maxWidthOffset, 'colspan');
83
+ maxHeightOffset = getMaxOffset(tableCell, row, maxHeightOffset, 'rowspan');
84
+ }
85
+ // Update table cell span attribute and merge set selection on a merged contents.
86
+ const { row: firstCellRow, column: firstCellColumn } = tableUtils.getCellLocation(firstTableCell);
87
+ const mergeWidth = maxWidthOffset - firstCellColumn;
88
+ const mergeHeight = maxHeightOffset - firstCellRow;
89
+ return { mergeWidth, mergeHeight };
90
+ }
91
+ function getMaxOffset(tableCell, start, currentMaxOffset, which) {
92
+ const dimensionValue = parseInt(tableCell.getAttribute(which) || '1');
93
+ return Math.max(currentMaxOffset, start + dimensionValue);
94
+ }