@ckeditor/ckeditor5-table 38.1.0 → 38.1.1

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 (167) hide show
  1. package/build/table.js +1 -1
  2. package/build/table.js.map +1 -0
  3. package/package.json +2 -2
  4. package/src/augmentation.d.ts +76 -76
  5. package/src/augmentation.js +5 -5
  6. package/src/commands/insertcolumncommand.d.ts +55 -55
  7. package/src/commands/insertcolumncommand.js +67 -67
  8. package/src/commands/insertrowcommand.d.ts +54 -54
  9. package/src/commands/insertrowcommand.js +66 -66
  10. package/src/commands/inserttablecommand.d.ts +44 -44
  11. package/src/commands/inserttablecommand.js +69 -69
  12. package/src/commands/mergecellcommand.d.ts +68 -68
  13. package/src/commands/mergecellcommand.js +198 -198
  14. package/src/commands/mergecellscommand.d.ts +28 -28
  15. package/src/commands/mergecellscommand.js +94 -94
  16. package/src/commands/removecolumncommand.d.ts +29 -29
  17. package/src/commands/removecolumncommand.js +109 -109
  18. package/src/commands/removerowcommand.d.ts +29 -29
  19. package/src/commands/removerowcommand.js +82 -82
  20. package/src/commands/selectcolumncommand.d.ts +33 -33
  21. package/src/commands/selectcolumncommand.js +60 -60
  22. package/src/commands/selectrowcommand.d.ts +33 -33
  23. package/src/commands/selectrowcommand.js +56 -56
  24. package/src/commands/setheadercolumncommand.d.ts +50 -50
  25. package/src/commands/setheadercolumncommand.js +71 -71
  26. package/src/commands/setheaderrowcommand.d.ts +53 -53
  27. package/src/commands/setheaderrowcommand.js +79 -79
  28. package/src/commands/splitcellcommand.d.ts +43 -43
  29. package/src/commands/splitcellcommand.js +54 -54
  30. package/src/converters/downcast.d.ts +63 -63
  31. package/src/converters/downcast.js +146 -146
  32. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  33. package/src/converters/table-caption-post-fixer.js +53 -53
  34. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  35. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  36. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  37. package/src/converters/table-cell-refresh-handler.js +45 -45
  38. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  39. package/src/converters/table-headings-refresh-handler.js +49 -49
  40. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  41. package/src/converters/table-layout-post-fixer.js +367 -367
  42. package/src/converters/tableproperties.d.ts +54 -54
  43. package/src/converters/tableproperties.js +159 -159
  44. package/src/converters/upcasttable.d.ts +49 -49
  45. package/src/converters/upcasttable.js +243 -243
  46. package/src/index.d.ts +60 -60
  47. package/src/index.js +30 -30
  48. package/src/plaintableoutput.d.ts +26 -26
  49. package/src/plaintableoutput.js +123 -123
  50. package/src/table.d.ts +40 -40
  51. package/src/table.js +44 -44
  52. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  53. package/src/tablecaption/tablecaptionediting.js +122 -122
  54. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  55. package/src/tablecaption/tablecaptionui.js +57 -57
  56. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  57. package/src/tablecaption/toggletablecaptioncommand.js +104 -104
  58. package/src/tablecaption/utils.d.ts +42 -42
  59. package/src/tablecaption/utils.js +67 -67
  60. package/src/tablecaption.d.ts +24 -24
  61. package/src/tablecaption.js +28 -28
  62. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  63. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  64. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  65. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  66. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  67. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  68. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  69. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  70. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  71. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  72. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  73. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  74. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  75. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  76. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  77. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  78. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  79. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  80. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  81. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  82. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  83. package/src/tablecellproperties/tablecellpropertiesui.js +328 -328
  84. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +227 -227
  85. package/src/tablecellproperties/ui/tablecellpropertiesview.js +537 -537
  86. package/src/tablecellproperties.d.ts +30 -30
  87. package/src/tablecellproperties.js +34 -34
  88. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  89. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  90. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  91. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  92. package/src/tableclipboard.d.ts +65 -65
  93. package/src/tableclipboard.js +450 -450
  94. package/src/tablecolumnresize/constants.d.ts +20 -20
  95. package/src/tablecolumnresize/constants.js +20 -20
  96. package/src/tablecolumnresize/converters.d.ts +18 -18
  97. package/src/tablecolumnresize/converters.js +45 -45
  98. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  99. package/src/tablecolumnresize/tablecolumnresizeediting.js +571 -571
  100. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  101. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  102. package/src/tablecolumnresize/utils.d.ts +141 -141
  103. package/src/tablecolumnresize/utils.js +330 -330
  104. package/src/tablecolumnresize.d.ts +26 -26
  105. package/src/tablecolumnresize.js +30 -30
  106. package/src/tableconfig.d.ts +331 -331
  107. package/src/tableconfig.js +5 -5
  108. package/src/tableediting.d.ts +98 -98
  109. package/src/tableediting.js +191 -191
  110. package/src/tablekeyboard.d.ts +68 -68
  111. package/src/tablekeyboard.js +279 -279
  112. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  113. package/src/tablemouse/mouseeventsobserver.js +35 -35
  114. package/src/tablemouse.d.ts +48 -48
  115. package/src/tablemouse.js +172 -172
  116. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  117. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  118. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  119. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  120. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  121. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  122. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  123. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  124. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  125. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  126. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  127. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  128. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  129. package/src/tableproperties/commands/tablepropertycommand.js +80 -80
  130. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  131. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  132. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  133. package/src/tableproperties/tablepropertiesediting.js +206 -206
  134. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  135. package/src/tableproperties/tablepropertiesui.js +319 -319
  136. package/src/tableproperties/ui/tablepropertiesview.d.ts +203 -203
  137. package/src/tableproperties/ui/tablepropertiesview.js +455 -455
  138. package/src/tableproperties.d.ts +30 -30
  139. package/src/tableproperties.js +34 -34
  140. package/src/tableselection.d.ts +107 -107
  141. package/src/tableselection.js +297 -297
  142. package/src/tabletoolbar.d.ts +32 -32
  143. package/src/tabletoolbar.js +57 -57
  144. package/src/tableui.d.ts +53 -53
  145. package/src/tableui.js +309 -309
  146. package/src/tableutils.d.ts +448 -448
  147. package/src/tableutils.js +1041 -1041
  148. package/src/tablewalker.d.ts +323 -323
  149. package/src/tablewalker.js +333 -333
  150. package/src/ui/colorinputview.d.ts +143 -143
  151. package/src/ui/colorinputview.js +248 -248
  152. package/src/ui/formrowview.d.ts +61 -61
  153. package/src/ui/formrowview.js +57 -57
  154. package/src/ui/inserttableview.d.ts +77 -77
  155. package/src/ui/inserttableview.js +169 -169
  156. package/src/utils/common.d.ts +42 -42
  157. package/src/utils/common.js +57 -57
  158. package/src/utils/structure.d.ts +245 -245
  159. package/src/utils/structure.js +426 -426
  160. package/src/utils/table-properties.d.ts +67 -67
  161. package/src/utils/table-properties.js +86 -86
  162. package/src/utils/ui/contextualballoon.d.ts +34 -34
  163. package/src/utils/ui/contextualballoon.js +106 -106
  164. package/src/utils/ui/table-properties.d.ts +193 -193
  165. package/src/utils/ui/table-properties.js +360 -360
  166. package/src/utils/ui/widget.d.ts +16 -16
  167. package/src/utils/ui/widget.js +38 -38
