handsontable 11.0.0 → 12.0.0

package/editorManager.js

@@ -15,7 +15,11 @@ require("core-js/modules/es.array.from.js");
 require("core-js/modules/es.regexp.exec.js");
 
 exports.__esModule = true;
-exports.default = void 0;
+exports.default = exports.SHORTCUTS_GROUP_NAVIGATION = exports.SHORTCUTS_GROUP_EDITOR = void 0;
+
+require("core-js/modules/es.array.includes.js");
+
+require("core-js/modules/es.string.includes.js");
 
 require("core-js/modules/es.array.iterator.js");
 
@@ -27,8 +31,6 @@ require("core-js/modules/es.weak-map.js");
 
 require("core-js/modules/web.dom-collections.iterator.js");
 
-var _src = require("./3rdparty/walkontable/src");
-
 var _unicode = require("./helpers/unicode");
 
 var _event = require("./helpers/dom/event");
@@ -37,9 +39,7 @@ var _registry = require("./editors/registry");
 
 var _eventManager = _interopRequireDefault(require("./eventManager"));
 
-var _baseEditor = require("./editors/baseEditor");
-
-var _element = require("./helpers/dom/element");
+var _mixed = require("./helpers/mixed");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -59,7 +59,12 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+var SHORTCUTS_GROUP_NAVIGATION = 'editorManager.navigation';
+exports.SHORTCUTS_GROUP_NAVIGATION = SHORTCUTS_GROUP_NAVIGATION;
+var SHORTCUTS_GROUP_EDITOR = 'editorManager.handlingEditor';
+exports.SHORTCUTS_GROUP_EDITOR = SHORTCUTS_GROUP_EDITOR;
 
 var EditorManager = /*#__PURE__*/function () {
   /**
@@ -134,44 +139,97 @@ var EditorManager = /*#__PURE__*/function () {
      */
 
     this.cellProperties = void 0;
-    /**
-     * Keeps last keyCode pressed from the keydown event.
-     *
-     * @type {number}
-     */
-
-    this.lastKeyCode = void 0;
+    var shortcutManager = this.instance.getShortcutManager();
+    shortcutManager.addContext('editor');
+    this.registerShortcuts();
     this.instance.addHook('afterDocumentKeyDown', function (event) {
       return _this.onAfterDocumentKeyDown(event);
-    });
-    var frame = this.instance.rootWindow;
-
-    while (frame) {
-      this.eventManager.addEventListener(frame.document.documentElement, 'keydown', function (event) {
-        if (!_this.destroyed) {
-          _this.instance.runHooks('afterDocumentKeyDown', event);
-        }
-      });
-      frame = (0, _element.getParentWindow)(frame);
-    } // Open editor when text composition is started (IME editor)
-
+    }); // Open editor when text composition is started (IME editor)
 
     this.eventManager.addEventListener(this.instance.rootDocument.documentElement, 'compositionstart', function (event) {
       if (!_this.destroyed && _this.activeEditor && !_this.activeEditor.isOpened() && _this.instance.isListening()) {
         _this.openEditor('', event);
       }
     });
