handsontable 13.1.0-next-e1a7d2c-20230831 → 14.0.0-next-d97b156-20231027

package/selection/highlight/highlight.js

@@ -2,9 +2,33 @@
 
 exports.__esModule = true;
 require("core-js/modules/es.array.push.js");
-var _types = require("./types");
-var _constants = require("./constants");
+require("core-js/modules/es.error.cause.js");
+var _activeHeader = require("./types/activeHeader");
+var _areaLayered = require("./types/areaLayered");
+var _area = require("./types/area");
+var _column = require("./types/column");
+var _focus = require("./types/focus");
+var _customSelection = require("./types/customSelection");
+var _fill = require("./types/fill");
+var _header = require("./types/header");
+var _row = require("./types/row");
+var _src = require("../../3rdparty/walkontable/src");
+exports.ACTIVE_HEADER_TYPE = _src.HIGHLIGHT_ACTIVE_HEADER_TYPE;
+exports.AREA_TYPE = _src.HIGHLIGHT_AREA_TYPE;
+exports.FOCUS_TYPE = _src.HIGHLIGHT_FOCUS_TYPE;
+exports.CUSTOM_SELECTION_TYPE = _src.HIGHLIGHT_CUSTOM_SELECTION_TYPE;
+exports.FILL_TYPE = _src.HIGHLIGHT_FILL_TYPE;
+exports.HEADER_TYPE = _src.HIGHLIGHT_HEADER_TYPE;
+exports.ROW_TYPE = _src.HIGHLIGHT_ROW_TYPE;
+exports.COLUMN_TYPE = _src.HIGHLIGHT_COLUMN_TYPE;
 var _array = require("./../../helpers/array");
+let _Symbol$iterator;
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
 /**
  * Highlight class responsible for managing Walkontable Selection classes.
  *
@@ -20,14 +44,24 @@ var _array = require("./../../helpers/array");
  * @class Highlight
  * @util
  */
