@ckeditor/ckeditor5-table 0.0.0-nightly-20230829.0 → 0.0.0-nightly-20230831.0

package/src/tablewalker.js

@@ -84,6 +84,10 @@ export default class TableWalker {
      * @param options.includeAllSlots Also return values for spanned cells. Default value is "false".
      */
     constructor(table, options = {}) {
+        /**
+         * Indicates whether the iterator jumped to (or close to) the start row, ignoring rows that don't need to be traversed.
+         */
+        this._jumpedToStartRow = false;
         this._table = table;
         this._startRow = options.row !== undefined ? options.row : options.startRow || 0;
         this._endRow = options.row !== undefined ? options.row : options.endRow;
@@ -110,6 +114,9 @@ export default class TableWalker {
      * @returns The next table walker's value.
      */
     next() {
+        if (this._canJumpToStartRow()) {
+            this._jumpToNonSpannedRowClosestToStartRow();
+        }
         const row = this._table.getChild(this._rowIndex);
         // Iterator is done when there's no row (table ended) or the row is after `endRow` limit.
         if (!row || this._isOverEndRow()) {
@@ -259,6 +266,59 @@ export default class TableWalker {
         const rowSpans = this._spannedCells.get(row);
         rowSpans.set(column, data);
     }
+    /**
+     * Checks if part of the table can be skipped.
+     */
+    _canJumpToStartRow() {
+        return !!this._startRow &&
+            this._startRow > 0 &&
+            !this._jumpedToStartRow;
+    }
+    /**
+     * Sets the current row to `this._startRow` or the first row before it that has the number of cells
+     * equal to the number of columns in the table.
+     *
+     * Example:
+     * 	+----+----+----+
+     *  | 00 | 01 | 02 |
+     *  |----+----+----+
+     *  | 10      | 12 |
+     *  |         +----+
+     *  |         | 22 |
+     *  |         +----+
+     *  |         | 32 | <--- Start row
+     *  +----+----+----+
+     *  | 40 | 41 | 42 |
+     *  +----+----+----+
+     *
+     * If the 4th row is a `this._startRow`, this method will:
+     * 1.) Count the number of columns this table has based on the first row (3 columns in this case).
+     * 2.) Check if the 4th row contains 3 cells. It doesn't, so go to the row before it.
+     * 3.) Check if the 3rd row contains 3 cells. It doesn't, so go to the row before it.
+     * 4.) Check if the 2nd row contains 3 cells. It does, so set the current row to that row.
+     *
+     * Setting the current row this way is necessary to let the `next()`  method loop over the cells
+     * spanning multiple rows or columns and update the `this._spannedCells` property.
+     */
+    _jumpToNonSpannedRowClosestToStartRow() {
+        const firstRowLength = this._getRowLength(0);
+        for (let i = this._startRow; !this._jumpedToStartRow; i--) {
+            if (firstRowLength === this._getRowLength(i)) {
+                this._row = i;
+                this._rowIndex = i;
+                this._jumpedToStartRow = true;
+            }
+        }
+    }
+    /**
+     * Returns a number of columns in a row taking `colspan` into consideration.
+     */
+    _getRowLength(rowIndex) {
+        const row = this._table.getChild(rowIndex);
+        return [...row.getChildren()].reduce((cols, row) => {
+            return cols + parseInt(row.getAttribute('colspan') || '1');
+        }, 0);
+    }
 }
 /**
  * An object returned by {@link module:table/tablewalker~TableWalker} when traversing table cells.