handsontable 11.0.0 → 12.0.0

package/plugins/comments/comments.js

@@ -1,6 +1,6 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 require("core-js/modules/es.object.set-prototype-of.js");
 
@@ -31,16 +31,12 @@ require("core-js/modules/es.weak-map.js");
 
 require("core-js/modules/web.dom-collections.iterator.js");
 
-require("core-js/modules/web.timers.js");
-
 var _element = require("../../helpers/dom/element");
 
 var _object = require("../../helpers/object");
 
 var _eventManager = _interopRequireDefault(require("../../eventManager"));
 
-var _src = require("../../3rdparty/walkontable/src");
-
 var _base = require("../base");
 
 var _commentEditor = _interopRequireDefault(require("./commentEditor"));
@@ -63,13 +59,13 @@ 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; }
 
-function _get(target, property, receiver) { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get; } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(receiver); } return desc.value; }; } return _get(target, property, receiver || target); }
+function _get() { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get; } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(arguments.length < 3 ? target : receiver); } return desc.value; }; } return _get.apply(this, arguments); }
 
 function _superPropBase(object, property) { while (!Object.prototype.hasOwnProperty.call(object, property)) { object = _getPrototypeOf(object); if (object === null) break; } return object; }
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
 
 function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 
@@ -150,8 +146,6 @@ var META_READONLY = 'readOnly';
  * ```
  */
 
-/* eslint-enable jsdoc/require-description-complete-sentence */
-
 var Comments = /*#__PURE__*/function (_BasePlugin) {
   _inherits(Comments, _BasePlugin);
 
@@ -195,23 +189,13 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
 
     _this.range = {};
     /**
+     * Prevents showing/hiding editor that reacts on the logic triggered by the "mouseover" events.
+     *
      * @private
      * @type {boolean}
      */
 
-    _this.mouseDown = false;
-    /**
-     * @private
-     * @type {boolean}
-     */
-
-    _this.contextMenuEvent = false;
-    /**
-     * @private
-     * @type {*}
-     */
-
-    _this.timer = null;
+    _this.preventEditorAutoSwitch = false;
     privatePool.set(_assertThisInitialized(_this), {
       tempEditorDimensions: {},
       cellBelowCursor: null
@@ -245,7 +229,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       }
 
       if (!this.editor) {
-        this.editor = new _commentEditor.default(this.hot.rootDocument);
+        this.editor = new _commentEditor.default(this.hot.rootDocument, this.hot.isRtl());
       }
 
       if (!this.eventManager) {
@@ -269,7 +253,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
         return _this2.hide();
       });
       this.addHook('afterBeginEditing', function () {
-        return _this2.onAfterBeginEditing();
+        return _this2.hide();
       });
       this.displaySwitch.addLocalHook('hide', function () {
         return _this2.hide();
@@ -282,7 +266,10 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       _get(_getPrototypeOf(Comments.prototype), "enablePlugin", this).call(this);
     }
     /**
-     * Updates the plugin state. This method is executed when {@link Core#updateSettings} is invoked.
+     * Updates the plugin's state.
+     *
+     * This method is executed when [`updateSettings()`](@/api/core.md#updatesettings) is invoked with any of the following configuration options:
+     *   - [`comments`](@/api/options.md#comments)
      */
 
   }, {
@@ -421,7 +408,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
     key: "setCommentAtCell",
     value: function setCommentAtCell(row, column, value) {
       this.setRange({
-        from: new _src.CellCoords(row, column)
+        from: this.hot._createCellCoords(row, column)
       });
       this.setComment(value);
     }
@@ -461,7 +448,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
     value: function removeCommentAtCell(row, column) {
       var forceRender = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
       this.setRange({
-        from: new _src.CellCoords(row, column)
+        from: this.hot._createCellCoords(row, column)
       });
       this.removeComment(forceRender);
     }
@@ -513,13 +500,9 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       }
 
       var meta = this.hot.getCellMeta(this.range.from.row, this.range.from.col);
-      this.refreshEditor(true);
       this.editor.setValue(meta[META_COMMENT] ? meta[META_COMMENT][META_COMMENT_VALUE] : null || '');
-
-      if (this.editor.hidden) {
-        this.editor.show();
-      }
-
+      this.editor.show();
+      this.refreshEditor(true);
       return true;
     }
     /**
@@ -534,7 +517,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
     key: "showAtCell",
     value: function showAtCell(row, column) {
       this.setRange({
-        from: new _src.CellCoords(row, column)
+        from: this.hot._createCellCoords(row, column)
       });
       return this.show();
     }
@@ -545,9 +528,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "hide",
     value: function hide() {
-      if (!this.editor.hidden) {
-        this.editor.hide();
-      }
+      this.editor.hide();
     }
     /**
      * Refreshes comment editor position and styling.
@@ -591,7 +572,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       renderableColumn = (_renderableColumn = renderableColumn) !== null && _renderableColumn !== void 0 ? _renderableColumn : 0;
       var _this$hot2 = this.hot,
           rootWindow = _this$hot2.rootWindow,
-          wt = _this$hot2.view.wt;
+          wt = _this$hot2.view._wt;
       var wtTable = wt.wtTable,
           wtOverlays = wt.wtOverlays,
           wtViewport = wt.wtViewport;
@@ -611,11 +592,18 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       }
 
       if (wtViewport.hasHorizontalScroll() && scrollableElement !== rootWindow) {
-        cellLeftOffset -= wtOverlays.leftOverlay.getScrollPosition();
+        cellLeftOffset -= wtOverlays.inlineStartOverlay.getScrollPosition() * (this.hot.isRtl() ? -1 : 1);
       }
 
-      var x = cellLeftOffset + lastColWidth;
       var y = cellTopOffset + lastRowHeight;
+      var x = cellLeftOffset;
+
+      if (this.hot.isRtl()) {
+        x -= this.editor.getSize().width;
+      } else {
+        x += lastColWidth;
+      }
+
       var commentStyle = this.getCommentMeta(visualRow, visualColumn, META_STYLE);
       var readOnly = this.getCommentMeta(visualRow, visualColumn, META_READONLY);
 
@@ -645,7 +633,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       }
 
       var hasComment = false;
-      var cell = selected.getTopLeftCorner(); // IN EXCEL THERE IS COMMENT ONLY FOR TOP LEFT CELL IN SELECTION
+      var cell = selected.getTopStartCorner(); // IN EXCEL THERE IS COMMENT ONLY FOR TOP LEFT CELL IN SELECTION
 
       if (this.getCommentMeta(cell.row, cell.col, META_COMMENT_VALUE)) {
         hasComment = true;
@@ -706,30 +694,22 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onMouseDown",
     value: function onMouseDown(event) {
-      this.mouseDown = true;
-
-      if (!this.hot.view || !this.hot.view.wt) {
+      if (!this.hot.view || !this.hot.view._wt) {
         return;
       }
 
-      if (!this.contextMenuEvent && !this.targetIsCommentTextArea(event)) {
+      if (!this.preventEditorAutoSwitch && !this.targetIsCommentTextArea(event)) {
         var eventCell = (0, _element.closest)(event.target, 'TD', 'TBODY');
         var coordinates = null;
 
         if (eventCell) {
-          coordinates = this.hot.view.wt.wtTable.getCoords(eventCell);
-          coordinates = {
-            row: this.hot.rowIndexMapper.getVisualFromRenderableIndex(coordinates.row),
-            col: this.hot.columnIndexMapper.getVisualFromRenderableIndex(coordinates.col)
-          };
+          coordinates = this.hot.getCoords(eventCell);
         }
 
         if (!eventCell || this.range.from && coordinates && (this.range.from.row !== coordinates.row || this.range.from.col !== coordinates.col)) {
           this.hide();
         }
       }
-
-      this.contextMenuEvent = false;
     }
     /**
      * `mouseover` event callback.
@@ -743,17 +723,16 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
     value: function onMouseOver(event) {
       var priv = privatePool.get(this);
       var rootDocument = this.hot.rootDocument;
-      priv.cellBelowCursor = rootDocument.elementFromPoint(event.clientX, event.clientY);
 
-      if (this.mouseDown || this.editor.isFocused() || (0, _element.hasClass)(event.target, 'wtBorder') || priv.cellBelowCursor !== event.target || !this.editor) {
+      if (this.preventEditorAutoSwitch || this.editor.isFocused() || (0, _element.hasClass)(event.target, 'wtBorder') || priv.cellBelowCursor === event.target || !this.editor) {
         return;
       }
 
+      priv.cellBelowCursor = rootDocument.elementFromPoint(event.clientX, event.clientY);
+
       if (this.targetIsCellWithComment(event)) {
-        var coordinates = this.hot.view.wt.wtTable.getCoords(event.target);
-        var range = {
-          from: new _src.CellCoords(this.hot.rowIndexMapper.getVisualFromRenderableIndex(coordinates.row), this.hot.columnIndexMapper.getVisualFromRenderableIndex(coordinates.col))
-        };
+        var range = this.hot._createCellRange(this.hot.getCoords(event.target));
+
         this.displaySwitch.show(range);
       } else if ((0, _element.isChildOf)(event.target, rootDocument) && !this.targetIsCommentTextArea(event)) {
         this.displaySwitch.hide();
@@ -768,7 +747,7 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onMouseUp",
     value: function onMouseUp() {
-      this.mouseDown = false;
+      this.preventEditorAutoSwitch = false;
     }
     /**
      * The `afterRenderer` hook callback.
@@ -842,22 +821,15 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onContextMenuAddComment",
     value: function onContextMenuAddComment() {
-      var _this4 = this;
-
-      this.displaySwitch.cancelHiding();
       var coords = this.hot.getSelectedRangeLast();
-      this.contextMenuEvent = true;
+      this.preventEditorAutoSwitch = true;
+      this.displaySwitch.cancelHiding();
       this.setRange({
         from: coords.highlight
       });
       this.show();
-      setTimeout(function () {
-        if (_this4.hot) {
-          _this4.hot.deselectCell();
-
-          _this4.editor.focus();
-        }
-      }, 10);
+      this.hot.deselectCell();
+      this.editor.focus();
     }
     /**
      * Context Menu's "remove comment" callback.
@@ -868,13 +840,13 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onContextMenuRemoveComment",
     value: function onContextMenuRemoveComment() {
-      var _this5 = this;
+      var _this4 = this;
 
       var coords = this.hot.getSelectedRangeLast();
-      this.contextMenuEvent = true;
+      this.preventEditorAutoSwitch = true;
       coords.forAll(function (row, column) {
         if (row >= 0 && column >= 0) {
-          _this5.removeCommentAtCell(row, column, false);
+          _this4.removeCommentAtCell(row, column, false);
         }
       });
       this.hot.render();
@@ -888,15 +860,15 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onContextMenuMakeReadOnly",
     value: function onContextMenuMakeReadOnly() {
-      var _this6 = this;
+      var _this5 = this;
 
       var coords = this.hot.getSelectedRangeLast();
-      this.contextMenuEvent = true;
+      this.preventEditorAutoSwitch = true;
       coords.forAll(function (row, column) {
         if (row >= 0 && column >= 0) {
-          var currentState = !!_this6.getCommentMeta(row, column, META_READONLY);
+          var currentState = !!_this5.getCommentMeta(row, column, META_READONLY);
 
-          _this6.updateCommentMeta(row, column, _defineProperty({}, META_READONLY, !currentState));
+          _this5.updateCommentMeta(row, column, _defineProperty({}, META_READONLY, !currentState));
         }
       });
     }
@@ -910,10 +882,10 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "addToContextMenu",
     value: function addToContextMenu(defaultOptions) {
-      var _this7 = this;
+      var _this6 = this;
 
       var isThereAnyCellRendered = function isThereAnyCellRendered() {
-        return _this7.hot.rowIndexMapper.getRenderableIndexesLength() > 0 && _this7.hot.columnIndexMapper.getRenderableIndexesLength() > 0;
+        return _this6.hot.rowIndexMapper.getRenderableIndexesLength() > 0 && _this6.hot.columnIndexMapper.getRenderableIndexesLength() > 0;
       };
 
       defaultOptions.items.push({
@@ -921,21 +893,21 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       }, {
         key: 'commentsAddEdit',
         name: function name() {
-          if (_this7.checkSelectionCommentsConsistency()) {
-            return _this7.hot.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_EDIT_COMMENT);
+          if (_this6.checkSelectionCommentsConsistency()) {
+            return _this6.hot.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_EDIT_COMMENT);
           }
 
-          return _this7.hot.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_ADD_COMMENT);
+          return _this6.hot.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_ADD_COMMENT);
         },
         callback: function callback() {
-          return _this7.onContextMenuAddComment();
+          return _this6.onContextMenuAddComment();
         },
         disabled: function disabled() {
           if (!isThereAnyCellRendered()) {
             return true;
           }
 
-          return !(_this7.hot.getSelectedLast() && !_this7.hot.selection.isSelectedByCorner());
+          return !(_this6.hot.getSelectedLast() && !_this6.hot.selection.isSelectedByCorner());
         }
       }, {
         key: 'commentsRemove',
@@ -943,23 +915,23 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
           return this.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_REMOVE_COMMENT);
         },
         callback: function callback() {
-          return _this7.onContextMenuRemoveComment();
+          return _this6.onContextMenuRemoveComment();
         },
         disabled: function disabled() {
           if (!isThereAnyCellRendered()) {
             return true;
           }
 
-          return !(_this7.hot.getSelectedLast() && !_this7.hot.selection.isSelectedByCorner());
+          return !(_this6.hot.getSelectedLast() && !_this6.hot.selection.isSelectedByCorner());
         }
       }, {
         key: 'commentsReadOnly',
         name: function name() {
-          var _this8 = this;
+          var _this7 = this;
 
           var label = this.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_READ_ONLY_COMMENT);
           var hasProperty = (0, _utils.checkSelectionConsistency)(this.getSelectedRangeLast(), function (row, col) {
-            var readOnlyProperty = _this8.getCellMeta(row, col)[META_COMMENT];
+            var readOnlyProperty = _this7.getCellMeta(row, col)[META_COMMENT];
 
             if (readOnlyProperty) {
               readOnlyProperty = readOnlyProperty[META_READONLY];
@@ -977,14 +949,14 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
           return label;
         },
         callback: function callback() {
-          return _this7.onContextMenuMakeReadOnly();
+          return _this6.onContextMenuMakeReadOnly();
         },
         disabled: function disabled() {
           if (!isThereAnyCellRendered()) {
             return true;
           }
 
-          return !(_this7.hot.getSelectedLast() && !_this7.hot.selection.isSelectedByCorner()) || !_this7.checkSelectionCommentsConsistency();
+          return !(_this6.hot.getSelectedLast() && !_this6.hot.selection.isSelectedByCorner()) || !_this6.checkSelectionCommentsConsistency();
         }
       });
     }
@@ -1003,19 +975,6 @@ var Comments = /*#__PURE__*/function (_BasePlugin) {
       if ((0, _object.isObject)(commentSetting)) {
         return commentSetting.displayDelay;
       }
-
-      return void 0;
-    }
-    /**
-     * `afterBeginEditing` hook callback.
-     *
-     * @private
-     */
-
-  }, {
-    key: "onAfterBeginEditing",
-    value: function onAfterBeginEditing() {
-      this.hide();
     }
     /**
      * Destroys the plugin instance.