@@ -1,367 +1,367 @@
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 TableWalker from './../tablewalker';
6
- import { createEmptyTableCell, updateNumericAttribute } from '../utils/common';
7
- /**
8
- * Injects a table layout post-fixer into the model.
9
- *
10
- * The role of the table layout post-fixer is to ensure that the table rows have the correct structure
11
- * after a {@link module:engine/model/model~Model#change `change()`} block was executed.
12
- *
13
- * The correct structure means that:
14
- *
15
- * * All table rows have the same size.
16
- * * None of the table cells extend vertically beyond their section (either header or body).
17
- * * A table cell has always at least one element as a child.
18
- *
19
- * If the table structure is not correct, the post-fixer will automatically correct it in two steps:
20
- *
21
- * 1. It will clip table cells that extend beyond their section.
22
- * 2. It will add empty table cells to the rows that are narrower than the widest table row.
23
- *
24
- * ## Clipping overlapping table cells
25
- *
26
- * Such situation may occur when pasting a table (or a part of a table) to the editor from external sources.
27
- *
28
- * For example, see the following table which has a cell (FOO) with the rowspan attribute (2):
29
- *
30
- * ```xml
31
- * <table headingRows="1">
32
- * <tableRow>
33
- * <tableCell rowspan="2"><paragraph>FOO</paragraph></tableCell>
34
- * <tableCell colspan="2"><paragraph>BAR</paragraph></tableCell>
35
- * </tableRow>
36
- * <tableRow>
37
- * <tableCell><paragraph>BAZ</paragraph></tableCell>
38
- * <tableCell><paragraph>XYZ</paragraph></tableCell>
39
- * </tableRow>
40
- * </table>
41
- * ```
42
- *
43
- * It will be rendered in the view as:
44
- *
45
- * ```xml
46
- * <table>
47
- * <thead>
48
- * <tr>
49
- * <td rowspan="2">FOO</td>
50
- * <td colspan="2">BAR</td>
51
- * </tr>
52
- * </thead>
53
- * <tbody>
54
- * <tr>
55
- * <td>BAZ</td>
56
- * <td>XYZ</td>
57
- * </tr>
58
- * </tbody>
59
- * </table>
60
- * ```
61
- *
62
- * In the above example the table will be rendered as a table with two rows: one in the header and second one in the body.
63
- * The table cell (FOO) cannot span over multiple rows as it would extend from the header to the body section.
64
- * The `rowspan` attribute must be changed to (1). The value (1) is the default value of the `rowspan` attribute
65
- * so the `rowspan` attribute will be removed from the model.
66
- *
67
- * The table cell with BAZ in the content will be in the first column of the table.
68
- *
69
- * ## Adding missing table cells
70
- *
71
- * The table post-fixer will insert empty table cells to equalize table row sizes (the number of columns).
72
- * The size of a table row is calculated by counting column spans of table cells, both horizontal (from the same row) and
73
- * vertical (from the rows above).
74
- *
75
- * In the above example, the table row in the body section of the table is narrower then the row from the header: it has two cells
76
- * with the default colspan (1). The header row has one cell with colspan (1) and the second with colspan (2).
77
- * The table cell (FOO) does not extend beyond the head section (and as such will be fixed in the first step of this post-fixer).
78
- * The post-fixer will add a missing table cell to the row in the body section of the table.
79
- *
80
- * The table from the above example will be fixed and rendered to the view as below:
81
- *
82
- * ```xml
83
- * <table>
84
- * <thead>
85
- * <tr>
86
- * <td rowspan="2">FOO</td>
87
- * <td colspan="2">BAR</td>
88
- * </tr>
89
- * </thead>
90
- * <tbody>
91
- * <tr>
92
- * <td>BAZ</td>
93
- * <td>XYZ</td>
94
- * </tr>
95
- * </tbody>
96
- * </table>
97
- * ```
98
- *
99
- * ## Collaboration and undo - Expectations vs post-fixer results
100
- *
101
- * The table post-fixer only ensures proper structure without a deeper analysis of the nature of the change. As such, it might lead
102
- * to a structure which was not intended by the user. In particular, it will also fix undo steps (in conjunction with collaboration)
103
- * in which the editor content might not return to the original state.
104
- *
105
- * This will usually happen when one or more users change the size of the table.
106
- *
107
- * As an example see the table below:
108
- *
109
- * ```xml
110
- * <table>
111
- * <tbody>
112
- * <tr>
113
- * <td>11</td>
114
- * <td>12</td>
115
- * </tr>
116
- * <tr>
117
- * <td>21</td>
118
- * <td>22</td>
119
- * </tr>
120
- * </tbody>
121
- * </table>
122
- * ```
123
- *
124
- * and the user actions:
125
- *
126
- * 1. Both users have a table with two rows and two columns.
127
- * 2. User A adds a column at the end of the table. This will insert empty table cells to two rows.
128
- * 3. User B adds a row at the end of the table. This will insert a row with two empty table cells.
129
- * 4. Both users will have a table as below:
130
- *
131
- * ```xml
132
- * <table>
133
- * <tbody>
134
- * <tr>
135
- * <td>11</td>
136
- * <td>12</td>
137
- * <td>(empty, inserted by A)</td>
138
- * </tr>
139
- * <tr>
140
- * <td>21</td>
141
- * <td>22</td>
142
- * <td>(empty, inserted by A)</td>
143
- * </tr>
144
- * <tr>
145
- * <td>(empty, inserted by B)</td>
146
- * <td>(empty, inserted by B)</td>
147
- * </tr>
148
- * </tbody>
149
- * </table>
150
- * ```
151
- *
152
- * The last row is shorter then others so the table post-fixer will add an empty row to the last row:
153
- *
154
- * ```xml
155
- * <table>
156
- * <tbody>
157
- * <tr>
158
- * <td>11</td>
159
- * <td>12</td>
160
- * <td>(empty, inserted by A)</td>
161
- * </tr>
162
- * <tr>
163
- * <td>21</td>
164
- * <td>22</td>
165
- * <td>(empty, inserted by A)</td>
166
- * </tr>
167
- * <tr>
168
- * <td>(empty, inserted by B)</td>
169
- * <td>(empty, inserted by B)</td>
170
- * <td>(empty, inserted by the post-fixer)</td>
171
- * </tr>
172
- * </tbody>
173
- * </table>
174
- * ```
175
- *
176
- * Unfortunately undo does not know the nature of the changes and depending on which user applies the post-fixer changes, undoing them
177
- * might lead to a broken table. If User B undoes inserting the column to the table, the undo engine will undo only the operations of
178
- * inserting empty cells to rows from the initial table state (row 1 and 2) but the cell in the post-fixed row will remain:
179
- *
180
- * ```xml
181
- * <table>
182
- * <tbody>
183
- * <tr>
184
- * <td>11</td>
185
- * <td>12</td>
186
- * </tr>
187
- * <tr>
188
- * <td>21</td>
189
- * <td>22</td>
190
- * </tr>
191
- * <tr>
192
- * <td>(empty, inserted by B)</td>
193
- * <td>(empty, inserted by B)</td>
194
- * <td>(empty, inserted by a post-fixer)</td>
195
- * </tr>
196
- * </tbody>
197
- * </table>
198
- * ```
199
- *
200
- * After undo, the table post-fixer will detect that two rows are shorter than others and will fix the table to:
201
- *
202
- * ```xml
203
- * <table>
204
- * <tbody>
205
- * <tr>
206
- * <td>11</td>
207
- * <td>12</td>
208
- * <td>(empty, inserted by a post-fixer after undo)</td>
209
- * </tr>
210
- * <tr>
211
- * <td>21</td>
212
- * <td>22</td>
213
- * <td>(empty, inserted by a post-fixer after undo)</td>
214
- * </tr>
215
- * <tr>
216
- * <td>(empty, inserted by B)</td>
217
- * <td>(empty, inserted by B)</td>
218
- * <td>(empty, inserted by a post-fixer)</td>
219
- * </tr>
220
- * </tbody>
221
- * </table>
222
- * ```
223
- */
224
- export default function injectTableLayoutPostFixer(model) {
225
- model.document.registerPostFixer(writer => tableLayoutPostFixer(writer, model));
226
- }
227
- /**
228
- * The table layout post-fixer.
229
- */
230
- function tableLayoutPostFixer(writer, model) {
231
- const changes = model.document.differ.getChanges();
232
- let wasFixed = false;
233
- // Do not analyze the same table more then once - may happen for multiple changes in the same table.
234
- const analyzedTables = new Set();
235
- for (const entry of changes) {
236
- let table = null;
237
- if (entry.type == 'insert' && entry.name == 'table') {
238
- table = entry.position.nodeAfter;
239
- }
240
- // Fix table on adding/removing table cells and rows.
241
- if ((entry.type == 'insert' || entry.type == 'remove') && (entry.name == 'tableRow' || entry.name == 'tableCell')) {
242
- table = entry.position.findAncestor('table');
243
- }
244
- // Fix table on any table's attribute change - including attributes of table cells.
245
- if (isTableAttributeEntry(entry)) {
246
- table = entry.range.start.findAncestor('table');
247
- }
248
- if (table && !analyzedTables.has(table)) {
249
- // Step 1: correct rowspans of table cells if necessary.
250
- // The wasFixed flag should be true if any of tables in batch was fixed - might be more then one.
251
- wasFixed = fixTableCellsRowspan(table, writer) || wasFixed;
252
- // Step 2: fix table rows sizes.
253
- wasFixed = fixTableRowsSizes(table, writer) || wasFixed;
254
- analyzedTables.add(table);
255
- }
256
- }
257
- return wasFixed;
258
- }
259
- /**
260
- * Fixes the invalid value of the `rowspan` attribute because a table cell cannot vertically extend beyond the table section it belongs to.
261
- *
262
- * @returns Returns `true` if the table was fixed.
263
- */
264
- function fixTableCellsRowspan(table, writer) {
265
- let wasFixed = false;
266
- const cellsToTrim = findCellsToTrim(table);
267
- if (cellsToTrim.length) {
268
- // @if CK_DEBUG_TABLE // console.log( `Post-fixing table: trimming cells row-spans (${ cellsToTrim.length }).` );
269
- wasFixed = true;
270
- for (const data of cellsToTrim) {
271
- updateNumericAttribute('rowspan', data.rowspan, data.cell, writer, 1);
272
- }
273
- }
274
- return wasFixed;
275
- }
276
- /**
277
- * Makes all table rows in a table the same size.
278
- *
279
- * @returns Returns `true` if the table was fixed.
280
- */
281
- function fixTableRowsSizes(table, writer) {
282
- let wasFixed = false;
283
- const childrenLengths = getChildrenLengths(table);
284
- const rowsToRemove = [];
285
- // Find empty rows.
286
- for (const [rowIndex, size] of childrenLengths.entries()) {
287
- // Ignore all non-row models.
288
- if (!size && table.getChild(rowIndex).is('element', 'tableRow')) {
289
- rowsToRemove.push(rowIndex);
290
- }
291
- }
292
- // Remove empty rows.
293
- if (rowsToRemove.length) {
294
- // @if CK_DEBUG_TABLE // console.log( `Post-fixing table: remove empty rows (${ rowsToRemove.length }).` );
295
- wasFixed = true;
296
- for (const rowIndex of rowsToRemove.reverse()) {
297
- writer.remove(table.getChild(rowIndex));
298
- childrenLengths.splice(rowIndex, 1);
299
- }
300
- }
301
- // Filter out everything that's not a table row.
302
- const rowsLengths = childrenLengths.filter((row, rowIndex) => table.getChild(rowIndex).is('element', 'tableRow'));
303
- // Verify if all the rows have the same number of columns.
304
- const tableSize = rowsLengths[0];
305
- const isValid = rowsLengths.every(length => length === tableSize);
306
- if (!isValid) {
307
- // @if CK_DEBUG_TABLE // console.log( 'Post-fixing table: adding missing cells.' );
308
- // Find the maximum number of columns.
309
- const maxColumns = rowsLengths.reduce((prev, current) => current > prev ? current : prev, 0);
310
- for (const [rowIndex, size] of rowsLengths.entries()) {
311
- const columnsToInsert = maxColumns - size;
312
- if (columnsToInsert) {
313
- for (let i = 0; i < columnsToInsert; i++) {
314
- createEmptyTableCell(writer, writer.createPositionAt(table.getChild(rowIndex), 'end'));
315
- }
316
- wasFixed = true;
317
- }
318
- }
319
- }
320
- return wasFixed;
321
- }
322
- /**
323
- * Searches for table cells that extend beyond the table section to which they belong to. It will return an array of objects
324
- * that stores table cells to be trimmed and the correct value of the `rowspan` attribute to set.
325
- */
326
- function findCellsToTrim(table) {
327
- const headingRows = parseInt(table.getAttribute('headingRows') || '0');
328
- const maxRows = Array.from(table.getChildren())
329
- .reduce((count, row) => row.is('element', 'tableRow') ? count + 1 : count, 0);
330
- const cellsToTrim = [];
331
- for (const { row, cell, cellHeight } of new TableWalker(table)) {
332
- // Skip cells that do not expand over its row.
333
- if (cellHeight < 2) {
334
- continue;
335
- }
336
- const isInHeader = row < headingRows;
337
- // Row limit is either end of header section or whole table as table body is after the header.
338
- const rowLimit = isInHeader ? headingRows : maxRows;
339
- // If table cell expands over its limit reduce it height to proper value.
340
- if (row + cellHeight > rowLimit) {
341
- const newRowspan = rowLimit - row;
342
- cellsToTrim.push({ cell, rowspan: newRowspan });
343
- }
344
- }
345
- return cellsToTrim;
346
- }
347
- /**
348
- * Returns an array with lengths of rows assigned to the corresponding row index.
349
- */
350
- function getChildrenLengths(table) {
351
- // TableWalker will not provide items for the empty rows, we need to pre-fill this array.
352
- const lengths = new Array(table.childCount).fill(0);
353
- for (const { rowIndex } of new TableWalker(table, { includeAllSlots: true })) {
354
- lengths[rowIndex]++;
355
- }
356
- return lengths;
357
- }
358
- /**
359
- * Checks if the differ entry for an attribute change is one of the table's attributes.
360
- */
361
- function isTableAttributeEntry(entry) {
362
- if (entry.type !== 'attribute') {
363
- return false;
364
- }
365
- const key = entry.attributeKey;
366
- return key === 'headingRows' || key === 'colspan' || key === 'rowspan';
367
- }
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 TableWalker from './../tablewalker';
6
+ import { createEmptyTableCell, updateNumericAttribute } from '../utils/common';
7
+ /**
8
+ * Injects a table layout post-fixer into the model.
9
+ *
10
+ * The role of the table layout post-fixer is to ensure that the table rows have the correct structure
11
+ * after a {@link module:engine/model/model~Model#change `change()`} block was executed.
12
+ *
13
+ * The correct structure means that:
14
+ *
15
+ * * All table rows have the same size.
16
+ * * None of the table cells extend vertically beyond their section (either header or body).
17
+ * * A table cell has always at least one element as a child.
18
+ *
19
+ * If the table structure is not correct, the post-fixer will automatically correct it in two steps:
20
+ *
21
+ * 1. It will clip table cells that extend beyond their section.
22
+ * 2. It will add empty table cells to the rows that are narrower than the widest table row.
23
+ *
24
+ * ## Clipping overlapping table cells
25
+ *
26
+ * Such situation may occur when pasting a table (or a part of a table) to the editor from external sources.
27
+ *
28
+ * For example, see the following table which has a cell (FOO) with the rowspan attribute (2):
29
+ *
30
+ * ```xml
31
+ * <table headingRows="1">
32
+ * <tableRow>
33
+ * <tableCell rowspan="2"><paragraph>FOO</paragraph></tableCell>
34
+ * <tableCell colspan="2"><paragraph>BAR</paragraph></tableCell>
35
+ * </tableRow>
36
+ * <tableRow>
37
+ * <tableCell><paragraph>BAZ</paragraph></tableCell>
38
+ * <tableCell><paragraph>XYZ</paragraph></tableCell>
39
+ * </tableRow>
40
+ * </table>
41
+ * ```
42
+ *
43
+ * It will be rendered in the view as:
44
+ *
45
+ * ```xml
46
+ * <table>
47
+ * <thead>
48
+ * <tr>
49
+ * <td rowspan="2">FOO</td>
50
+ * <td colspan="2">BAR</td>
51
+ * </tr>
52
+ * </thead>
53
+ * <tbody>
54
+ * <tr>
55
+ * <td>BAZ</td>
56
+ * <td>XYZ</td>
57
+ * </tr>
58
+ * </tbody>
59
+ * </table>
60
+ * ```
61
+ *
62
+ * In the above example the table will be rendered as a table with two rows: one in the header and second one in the body.
63
+ * The table cell (FOO) cannot span over multiple rows as it would extend from the header to the body section.
64
+ * The `rowspan` attribute must be changed to (1). The value (1) is the default value of the `rowspan` attribute
65
+ * so the `rowspan` attribute will be removed from the model.
66
+ *
67
+ * The table cell with BAZ in the content will be in the first column of the table.
68
+ *
69
+ * ## Adding missing table cells
70
+ *
71
+ * The table post-fixer will insert empty table cells to equalize table row sizes (the number of columns).
72
+ * The size of a table row is calculated by counting column spans of table cells, both horizontal (from the same row) and
73
+ * vertical (from the rows above).
74
+ *
75
+ * In the above example, the table row in the body section of the table is narrower then the row from the header: it has two cells
76
+ * with the default colspan (1). The header row has one cell with colspan (1) and the second with colspan (2).
77
+ * The table cell (FOO) does not extend beyond the head section (and as such will be fixed in the first step of this post-fixer).
78
+ * The post-fixer will add a missing table cell to the row in the body section of the table.
79
+ *
80
+ * The table from the above example will be fixed and rendered to the view as below:
81
+ *
82
+ * ```xml
83
+ * <table>
84
+ * <thead>
85
+ * <tr>
86
+ * <td rowspan="2">FOO</td>
87
+ * <td colspan="2">BAR</td>
88
+ * </tr>
89
+ * </thead>
90
+ * <tbody>
91
+ * <tr>
92
+ * <td>BAZ</td>
93
+ * <td>XYZ</td>
94
+ * </tr>
95
+ * </tbody>
96
+ * </table>
97
+ * ```
98
+ *
99
+ * ## Collaboration and undo - Expectations vs post-fixer results
100
+ *
101
+ * The table post-fixer only ensures proper structure without a deeper analysis of the nature of the change. As such, it might lead
102
+ * to a structure which was not intended by the user. In particular, it will also fix undo steps (in conjunction with collaboration)
103
+ * in which the editor content might not return to the original state.
104
+ *
105
+ * This will usually happen when one or more users change the size of the table.
106
+ *
107
+ * As an example see the table below:
108
+ *
109
+ * ```xml
110
+ * <table>
111
+ * <tbody>
112
+ * <tr>
113
+ * <td>11</td>
114
+ * <td>12</td>
115
+ * </tr>
116
+ * <tr>
117
+ * <td>21</td>
118
+ * <td>22</td>
119
+ * </tr>
120
+ * </tbody>
121
+ * </table>
122
+ * ```
123
+ *
124
+ * and the user actions:
125
+ *
126
+ * 1. Both users have a table with two rows and two columns.
127
+ * 2. User A adds a column at the end of the table. This will insert empty table cells to two rows.
128
+ * 3. User B adds a row at the end of the table. This will insert a row with two empty table cells.
129
+ * 4. Both users will have a table as below:
130
+ *
131
+ * ```xml
132
+ * <table>
133
+ * <tbody>
134
+ * <tr>
135
+ * <td>11</td>
136
+ * <td>12</td>
137
+ * <td>(empty, inserted by A)</td>
138
+ * </tr>
139
+ * <tr>
140
+ * <td>21</td>
141
+ * <td>22</td>
142
+ * <td>(empty, inserted by A)</td>
143
+ * </tr>
144
+ * <tr>
145
+ * <td>(empty, inserted by B)</td>
146
+ * <td>(empty, inserted by B)</td>
147
+ * </tr>
148
+ * </tbody>
149
+ * </table>
150
+ * ```
151
+ *
152
+ * The last row is shorter then others so the table post-fixer will add an empty row to the last row:
153
+ *
154
+ * ```xml
155
+ * <table>
156
+ * <tbody>
157
+ * <tr>
158
+ * <td>11</td>
159
+ * <td>12</td>
160
+ * <td>(empty, inserted by A)</td>
161
+ * </tr>
162
+ * <tr>
163
+ * <td>21</td>
164
+ * <td>22</td>
165
+ * <td>(empty, inserted by A)</td>
166
+ * </tr>
167
+ * <tr>
168
+ * <td>(empty, inserted by B)</td>
169
+ * <td>(empty, inserted by B)</td>
170
+ * <td>(empty, inserted by the post-fixer)</td>
171
+ * </tr>
172
+ * </tbody>
173
+ * </table>
174
+ * ```
175
+ *
176
+ * Unfortunately undo does not know the nature of the changes and depending on which user applies the post-fixer changes, undoing them
177
+ * might lead to a broken table. If User B undoes inserting the column to the table, the undo engine will undo only the operations of
178
+ * inserting empty cells to rows from the initial table state (row 1 and 2) but the cell in the post-fixed row will remain:
179
+ *
180
+ * ```xml
181
+ * <table>
182
+ * <tbody>
183
+ * <tr>
184
+ * <td>11</td>
185
+ * <td>12</td>
186
+ * </tr>
187
+ * <tr>
188
+ * <td>21</td>
189
+ * <td>22</td>
190
+ * </tr>
191
+ * <tr>
192
+ * <td>(empty, inserted by B)</td>
193
+ * <td>(empty, inserted by B)</td>
194
+ * <td>(empty, inserted by a post-fixer)</td>
195
+ * </tr>
196
+ * </tbody>
197
+ * </table>
198
+ * ```
199
+ *
200
+ * After undo, the table post-fixer will detect that two rows are shorter than others and will fix the table to:
201
+ *
202
+ * ```xml
203
+ * <table>
204
+ * <tbody>
205
+ * <tr>
206
+ * <td>11</td>
207
+ * <td>12</td>
208
+ * <td>(empty, inserted by a post-fixer after undo)</td>
209
+ * </tr>
210
+ * <tr>
211
+ * <td>21</td>
212
+ * <td>22</td>
213
+ * <td>(empty, inserted by a post-fixer after undo)</td>
214
+ * </tr>
215
+ * <tr>
216
+ * <td>(empty, inserted by B)</td>
217
+ * <td>(empty, inserted by B)</td>
218
+ * <td>(empty, inserted by a post-fixer)</td>
219
+ * </tr>
220
+ * </tbody>
221
+ * </table>
222
+ * ```
223
+ */
224
+ export default function injectTableLayoutPostFixer(model) {
225
+ model.document.registerPostFixer(writer => tableLayoutPostFixer(writer, model));
226
+ }
227
+ /**
228
+ * The table layout post-fixer.
229
+ */
230
+ function tableLayoutPostFixer(writer, model) {
231
+ const changes = model.document.differ.getChanges();
232
+ let wasFixed = false;
233
+ // Do not analyze the same table more then once - may happen for multiple changes in the same table.
234
+ const analyzedTables = new Set();
235
+ for (const entry of changes) {
236
+ let table = null;
237
+ if (entry.type == 'insert' && entry.name == 'table') {
238
+ table = entry.position.nodeAfter;
239
+ }
240
+ // Fix table on adding/removing table cells and rows.
241
+ if ((entry.type == 'insert' || entry.type == 'remove') && (entry.name == 'tableRow' || entry.name == 'tableCell')) {
242
+ table = entry.position.findAncestor('table');
243
+ }
244
+ // Fix table on any table's attribute change - including attributes of table cells.
245
+ if (isTableAttributeEntry(entry)) {
246
+ table = entry.range.start.findAncestor('table');
247
+ }
248
+ if (table && !analyzedTables.has(table)) {
249
+ // Step 1: correct rowspans of table cells if necessary.
250
+ // The wasFixed flag should be true if any of tables in batch was fixed - might be more then one.
251
+ wasFixed = fixTableCellsRowspan(table, writer) || wasFixed;
252
+ // Step 2: fix table rows sizes.
253
+ wasFixed = fixTableRowsSizes(table, writer) || wasFixed;
254
+ analyzedTables.add(table);
255
+ }
256
+ }
257
+ return wasFixed;
258
+ }
259
+ /**
260
+ * Fixes the invalid value of the `rowspan` attribute because a table cell cannot vertically extend beyond the table section it belongs to.
261
+ *
262
+ * @returns Returns `true` if the table was fixed.
263
+ */
264
+ function fixTableCellsRowspan(table, writer) {
265
+ let wasFixed = false;
266
+ const cellsToTrim = findCellsToTrim(table);
267
+ if (cellsToTrim.length) {
268
+ // @if CK_DEBUG_TABLE // console.log( `Post-fixing table: trimming cells row-spans (${ cellsToTrim.length }).` );
269
+ wasFixed = true;
270
+ for (const data of cellsToTrim) {
271
+ updateNumericAttribute('rowspan', data.rowspan, data.cell, writer, 1);
272
+ }
273
+ }
274
+ return wasFixed;
275
+ }
276
+ /**
277
+ * Makes all table rows in a table the same size.
278
+ *
279
+ * @returns Returns `true` if the table was fixed.
280
+ */
281
+ function fixTableRowsSizes(table, writer) {
282
+ let wasFixed = false;
283
+ const childrenLengths = getChildrenLengths(table);
284
+ const rowsToRemove = [];
285
+ // Find empty rows.
286
+ for (const [rowIndex, size] of childrenLengths.entries()) {
287
+ // Ignore all non-row models.
288
+ if (!size && table.getChild(rowIndex).is('element', 'tableRow')) {
289
+ rowsToRemove.push(rowIndex);
290
+ }
291
+ }
292
+ // Remove empty rows.
293
+ if (rowsToRemove.length) {
294
+ // @if CK_DEBUG_TABLE // console.log( `Post-fixing table: remove empty rows (${ rowsToRemove.length }).` );
295
+ wasFixed = true;
296
+ for (const rowIndex of rowsToRemove.reverse()) {
297
+ writer.remove(table.getChild(rowIndex));
298
+ childrenLengths.splice(rowIndex, 1);
299
+ }
300
+ }
301
+ // Filter out everything that's not a table row.
302
+ const rowsLengths = childrenLengths.filter((row, rowIndex) => table.getChild(rowIndex).is('element', 'tableRow'));
303
+ // Verify if all the rows have the same number of columns.
304
+ const tableSize = rowsLengths[0];
305
+ const isValid = rowsLengths.every(length => length === tableSize);
306
+ if (!isValid) {
307
+ // @if CK_DEBUG_TABLE // console.log( 'Post-fixing table: adding missing cells.' );
308
+ // Find the maximum number of columns.
309
+ const maxColumns = rowsLengths.reduce((prev, current) => current > prev ? current : prev, 0);
310
+ for (const [rowIndex, size] of rowsLengths.entries()) {
311
+ const columnsToInsert = maxColumns - size;
312
+ if (columnsToInsert) {
313
+ for (let i = 0; i < columnsToInsert; i++) {
314
+ createEmptyTableCell(writer, writer.createPositionAt(table.getChild(rowIndex), 'end'));
315
+ }
316
+ wasFixed = true;
317
+ }
318
+ }
319
+ }
320
+ return wasFixed;
321
+ }
322
+ /**
323
+ * Searches for table cells that extend beyond the table section to which they belong to. It will return an array of objects
324
+ * that stores table cells to be trimmed and the correct value of the `rowspan` attribute to set.
325
+ */
326
+ function findCellsToTrim(table) {
327
+ const headingRows = parseInt(table.getAttribute('headingRows') || '0');
328
+ const maxRows = Array.from(table.getChildren())
329
+ .reduce((count, row) => row.is('element', 'tableRow') ? count + 1 : count, 0);
330
+ const cellsToTrim = [];
331
+ for (const { row, cell, cellHeight } of new TableWalker(table)) {
332
+ // Skip cells that do not expand over its row.
333
+ if (cellHeight < 2) {
334
+ continue;
335
+ }
336
+ const isInHeader = row < headingRows;
337
+ // Row limit is either end of header section or whole table as table body is after the header.
338
+ const rowLimit = isInHeader ? headingRows : maxRows;
339
+ // If table cell expands over its limit reduce it height to proper value.
340
+ if (row + cellHeight > rowLimit) {
341
+ const newRowspan = rowLimit - row;
342
+ cellsToTrim.push({ cell, rowspan: newRowspan });
343
+ }
344
+ }
345
+ return cellsToTrim;
346
+ }
347
+ /**
348
+ * Returns an array with lengths of rows assigned to the corresponding row index.
349
+ */
350
+ function getChildrenLengths(table) {
351
+ // TableWalker will not provide items for the empty rows, we need to pre-fill this array.
352
+ const lengths = new Array(table.childCount).fill(0);
353
+ for (const { rowIndex } of new TableWalker(table, { includeAllSlots: true })) {
354
+ lengths[rowIndex]++;
355
+ }
356
+ return lengths;
357
+ }
358
+ /**
359
+ * Checks if the differ entry for an attribute change is one of the table's attributes.
360
+ */
361
+ function isTableAttributeEntry(entry) {
362
+ if (entry.type !== 'attribute') {
363
+ return false;
364
+ }
365
+ const key = entry.attributeKey;
366
+ return key === 'headingRows' || key === 'colspan' || key === 'rowspan';
367
+ }