+var _createHighlight = /*#__PURE__*/new WeakSet();
+_Symbol$iterator = Symbol.iterator;
 class Highlight {
   constructor(options) {
+    /**
+     * Creates (if not exist in the cache) Walkontable Selection instance.
+     *
+     * @param {Map} cacheMap The map where the instance will be cached.
+     * @param {Function} highlightFactory The function factory.
+     * @returns {VisualSelection}
+     */
+    _classPrivateMethodInitSpec(this, _createHighlight);
     /**
      * Options consumed by Highlight class and Walkontable Selection classes.
      *
      * @type {object}
      */
-    this.options = options;
+    _defineProperty(this, "options", void 0);
     /**
      * The property which describes which layer level of the visual selection will be modified.
      * This option is valid only for `area` and `header` highlight types which occurs multiple times on
@@ -38,49 +72,96 @@ class Highlight {
      * @type {number}
      * @default 0
      */
-    this.layerLevel = 0;
+    _defineProperty(this, "layerLevel", 0);
     /**
      * `cell` highlight object which describes attributes for the currently selected cell.
      * It can only occur only once on the table.
      *
      * @type {Selection}
      */
-    this.cell = (0, _types.createHighlight)(_constants.CELL_TYPE, options);
+    _defineProperty(this, "focus", void 0);
     /**
      * `fill` highlight object which describes attributes for the borders for autofill functionality.
      * It can only occur only once on the table.
      *
      * @type {Selection}
      */
-    this.fill = (0, _types.createHighlight)(_constants.FILL_TYPE, options);
+    _defineProperty(this, "fill", void 0);
     /**
      * Collection of the `area` highlights. That objects describes attributes for the borders and selection of
      * the multiple selected cells. It can occur multiple times on the table.
      *
      * @type {Map.<number, Selection>}
      */
-    this.areas = new Map();
+    _defineProperty(this, "layeredAreas", new Map());
+    /**
+     * Collection of the `highlight` highlights. That objects describes attributes for the borders and selection of
+     * the multiple selected cells. It can occur multiple times on the table.
+     *
+     * @type {Map.<number, Selection>}
+     */
+    _defineProperty(this, "areas", new Map());
     /**
      * Collection of the `header` highlights. That objects describes attributes for the selection of
-     * the multiple selected rows and columns in the table header. It can occur multiple times on the table.
+     * the multiple selected rows in the table header. It can occur multiple times on the table.
+     *
+     * @type {Map.<number, Selection>}
+     */
+    _defineProperty(this, "rowHeaders", new Map());
+    /**
+     * Collection of the `header` highlights. That objects describes attributes for the selection of
+     * the multiple selected columns in the table header. It can occur multiple times on the table.
+     *
+     * @type {Map.<number, Selection>}
+     */
+    _defineProperty(this, "columnHeaders", new Map());
+    /**
+     * Collection of the `active-header` highlights. That objects describes attributes for the selection of
+     * the multiple selected rows in the table header. The table headers which have selected all items in
+     * a row will be marked as `active-header`.
      *
      * @type {Map.<number, Selection>}
      */
-    this.headers = new Map();
+    _defineProperty(this, "activeRowHeaders", new Map());
     /**
      * Collection of the `active-header` highlights. That objects describes attributes for the selection of
-     * the multiple selected rows and columns in the table header. The table headers which have selected all items in
+     * the multiple selected columns in the table header. The table headers which have selected all items in
      * a row will be marked as `active-header`.
      *
      * @type {Map.<number, Selection>}
      */
-    this.activeHeaders = new Map();
+    _defineProperty(this, "activeColumnHeaders", new Map());
+    /**
+     * Collection of the `active-header` highlights. That objects describes attributes for the selection of
+     * the selected corner in the table header. The table headers which have selected all items in
+     * a row will be marked as `active-header`.
+     *
+     * @type {Map.<number, Selection>}
+     */
+    _defineProperty(this, "activeCornerHeaders", new Map());
+    /**
+     * Collection of the `rows` highlights. That objects describes attributes for the selection of
+     * the multiple selected cells in a row. It can occur multiple times on the table.
+     *
+     * @type {Map.<number, Selection>}
+     */
+    _defineProperty(this, "rowHighlights", new Map());
+    /**
+     * Collection of the `columns` highlights. That objects describes attributes for the selection of
+     * the multiple selected cells in a column. It can occur multiple times on the table.
+     *
+     * @type {Map.<number, Selection>}
+     */
+    _defineProperty(this, "columnHighlights", new Map());
     /**
      * Collection of the `custom-selection`, holder for example borders added through CustomBorders plugin.
      *
      * @type {Selection[]}
      */
-    this.customSelections = [];
+    _defineProperty(this, "customSelections", []);
+    this.options = options;
+    this.focus = (0, _focus.createHighlight)(options);
+    this.fill = (0, _fill.createHighlight)(options);
   }
 
   /**
@@ -94,11 +175,14 @@ class Highlight {
     let type = highlightType;
 
     // Legacy compatibility.
-    if (highlightType === _constants.CELL_TYPE) {
+    if (highlightType === _src.HIGHLIGHT_FOCUS_TYPE) {
       type = 'current'; // One from settings for `disableVisualSelection` up to Handsontable 0.36/Handsontable Pro 1.16.0.
     }
 
-    let disableHighlight = this.options.disabledCellSelection(coords.row, coords.col);
+    let disableHighlight = false;
+    if (coords.isCell()) {
+      disableHighlight = this.options.disabledCellSelection(coords.row, coords.col);
+    }
     if (typeof disableHighlight === 'string') {
       disableHighlight = [disableHighlight];
     }
@@ -118,12 +202,13 @@ class Highlight {
   }
 
   /**
-   * Get Walkontable Selection instance created for controlling highlight of the currently selected/edited cell.
+   * Get Walkontable Selection instance created for controlling highlight of the currently
+   * focused cell (or header).
    *
    * @returns {Selection}
    */
-  getCell() {
-    return this.cell;
+  getFocus() {
+    return this.focus;
   }
 
   /**
@@ -136,24 +221,32 @@ class Highlight {
   }
 
   /**
-   * Get or create (if not exist in the cache) Walkontable Selection instance created for controlling highlight
-   * of the multiple selected cells.
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * `area` highlights.
    *
    * @returns {Selection}
    */
-  createOrGetArea() {
-    const layerLevel = this.layerLevel;
-    let area;
-    if (this.areas.has(layerLevel)) {
-      area = this.areas.get(layerLevel);
-    } else {
-      area = (0, _types.createHighlight)(_constants.AREA_TYPE, {
-        layerLevel,
-        ...this.options
-      });
-      this.areas.set(layerLevel, area);
-    }
-    return area;
+  createLayeredArea() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.layeredAreas, _areaLayered.createHighlight);
+  }
+
+  /**
+   * Get all Walkontable Selection instances which describes the state of the visual highlight of the cells.
+   *
+   * @returns {Selection[]}
+   */
+  getLayeredAreas() {
+    return [...this.layeredAreas.values()];
+  }
+
+  /**
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * `highlight` highlights.
+   *
+   * @returns {Selection}
+   */
+  createArea() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.areas, _area.createHighlight);
   }
 
   /**
@@ -166,23 +259,13 @@ class Highlight {
   }
 
   /**
-   * Get or create (if not exist in the cache) Walkontable Selection instance created for controlling highlight
-   * of the multiple selected header cells.
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * header highlight for rows.
    *
    * @returns {Selection}
    */
