handsontable 0.0.0-next-221e46b-20240307 → 0.0.0-next-2becb78-20240313

package/selection/selection.js

@@ -9,7 +9,7 @@ var _mixed = require("./../helpers/mixed");
 var _number = require("./../helpers/number");
 var _array = require("./../helpers/array");
 var _localHooks = _interopRequireDefault(require("./../mixins/localHooks"));
-var _transformation = _interopRequireDefault(require("./transformation"));
+var _transformation2 = _interopRequireDefault(require("./transformation"));
 var _utils = require("./utils");
 var _templateLiteralTag = require("./../helpers/templateLiteralTag");
 var _a11y = require("../helpers/a11y");
@@ -30,6 +30,9 @@ function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.
  * @class Selection
  * @util
  */
+var _transformation = /*#__PURE__*/new WeakMap();
+var _focusTransformation = /*#__PURE__*/new WeakMap();
+var _isFocusSelectionChanged = /*#__PURE__*/new WeakMap();
 var _disableHeadersHighlight = /*#__PURE__*/new WeakMap();
 var _selectionSource = /*#__PURE__*/new WeakMap();
 var _expectedLayersCount = /*#__PURE__*/new WeakMap();
@@ -69,11 +72,23 @@ class Selection {
      */
     _defineProperty(this, "highlight", void 0);
     /**
-     * The module for modifying coordinates.
+     * The module for modifying coordinates of the start and end selection.
      *
      * @type {Transformation}
      */
-    _defineProperty(this, "transformation", void 0);
+    _classPrivateFieldInitSpec(this, _transformation, {
+      writable: true,
+      value: void 0
+    });
+    /**
+     * The module for modifying coordinates of the focus selection.
+     *
+     * @type {Transformation}
+     */
+    _classPrivateFieldInitSpec(this, _focusTransformation, {
+      writable: true,
+      value: void 0
+    });
     /**
      * The collection of the selection layer levels where the whole row was selected using the row header or
      * the corner header.
@@ -88,6 +103,15 @@ class Selection {
      * @type {Set<number>}
      */
     _defineProperty(this, "selectedByColumnHeader", new Set());
+    /**
+     * The flag which determines if the focus selection was changed.
+     *
+     * @type {boolean}
+     */
+    _classPrivateFieldInitSpec(this, _isFocusSelectionChanged, {
+      writable: true,
+      value: false
+    });
     /**
      * When sets disable highlighting the headers even when the logical coordinates points on them.
      *
@@ -138,71 +162,118 @@ class Selection {
       createCellCoords: (row, column) => this.tableProps.createCellCoords(row, column),
       createCellRange: (highlight, from, to) => this.tableProps.createCellRange(highlight, from, to)
     });
-    this.transformation = new _transformation.default(this.selectedRange, {
+    _classPrivateFieldSet(this, _transformation, new _transformation2.default(this.selectedRange, {
       rowIndexMapper: this.tableProps.rowIndexMapper,
       columnIndexMapper: this.tableProps.columnIndexMapper,
       countRenderableRows: () => this.tableProps.countRenderableRows(),
       countRenderableColumns: () => this.tableProps.countRenderableColumns(),
-      countRowHeaders: () => this.tableProps.countRowHeaders(),
-      countColHeaders: () => this.tableProps.countColHeaders(),
       visualToRenderableCoords: coords => this.tableProps.visualToRenderableCoords(coords),
       renderableToVisualCoords: coords => this.tableProps.renderableToVisualCoords(coords),
+      findFirstNonHiddenRenderableRow: function () {
+        return _this.tableProps.findFirstNonHiddenRenderableRow(...arguments);
+      },
+      findFirstNonHiddenRenderableColumn: function () {
+        return _this.tableProps.findFirstNonHiddenRenderableColumn(...arguments);
+      },
       createCellCoords: (row, column) => this.tableProps.createCellCoords(row, column),
-      navigableHeaders: () => settings.navigableHeaders,
       fixedRowsBottom: () => settings.fixedRowsBottom,
       minSpareRows: () => settings.minSpareRows,
       minSpareCols: () => settings.minSpareCols,
       autoWrapRow: () => settings.autoWrapRow,
       autoWrapCol: () => settings.autoWrapCol
-    });
-    this.transformation.addLocalHook('beforeTransformStart', function () {
+    }));
+    _classPrivateFieldSet(this, _focusTransformation, new _transformation2.default(this.selectedRange, {
+      rowIndexMapper: this.tableProps.rowIndexMapper,
+      columnIndexMapper: this.tableProps.columnIndexMapper,
+      countRenderableRows: () => {
+        const range = this.selectedRange.current();
+        return this.tableProps.countRenderableRowsInRange(0, range.getOuterBottomEndCorner().row);
+      },
+      countRenderableColumns: () => {
+        const range = this.selectedRange.current();
+        return this.tableProps.countRenderableColumnsInRange(0, range.getOuterBottomEndCorner().col);
+      },
+      visualToRenderableCoords: coords => this.tableProps.visualToRenderableCoords(coords),
+      renderableToVisualCoords: coords => this.tableProps.renderableToVisualCoords(coords),
+      findFirstNonHiddenRenderableRow: function () {
+        return _this.tableProps.findFirstNonHiddenRenderableRow(...arguments);
+      },
+      findFirstNonHiddenRenderableColumn: function () {
+        return _this.tableProps.findFirstNonHiddenRenderableColumn(...arguments);
+      },
+      createCellCoords: (row, column) => this.tableProps.createCellCoords(row, column),
+      fixedRowsBottom: () => 0,
+      minSpareRows: () => 0,
+      minSpareCols: () => 0,
+      autoWrapRow: () => true,
+      autoWrapCol: () => true
+    }));
+    _classPrivateFieldGet(this, _transformation).addLocalHook('beforeTransformStart', function () {
       for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
         args[_key] = arguments[_key];
       }
       return _this.runLocalHooks('beforeModifyTransformStart', ...args);
     });
-    this.transformation.addLocalHook('afterTransformStart', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('afterTransformStart', function () {
       for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         args[_key2] = arguments[_key2];
       }
       return _this.runLocalHooks('afterModifyTransformStart', ...args);
     });
-    this.transformation.addLocalHook('beforeTransformEnd', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('beforeTransformEnd', function () {
       for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
         args[_key3] = arguments[_key3];
       }
       return _this.runLocalHooks('beforeModifyTransformEnd', ...args);
     });
-    this.transformation.addLocalHook('afterTransformEnd', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('modifyTransformEndRestDelta', function () {
       for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
         args[_key4] = arguments[_key4];
       }
-      return _this.runLocalHooks('afterModifyTransformEnd', ...args);
+      return _this.runLocalHooks('modifyTransformEndRestDelta', ...args);
     });
-    this.transformation.addLocalHook('insertRowRequire', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('afterTransformEnd', function () {
       for (var _len5 = arguments.length, args = new Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
         args[_key5] = arguments[_key5];
       }
-      return _this.runLocalHooks('insertRowRequire', ...args);
+      return _this.runLocalHooks('afterModifyTransformEnd', ...args);
     });
-    this.transformation.addLocalHook('insertColRequire', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('insertRowRequire', function () {
       for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
         args[_key6] = arguments[_key6];
       }
-      return _this.runLocalHooks('insertColRequire', ...args);
+      return _this.runLocalHooks('insertRowRequire', ...args);
     });
-    this.transformation.addLocalHook('beforeRowWrap', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('insertColRequire', function () {
       for (var _len7 = arguments.length, args = new Array(_len7), _key7 = 0; _key7 < _len7; _key7++) {
         args[_key7] = arguments[_key7];
       }
-      return _this.runLocalHooks('beforeRowWrap', ...args);
+      return _this.runLocalHooks('insertColRequire', ...args);
     });
-    this.transformation.addLocalHook('beforeColumnWrap', function () {
+    _classPrivateFieldGet(this, _transformation).addLocalHook('beforeRowWrap', function () {
       for (var _len8 = arguments.length, args = new Array(_len8), _key8 = 0; _key8 < _len8; _key8++) {
         args[_key8] = arguments[_key8];
       }
+      return _this.runLocalHooks('beforeRowWrap', ...args);
+    });
+    _classPrivateFieldGet(this, _transformation).addLocalHook('beforeColumnWrap', function () {
+      for (var _len9 = arguments.length, args = new Array(_len9), _key9 = 0; _key9 < _len9; _key9++) {
+        args[_key9] = arguments[_key9];
+      }
       return _this.runLocalHooks('beforeColumnWrap', ...args);
     });
+    _classPrivateFieldGet(this, _focusTransformation).addLocalHook('beforeTransformStart', function () {
+      for (var _len10 = arguments.length, args = new Array(_len10), _key10 = 0; _key10 < _len10; _key10++) {
+        args[_key10] = arguments[_key10];
+      }
+      return _this.runLocalHooks('beforeModifyTransformFocus', ...args);
+    });
+    _classPrivateFieldGet(this, _focusTransformation).addLocalHook('afterTransformStart', function () {
+      for (var _len11 = arguments.length, args = new Array(_len11), _key11 = 0; _key11 < _len11; _key11++) {
+        args[_key11] = arguments[_key11];
+      }
+      return _this.runLocalHooks('afterModifyTransformFocus', ...args);
+    });
   }
 
   /**
@@ -293,6 +364,7 @@ class Selection {
     // We are creating copy. We would like to modify just the start of the selection by below hook. Then original coords
     // should be handled by next methods.
     const coordsClone = coords.clone();
+    _classPrivateFieldSet(this, _isFocusSelectionChanged, false);
     this.runLocalHooks(`beforeSetRangeStart${fragment ? 'Only' : ''}`, coordsClone);
     if (!isMultipleMode || isMultipleMode && !isMultipleSelection && (0, _mixed.isUndefined)(multipleSelection)) {
       this.selectedRange.clear();
@@ -350,7 +422,20 @@ class Selection {
       cellRange.setFrom(cellRange.highlight);
       cellRange.setTo(cellRange.highlight);
     } else {
+      const horizontalDir = cellRange.getHorizontalDirection();
+      const verticalDir = cellRange.getVerticalDirection();
+      const isMultiple = this.isMultiple();
       cellRange.setTo(coordsClone);
+      if (isMultiple && horizontalDir !== cellRange.getHorizontalDirection()) {
+        cellRange.from.assign({
+          col: cellRange.highlight.col
+        });
+      }
+      if (isMultiple && verticalDir !== cellRange.getVerticalDirection()) {
+        cellRange.from.assign({
+          row: cellRange.highlight.row
+        });
+      }
     }
 
     // Prevent creating "area" selection that overlaps headers.
@@ -360,11 +445,7 @@ class Selection {
       }
     }
     this.runLocalHooks('beforeHighlightSet');
-    const focusHighlight = this.highlight.getFocus();
-    focusHighlight.clear();
-    if (this.highlight.isEnabledFor(_highlight.FOCUS_TYPE, cellRange.highlight)) {
-      focusHighlight.add(this.selectedRange.current().highlight).commit().syncWith(cellRange);
-    }
+    this.setRangeFocus(this.selectedRange.current().highlight);
     const layerLevel = this.getLayerLevel();
 
     // If the next layer level is lower than previous then clear all area and header highlights. This is the
@@ -452,15 +533,31 @@ class Selection {
   }
 
   /**
-   * Returns information if we have a multiselection. This method check multiselection only on the latest layer of
-   * the selection.
+   * Sets the selection focus position at the specified coordinates.
    *
-   * @returns {boolean}
+   * @param {CellCoords} coords The CellCoords instance with defined visual coordinates.
    */
-  isMultiple() {
-    const isMultipleListener = (0, _object.createObjectPropListener)(!this.selectedRange.current().isSingle());
-    this.runLocalHooks('afterIsMultipleSelection', isMultipleListener);
-    return isMultipleListener.value;
+  setRangeFocus(coords) {
+    if (this.selectedRange.isEmpty()) {
+      return;
+    }
+    const cellRange = this.selectedRange.current();
+    if (!this.inProgress) {
+      this.runLocalHooks('beforeSetFocus', coords);
+    }
+    const focusHighlight = this.highlight.getFocus();
+    focusHighlight.clear();
+    cellRange.setHighlight(coords);
+    if (!this.inProgress) {
+      this.runLocalHooks('beforeHighlightSet');
+    }
+    if (this.highlight.isEnabledFor(_highlight.FOCUS_TYPE, cellRange.highlight)) {
+      focusHighlight.add(cellRange.highlight).commit().syncWith(cellRange);
+    }
+    if (!this.inProgress) {
+      _classPrivateFieldSet(this, _isFocusSelectionChanged, true);
+      this.runLocalHooks('afterSetFocus', cellRange.highlight);
+    }
   }
 
   /**
@@ -473,7 +570,13 @@ class Selection {
    */
   transformStart(rowDelta, colDelta) {
     let createMissingRecords = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-    this.setRangeStart(this.transformation.transformStart(rowDelta, colDelta, createMissingRecords));
+    if (this.settings.navigableHeaders) {
+      _classPrivateFieldGet(this, _transformation).setOffsetSize({
+        x: this.tableProps.countRowHeaders(),
+        y: this.tableProps.countColHeaders()
+      });
+    }
+    this.setRangeStart(_classPrivateFieldGet(this, _transformation).transformStart(rowDelta, colDelta, createMissingRecords));
   }
 
   /**
@@ -483,7 +586,44 @@ class Selection {
    * @param {number} colDelta Columns number to move, value can be passed as negative number.
    */
   transformEnd(rowDelta, colDelta) {
-    this.setRangeEnd(this.transformation.transformEnd(rowDelta, colDelta));
+    if (this.settings.navigableHeaders) {
+      _classPrivateFieldGet(this, _transformation).setOffsetSize({
+        x: this.tableProps.countRowHeaders(),
+        y: this.tableProps.countColHeaders()
+      });
+    }
+    this.setRangeEnd(_classPrivateFieldGet(this, _transformation).transformEnd(rowDelta, colDelta));
+  }
+
+  /**
+   * Transforms the focus cell selection relative to the current focus position.
+   *
+   * @param {number} rowDelta Rows number to move, value can be passed as negative number.
+   * @param {number} colDelta Columns number to move, value can be passed as negative number.
+   */
+  transformFocus(rowDelta, colDelta) {
+    const range = this.selectedRange.current();
+    const {
+      row,
+      col
+    } = range.getOuterTopStartCorner();
+    const columnsInRange = this.tableProps.countRenderableColumnsInRange(0, col - 1);
+    const rowsInRange = this.tableProps.countRenderableRowsInRange(0, row - 1);
+    if (range.highlight.isHeader()) {
+      // for header focus selection calculate the new coords based on the selection including headers
+      _classPrivateFieldGet(this, _focusTransformation).setOffsetSize({
+        x: col < 0 ? Math.abs(col) : -columnsInRange,
+        y: row < 0 ? Math.abs(row) : -rowsInRange
+      });
+    } else {
+      // for focus selection in cells calculate the new coords only based on the selected cells
+      _classPrivateFieldGet(this, _focusTransformation).setOffsetSize({
+        x: col < 0 ? 0 : -columnsInRange,
+        y: row < 0 ? 0 : -rowsInRange
+      });
+    }
+    const focusCoords = _classPrivateFieldGet(this, _focusTransformation).transformStart(rowDelta, colDelta);
+    this.setRangeFocus(focusCoords.normalize());
   }
 
   /**
@@ -504,6 +644,30 @@ class Selection {
     return !this.selectedRange.isEmpty();
   }
 
+  /**
+   * Returns information if we have a multi-selection. This method check multi-selection only on the latest layer of
+   * the selection.
+   *
+   * @returns {boolean}
+   */
+  isMultiple() {
+    if (!this.isSelected()) {
+      return false;
+    }
+    const isMultipleListener = (0, _object.createObjectPropListener)(!this.selectedRange.current().isSingle());
+    this.runLocalHooks('afterIsMultipleSelection', isMultipleListener);
+    return isMultipleListener.value;
+  }
+
+  /**
+   * Checks if the last selection involves changing the focus cell position only.
+   *
+   * @returns {boolean}
+   */
+  isFocusSelectionChanged() {
+    return this.isSelected() && _classPrivateFieldGet(this, _isFocusSelectionChanged);
+  }
+
   /**
    * Returns `true` if the selection was applied by clicking to the row header. If the `layerLevel`
    * argument is passed then only that layer will be checked. Otherwise, it checks if any row header
@@ -786,9 +950,10 @@ class Selection {
    *
    * @param {number|string} startColumn Visual column index or column property from which the selection starts.
    * @param {number|string} [endColumn] Visual column index or column property from to the selection finishes.
-   * @param {number} [focusPosition=0] The argument allows changing the cell/header focus position.
-   *                                   The value can take visual row index from -N to N, where negative values
-   *                                   point to the headers and positive values point to the cell range.
+   * @param {number | { row: number, col: number }} [focusPosition=0] The argument allows changing the cell/header focus
+   * position. The value can take visual row index from -N to N, where negative values point to the headers and positive
+   * values point to the cell range. An object with `row` and `col` properties also can be passed to change the focus
+   * position horizontally.
    * @returns {boolean} Returns `true` if selection was successful, `false` otherwise.
    */
   selectColumns(startColumn) {
@@ -809,11 +974,20 @@ class Selection {
       countColHeaders
     });
     if (isValid) {
-      const fromRow = countColHeaders === 0 ? 0 : (0, _number.clamp)(focusPosition, columnHeaderLastIndex, -1);
+      let highlightRow = 0;
+      let highlightColumn = 0;
+      if (Number.isInteger(focusPosition === null || focusPosition === void 0 ? void 0 : focusPosition.row) && Number.isInteger(focusPosition === null || focusPosition === void 0 ? void 0 : focusPosition.col)) {
+        highlightRow = (0, _number.clamp)(focusPosition.row, columnHeaderLastIndex, countRows - 1);
+        highlightColumn = (0, _number.clamp)(focusPosition.col, Math.min(start, end), Math.max(start, end));
+      } else {
+        highlightRow = (0, _number.clamp)(focusPosition, columnHeaderLastIndex, countRows - 1);
+        highlightColumn = start;
+      }
+      const highlight = this.tableProps.createCellCoords(highlightRow, highlightColumn);
+      const fromRow = countColHeaders === 0 ? 0 : (0, _number.clamp)(highlight.row, columnHeaderLastIndex, -1);
       const toRow = countRows - 1;
       const from = this.tableProps.createCellCoords(fromRow, start);
       const to = this.tableProps.createCellCoords(toRow, end);
-      const highlight = this.tableProps.createCellCoords((0, _number.clamp)(focusPosition, columnHeaderLastIndex, countRows - 1), start);
       this.runLocalHooks('beforeSelectColumns', from, to, highlight);
 
       // disallow modifying row axis for that hooks
@@ -833,9 +1007,10 @@ class Selection {
    *
    * @param {number} startRow Visual row index from which the selection starts.
    * @param {number} [endRow] Visual row index from to the selection finishes.
-   * @param {number} [focusPosition=0] The argument allows changing the cell/header focus position.
-   *                                   The value can take visual column index from -N to N, where negative values
-   *                                   point to the headers and positive values point to the cell range.
+   * @param {number | { row: number, col: number }} [focusPosition=0] The argument allows changing the cell/header focus
+   * position. The value can take visual row index from -N to N, where negative values point to the headers and positive
+   * values point to the cell range. An object with `row` and `col` properties also can be passed to change the focus
+   * position horizontally.
    * @returns {boolean} Returns `true` if selection was successful, `false` otherwise.
    */
   selectRows(startRow) {
@@ -854,11 +1029,20 @@ class Selection {
       countColHeaders: 0
     });
     if (isValid) {
-      const fromColumn = countRowHeaders === 0 ? 0 : (0, _number.clamp)(focusPosition, rowHeaderLastIndex, -1);
+      let highlightRow = 0;
+      let highlightColumn = 0;
+      if (Number.isInteger(focusPosition === null || focusPosition === void 0 ? void 0 : focusPosition.row) && Number.isInteger(focusPosition === null || focusPosition === void 0 ? void 0 : focusPosition.col)) {
+        highlightRow = (0, _number.clamp)(focusPosition.row, Math.min(startRow, endRow), Math.max(startRow, endRow));
+        highlightColumn = (0, _number.clamp)(focusPosition.col, rowHeaderLastIndex, countCols - 1);
+      } else {
+        highlightRow = startRow;
+        highlightColumn = (0, _number.clamp)(focusPosition, rowHeaderLastIndex, countCols - 1);
+      }
+      const highlight = this.tableProps.createCellCoords(highlightRow, highlightColumn);
+      const fromColumn = countRowHeaders === 0 ? 0 : (0, _number.clamp)(highlight.col, rowHeaderLastIndex, -1);
       const toColumn = countCols - 1;
       const from = this.tableProps.createCellCoords(startRow, fromColumn);
       const to = this.tableProps.createCellCoords(endRow, toColumn);
-      const highlight = this.tableProps.createCellCoords(startRow, (0, _number.clamp)(focusPosition, rowHeaderLastIndex, countCols - 1));
       this.runLocalHooks('beforeSelectRows', from, to, highlight);
 
       // disallow modifying column axis for that hooks