-    this.instance.view.wt.update('onCellDblClick', function (event, coords, elem) {
+
+    this.instance.view._wt.update('onCellDblClick', function (event, coords, elem) {
       return _this.onCellDblClick(event, coords, elem);
     });
   }
   /**
-   * Lock the editor from being prepared and closed. Locking the editor prevents its closing and
-   * reinitialized after selecting the new cell. This feature is necessary for a mobile editor.
+   * Register shortcuts responsible for handling some actions related to an editor.
+   *
+   * @private
    */
 
 
   _createClass(EditorManager, [{
+    key: "registerShortcuts",
+    value: function registerShortcuts() {
+      var _this2 = this;
+
+      var shortcutManager = this.instance.getShortcutManager();
+      var gridContext = shortcutManager.getContext('grid');
+      var editorContext = shortcutManager.getContext('editor');
+      var config = {
+        group: SHORTCUTS_GROUP_EDITOR
+      };
+      editorContext.addShortcuts([{
+        keys: [['Enter'], ['Enter', 'Shift'], ['Enter', 'Control/Meta'], ['Enter', 'Control/Meta', 'Shift']],
+        callback: function callback(event, keys) {
+          _this2.closeEditorAndSaveChanges(shortcutManager.isCtrlPressed());
+
+          _this2.moveSelectionAfterEnter(keys.includes('shift'));
+        }
+      }, {
+        keys: [['Escape'], ['Escape', 'Control/Meta']],
+        callback: function callback() {
+          _this2.closeEditorAndRestoreOriginalValue(shortcutManager.isCtrlPressed());
+
+          _this2.activeEditor.focus();
+        }
+      }], config);
+      gridContext.addShortcuts([{
+        keys: [['F2']],
+        callback: function callback(event) {
+          if (_this2.activeEditor) {
+            _this2.activeEditor.enableFullEditMode();
+          }
+
+          _this2.openEditor(null, event);
+        }
+      }, {
+        keys: [['Backspace'], ['Delete']],
+        callback: function callback() {
+          _this2.instance.emptySelectedCells();
+
+          _this2.prepareEditor();
+        }
+      }, {
+        keys: [['Enter'], ['Enter', 'Shift']],
+        callback: function callback(event, keys) {
+          if (_this2.instance.getSettings().enterBeginsEditing) {
+            if (_this2.cellProperties.readOnly) {
+              _this2.moveSelectionAfterEnter();
+            } else if (_this2.activeEditor) {
+              _this2.activeEditor.enableFullEditMode();
+
+              _this2.openEditor(null, event);
+            }
+          } else {
+            _this2.moveSelectionAfterEnter(keys.includes('shift'));
+          }
+
+          (0, _event.stopImmediatePropagation)(event); // required by HandsontableEditor
+        }
+      }], config);
+    }
+    /**
+     * Lock the editor from being prepared and closed. Locking the editor prevents its closing and
+     * reinitialized after selecting the new cell. This feature is necessary for a mobile editor.
+     */
+
+  }, {
     key: "lockEditor",
     value: function lockEditor() {
       this.lock = true;
@@ -218,7 +276,7 @@ var EditorManager = /*#__PURE__*/function () {
   }, {
     key: "prepareEditor",
     value: function prepareEditor() {
-      var _this2 = this;
+      var _this3 = this;
 
       if (this.lock) {
         return;
@@ -227,7 +285,7 @@ var EditorManager = /*#__PURE__*/function () {
       if (this.activeEditor && this.activeEditor.isWaiting()) {
         this.closeEditor(false, false, function (dataSaved) {
           if (dataSaved) {
-            _this2.prepareEditor();
+            _this3.prepareEditor();
           }
         });
         return;
@@ -375,71 +433,6 @@ var EditorManager = /*#__PURE__*/function () {
         this.selection.transformStart(enterMoves.row, enterMoves.col, true);
       }
     }
-    /**
-     * Controls selection behaviour after clicking `arrow up`.
-     *
-     * @private
-     * @param {boolean} isShiftPressed If `true`, then the selection will expand up.
-     */
-
-  }, {
-    key: "moveSelectionUp",
-    value: function moveSelectionUp(isShiftPressed) {
-      if (isShiftPressed) {
-        this.selection.transformEnd(-1, 0);
-      } else {
-        this.selection.transformStart(-1, 0);
-      }
-    }
-    /**
-     * Controls selection's behaviour after clicking `arrow down`.
-     *
-     * @private
-     * @param {boolean} isShiftPressed If `true`, then the selection will expand down.
-     */
-
-  }, {
-    key: "moveSelectionDown",
-    value: function moveSelectionDown(isShiftPressed) {
-      if (isShiftPressed) {
-        // expanding selection down with shift
-        this.selection.transformEnd(1, 0);
-      } else {
-        this.selection.transformStart(1, 0);
-      }
-    }
-    /**
-     * Controls selection's behaviour after clicking `arrow right`.
-     *
-     * @private
-     * @param {boolean} isShiftPressed If `true`, then the selection will expand right.
-     */
-
-  }, {
-    key: "moveSelectionRight",
-    value: function moveSelectionRight(isShiftPressed) {
-      if (isShiftPressed) {
-        this.selection.transformEnd(0, this.instance.getDirectionFactor());
-      } else {
-        this.selection.transformStart(0, this.instance.getDirectionFactor());
-      }
-    }
-    /**
-     * Controls selection's behaviour after clicking `arrow left`.
-     *
-     * @private
-     * @param {boolean} isShiftPressed If `true`, then the selection will expand left.
-     */
-
-  }, {
-    key: "moveSelectionLeft",
-    value: function moveSelectionLeft(isShiftPressed) {
-      if (isShiftPressed) {
-        this.selection.transformEnd(0, -1 * this.instance.getDirectionFactor());
-      } else {
-        this.selection.transformStart(0, -1 * this.instance.getDirectionFactor());
-      }
-    }
     /**
      * OnAfterDocumentKeyDown callback.
      *
@@ -450,24 +443,19 @@ var EditorManager = /*#__PURE__*/function () {
   }, {
     key: "onAfterDocumentKeyDown",
     value: function onAfterDocumentKeyDown(event) {
+      var _this4 = this;
+
       if (!this.instance.isListening()) {
         return;
       }
 
-      this.instance.runHooks('beforeKeyDown', event);
       var keyCode = event.keyCode; // keyCode 229 aka 'uninitialized' doesn't take into account with editors. This key code is produced when unfinished
       // character is entering (using IME editor). It is fired mainly on linux (ubuntu) with installed ibus-pinyin package.
 
-      if (this.destroyed || keyCode === 229) {
-        return;
-      }
-
-      if ((0, _event.isImmediatePropagationStopped)(event)) {
+      if (keyCode === 229) {
         return;
       }
 
-      this.lastKeyCode = keyCode;
-
       if (!this.selection.isSelected()) {
         return;
       } // catch CTRL but not right ALT (which in some systems triggers ALT+CTRL)
@@ -477,172 +465,37 @@ var EditorManager = /*#__PURE__*/function () {
 
       if (this.activeEditor && !this.activeEditor.isWaiting()) {
         if (!(0, _unicode.isFunctionKey)(keyCode) && !(0, _unicode.isCtrlMetaKey)(keyCode) && !isCtrlPressed && !this.isEditorOpened()) {
-          this.openEditor('', event);
-          return;
-        }
-      }
-
-      var isShiftPressed = event.shiftKey;
-      var rangeModifier = isShiftPressed ? this.selection.setRangeEnd : this.selection.setRangeStart;
-      var tabMoves;
-
-      switch (keyCode) {
-        case _unicode.KEY_CODES.A:
-          if (!this.isEditorOpened() && isCtrlPressed) {
-            this.instance.selectAll();
-            event.preventDefault();
-            event.stopPropagation();
-          }
-
-          break;
-
-        case _unicode.KEY_CODES.ARROW_UP:
-          if (this.isEditorOpened() && !this.activeEditor.isWaiting()) {
-            this.closeEditorAndSaveChanges(isCtrlPressed);
-          }
-
-          this.moveSelectionUp(isShiftPressed);
-          event.preventDefault();
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.ARROW_DOWN:
-          if (this.isEditorOpened() && !this.activeEditor.isWaiting()) {
-            this.closeEditorAndSaveChanges(isCtrlPressed);
-          }
-
-          this.moveSelectionDown(isShiftPressed);
-          event.preventDefault();
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.ARROW_RIGHT:
-          if (this.isEditorOpened() && !this.activeEditor.isWaiting()) {
-            this.closeEditorAndSaveChanges(isCtrlPressed);
-          }
-
-          this.moveSelectionRight(isShiftPressed);
-          event.preventDefault();
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.ARROW_LEFT:
-          if (this.isEditorOpened() && !this.activeEditor.isWaiting()) {
-            this.closeEditorAndSaveChanges(isCtrlPressed);
-          }
-
-          this.moveSelectionLeft(isShiftPressed);
-          event.preventDefault();
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.TAB:
-          tabMoves = typeof this.tableMeta.tabMoves === 'function' ? this.tableMeta.tabMoves(event) : this.tableMeta.tabMoves;
-
-          if (isShiftPressed) {
-            // move selection left
-            this.selection.transformStart(-tabMoves.row, -tabMoves.col);
-          } else {
-            // move selection right (add a new column if needed)
-            this.selection.transformStart(tabMoves.row, tabMoves.col, true);
-          }
-
-          event.preventDefault();
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.BACKSPACE:
-        case _unicode.KEY_CODES.DELETE:
-          this.instance.emptySelectedCells();
-          this.prepareEditor();
-          event.preventDefault();
-          break;
-
-        case _unicode.KEY_CODES.F2:
-          /* F2 */
-          if (this.activeEditor) {
-            this.activeEditor.enableFullEditMode();
-          }
-
-          this.openEditor(null, event);
-          event.preventDefault(); // prevent Opera from opening 'Go to Page dialog'
-
-          break;
-
-        case _unicode.KEY_CODES.ENTER:
-          /* return/enter */
-          if (this.isEditorOpened()) {
-            if (this.activeEditor && this.activeEditor.state !== _baseEditor.EDITOR_STATE.WAITING) {
-              this.closeEditorAndSaveChanges(isCtrlPressed);
+          var shortcutManager = this.instance.getShortcutManager();
+          var editorContext = shortcutManager.getContext('editor');
+          var runOnlySelectedConfig = {
+            runOnlyIf: function runOnlyIf() {
+              return (0, _mixed.isDefined)(_this4.instance.getSelected());
+            },
+            group: SHORTCUTS_GROUP_NAVIGATION
+          };
+          editorContext.addShortcuts([{
+            keys: [['ArrowUp']],
+            callback: function callback() {
+              _this4.instance.selection.transformStart(-1, 0);
             }
-
-            this.moveSelectionAfterEnter(isShiftPressed);
-          } else if (this.instance.getSettings().enterBeginsEditing) {
-            if (this.cellProperties.readOnly) {
-              this.moveSelectionAfterEnter();
-            } else if (this.activeEditor) {
-              this.activeEditor.enableFullEditMode();
-              this.openEditor(null, event);
+          }, {
+            keys: [['ArrowDown']],
+            callback: function callback() {
+              _this4.instance.selection.transformStart(1, 0);
             }
-          } else {
-            this.moveSelectionAfterEnter(isShiftPressed);
-          }
-
-          event.preventDefault(); // don't add newline to field
-
-          (0, _event.stopImmediatePropagation)(event); // required by HandsontableEditor
-
-          break;
-
-        case _unicode.KEY_CODES.ESCAPE:
-          if (this.isEditorOpened()) {
-            this.closeEditorAndRestoreOriginalValue(isCtrlPressed);
-            this.activeEditor.focus();
-          }
-
-          event.preventDefault();
-          break;
-
-        case _unicode.KEY_CODES.HOME:
-          if (event.ctrlKey || event.metaKey) {
-            rangeModifier.call(this.selection, new _src.CellCoords(this.instance.rowIndexMapper.getFirstNotHiddenIndex(0, 1), this.selection.selectedRange.current().from.col));
-          } else {
-            rangeModifier.call(this.selection, new _src.CellCoords(this.selection.selectedRange.current().from.row, this.instance.columnIndexMapper.getFirstNotHiddenIndex(0, 1)));
-          }
-
-          event.preventDefault(); // don't scroll the window
-
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.END:
-          if (event.ctrlKey || event.metaKey) {
-            rangeModifier.call(this.selection, new _src.CellCoords(this.instance.rowIndexMapper.getFirstNotHiddenIndex(this.instance.countRows() - 1, -1), this.selection.selectedRange.current().from.col));
-          } else {
-            rangeModifier.call(this.selection, new _src.CellCoords(this.selection.selectedRange.current().from.row, this.instance.columnIndexMapper.getFirstNotHiddenIndex(this.instance.countCols() - 1, -1)));
-          }
-
-          event.preventDefault(); // don't scroll the window
-
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.PAGE_UP:
-          this.selection.transformStart(-this.instance.countVisibleRows(), 0);
-          event.preventDefault(); // don't page up the window
-
-          event.stopPropagation();
-          break;
-
-        case _unicode.KEY_CODES.PAGE_DOWN:
-          this.selection.transformStart(this.instance.countVisibleRows(), 0);
-          event.preventDefault(); // don't page down the window
-
-          event.stopPropagation();
-          break;
-
-        default:
-          break;
+          }, {
+            keys: [['ArrowLeft']],
+            callback: function callback() {
+              _this4.instance.selection.transformStart(0, -1 * _this4.instance.getDirectionFactor());
+            }
+          }, {
+            keys: [['ArrowRight']],
+            callback: function callback() {
+              _this4.instance.selection.transformStart(0, _this4.instance.getDirectionFactor());
+            }
+          }], runOnlySelectedConfig);
+          this.openEditor('', event);
+        }
       }
     }
     /**