-  createOrGetHeader() {
-    const layerLevel = this.layerLevel;
-    let header;
-    if (this.headers.has(layerLevel)) {
-      header = this.headers.get(layerLevel);
-    } else {
-      header = (0, _types.createHighlight)(_constants.HEADER_TYPE, {
-        ...this.options
-      });
-      this.headers.set(layerLevel, header);
-    }
-    return header;
+  createRowHeader() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.rowHeaders, _header.createHighlight);
   }
 
   /**
@@ -190,28 +273,37 @@ class Highlight {
    *
    * @returns {Selection[]}
    */
-  getHeaders() {
-    return [...this.headers.values()];
+  getRowHeaders() {
+    return [...this.rowHeaders.values()];
   }
 
   /**
-   * Get or create (if not exist in the cache) Walkontable Selection instance created for controlling highlight
-   * of the multiple selected active header cells.
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * header highlight for columns.
    *
    * @returns {Selection}
    */
-  createOrGetActiveHeader() {
-    const layerLevel = this.layerLevel;
-    let header;
-    if (this.activeHeaders.has(layerLevel)) {
-      header = this.activeHeaders.get(layerLevel);
-    } else {
-      header = (0, _types.createHighlight)(_constants.ACTIVE_HEADER_TYPE, {
-        ...this.options
-      });
-      this.activeHeaders.set(layerLevel, header);
-    }
-    return header;
+  createColumnHeader() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.columnHeaders, _header.createHighlight);
+  }
+
+  /**
+   * Get all Walkontable Selection instances which describes the state of the visual highlight of the headers.
+   *
+   * @returns {Selection[]}
+   */
+  getColumnHeaders() {
+    return [...this.columnHeaders.values()];
+  }
+
+  /**
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * highlight for active row headers.
+   *
+   * @returns {Selection}
+   */
+  createActiveRowHeader() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.activeRowHeaders, _activeHeader.createHighlight);
   }
 
   /**
@@ -219,8 +311,84 @@ class Highlight {
    *
    * @returns {Selection[]}
    */
-  getActiveHeaders() {
-    return [...this.activeHeaders.values()];
+  getActiveRowHeaders() {
+    return [...this.activeRowHeaders.values()];
+  }
+
+  /**
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * highlight for active column headers.
+   *
+   * @returns {Selection}
+   */
+  createActiveColumnHeader() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.activeColumnHeaders, _activeHeader.createHighlight);
+  }
+
+  /**
+   * Get all Walkontable Selection instances which describes the state of the visual highlight of the active headers.
+   *
+   * @returns {Selection[]}
+   */
+  getActiveColumnHeaders() {
+    return [...this.activeColumnHeaders.values()];
+  }
+
+  /**
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * highlight for the headers corner.
+   *
+   * @returns {Selection}
+   */
+  createActiveCornerHeader() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.activeCornerHeaders, _activeHeader.createHighlight);
+  }
+
+  /**
+   * Get all Walkontable Selection instances which describes the state of the visual highlight of the headers corner.
+   *
+   * @returns {Selection[]}
+   */
+  getActiveCornerHeaders() {
+    return [...this.activeCornerHeaders.values()];
+  }
+
+  /**
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * highlight cells in a row.
+   *
+   * @returns {Selection}
+   */
+  createRowHighlight() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.rowHighlights, _row.createHighlight);
+  }
+
+  /**
+   * Get all Walkontable Selection instances which describes the state of the rows highlighting.
+   *
+   * @returns {Selection[]}
+   */
+  getRowHighlights() {
+    return [...this.rowHighlights.values()];
+  }
+
+  /**
+   * Creates (if not exist in the cache) Walkontable Selection instance created for controlling
+   * highlight cells in a column.
+   *
+   * @returns {Selection}
+   */
+  createColumnHighlight() {
+    return _classPrivateMethodGet(this, _createHighlight, _createHighlight2).call(this, this.columnHighlights, _column.createHighlight);
+  }
+
+  /**
+   * Get all Walkontable Selection instances which describes the state of the columns highlighting.
+   *
+   * @returns {Selection[]}
+   */
+  getColumnHighlights() {
+    return [...this.columnHighlights.values()];
   }
 
   /**
@@ -238,7 +406,7 @@ class Highlight {
    * @param {object} selectionInstance The selection instance.
    */
   addCustomSelection(selectionInstance) {
-    this.customSelections.push((0, _types.createHighlight)(_constants.CUSTOM_SELECTION_TYPE, {
+    this.customSelections.push((0, _customSelection.createHighlight)({
       ...this.options,
       ...selectionInstance
     }));
@@ -248,21 +416,37 @@ class Highlight {
    * Perform cleaning visual highlights for the whole table.
    */
   clear() {
-    this.cell.clear();
+    this.focus.clear();
     this.fill.clear();
     (0, _array.arrayEach)(this.areas.values(), highlight => void highlight.clear());
-    (0, _array.arrayEach)(this.headers.values(), highlight => void highlight.clear());
-    (0, _array.arrayEach)(this.activeHeaders.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.layeredAreas.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.rowHeaders.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.columnHeaders.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.activeRowHeaders.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.activeColumnHeaders.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.activeCornerHeaders.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.rowHighlights.values(), highlight => void highlight.clear());
+    (0, _array.arrayEach)(this.columnHighlights.values(), highlight => void highlight.clear());
   }
-
   /**
    * This object can be iterate over using `for of` syntax or using internal `arrayEach` helper.
    *
    * @returns {Selection[]}
    */
-  [Symbol.iterator]() {
-    return [this.cell, this.fill, ...this.areas.values(), ...this.headers.values(), ...this.activeHeaders.values(), ...this.customSelections][Symbol.iterator]();
+  [_Symbol$iterator]() {
+    return [this.focus, this.fill, ...this.areas.values(), ...this.layeredAreas.values(), ...this.rowHeaders.values(), ...this.columnHeaders.values(), ...this.activeRowHeaders.values(), ...this.activeColumnHeaders.values(), ...this.activeCornerHeaders.values(), ...this.rowHighlights.values(), ...this.columnHighlights.values(), ...this.customSelections][Symbol.iterator]();
+  }
+}
+function _createHighlight2(cacheMap, highlightFactory) {
+  const layerLevel = this.layerLevel;
+  if (cacheMap.has(layerLevel)) {
+    return cacheMap.get(layerLevel);
   }
+  const highlight = highlightFactory({
+    layerLevel,
+    ...this.options
+  });
+  cacheMap.set(layerLevel, highlight);
+  return highlight;
 }
-var _default = Highlight;
-exports.default = _default;
+var _default = exports.default = Highlight;