blockly 7.20211209.2 → 8.0.0

package/core/contextmenu_registry.js

@@ -25,21 +25,102 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
  * Class for the registry of context menu items. This is intended to be a
  * singleton. You should not create a new instance, and only access this class
  * from ContextMenuRegistry.registry.
- * @constructor
- * @private
  * @alias Blockly.ContextMenuRegistry
  */
-const ContextMenuRegistry = function() {
-  // Singleton instance should be registered once.
-  ContextMenuRegistry.registry = this;
+class ContextMenuRegistry {
+  /**
+   * Resets the existing singleton instance of ContextMenuRegistry.
+   */
+  constructor() {
+    this.reset();
+  }
 
   /**
-   * Registry of all registered RegistryItems, keyed by ID.
-   * @type {!Object<string, !ContextMenuRegistry.RegistryItem>}
-   * @private
+   * Clear and recreate the registry.
    */
-  this.registry_ = Object.create(null);
-};
+  reset() {
+    /**
+     * Registry of all registered RegistryItems, keyed by ID.
+     * @type {!Object<string, !ContextMenuRegistry.RegistryItem>}
+     * @private
+     */
+    this.registry_ = Object.create(null);
+  }
+
+  /**
+   * Registers a RegistryItem.
+   * @param {!ContextMenuRegistry.RegistryItem} item Context menu item to
+   *     register.
+   * @throws {Error} if an item with the given ID already exists.
+   */
+  register(item) {
+    if (this.registry_[item.id]) {
+      throw Error('Menu item with ID "' + item.id + '" is already registered.');
+    }
+    this.registry_[item.id] = item;
+  }
+
+  /**
+   * Unregisters a RegistryItem with the given ID.
+   * @param {string} id The ID of the RegistryItem to remove.
+   * @throws {Error} if an item with the given ID does not exist.
+   */
+  unregister(id) {
+    if (!this.registry_[id]) {
+      throw new Error('Menu item with ID "' + id + '" not found.');
+    }
+    delete this.registry_[id];
+  }
+
+  /**
+   * @param {string} id The ID of the RegistryItem to get.
+   * @return {?ContextMenuRegistry.RegistryItem} RegistryItem or null if not
+   *     found
+   */
+  getItem(id) {
+    return this.registry_[id] || null;
+  }
+
+  /**
+   * Gets the valid context menu options for the given scope type (e.g. block or
+   * workspace) and scope. Blocks are only shown if the preconditionFn shows
+   * they should not be hidden.
+   * @param {!ContextMenuRegistry.ScopeType} scopeType Type of scope where menu
+   *     should be shown (e.g. on a block or on a workspace)
+   * @param {!ContextMenuRegistry.Scope} scope Current scope of context menu
+   *     (i.e., the exact workspace or block being clicked on)
+   * @return {!Array<!ContextMenuRegistry.ContextMenuOption>} the list of
+   *     ContextMenuOptions
+   */
+  getContextMenuOptions(scopeType, scope) {
+    const menuOptions = [];
+    const registry = this.registry_;
+    Object.keys(registry).forEach(function(id) {
+      const item = registry[id];
+      if (scopeType === item.scopeType) {
+        const precondition = item.preconditionFn(scope);
+        if (precondition !== 'hidden') {
+          const displayText = typeof item.displayText === 'function' ?
+              item.displayText(scope) :
+              item.displayText;
+          /** @type {!ContextMenuRegistry.ContextMenuOption} */
+          const menuOption = {
+            text: displayText,
+            enabled: (precondition === 'enabled'),
+            callback: item.callback,
+            scope: scope,
+            weight: item.weight,
+          };
+          menuOptions.push(menuOption);
+        }
+      }
+    });
+    menuOptions.sort(function(a, b) {
+      return a.weight - b.weight;
+    });
+    return menuOptions;
+  }
+}
 
 /**
  * Where this menu item should be rendered. If the menu item should be rendered
@@ -90,85 +171,8 @@ ContextMenuRegistry.ContextMenuOption;
 /**
  * Singleton instance of this class. All interactions with this class should be
  * done on this object.
- * @type {?ContextMenuRegistry}
- */
-ContextMenuRegistry.registry = null;
-
-/**
- * Registers a RegistryItem.
- * @param {!ContextMenuRegistry.RegistryItem} item Context menu item to
- *     register.
- * @throws {Error} if an item with the given ID already exists.
- */
-ContextMenuRegistry.prototype.register = function(item) {
-  if (this.registry_[item.id]) {
-    throw Error('Menu item with ID "' + item.id + '" is already registered.');
-  }
-  this.registry_[item.id] = item;
-};
-
-/**
- * Unregisters a RegistryItem with the given ID.
- * @param {string} id The ID of the RegistryItem to remove.
- * @throws {Error} if an item with the given ID does not exist.
- */
-ContextMenuRegistry.prototype.unregister = function(id) {
-  if (!this.registry_[id]) {
-    throw new Error('Menu item with ID "' + id + '" not found.');
-  }
-  delete this.registry_[id];
-};
-
-/**
- * @param {string} id The ID of the RegistryItem to get.
- * @return {?ContextMenuRegistry.RegistryItem} RegistryItem or null if not found
+ * @type {!ContextMenuRegistry}
  */
-ContextMenuRegistry.prototype.getItem = function(id) {
-  return this.registry_[id] || null;
-};
-
-/**
- * Gets the valid context menu options for the given scope type (e.g. block or
- * workspace) and scope. Blocks are only shown if the preconditionFn shows they
- * should not be hidden.
- * @param {!ContextMenuRegistry.ScopeType} scopeType Type of scope where menu
- *     should be shown (e.g. on a block or on a workspace)
- * @param {!ContextMenuRegistry.Scope} scope Current scope of context menu
- *     (i.e., the exact workspace or block being clicked on)
- * @return {!Array<!ContextMenuRegistry.ContextMenuOption>} the list of
- *     ContextMenuOptions
- */
-ContextMenuRegistry.prototype.getContextMenuOptions = function(
-    scopeType, scope) {
-  const menuOptions = [];
-  const registry = this.registry_;
-  Object.keys(registry).forEach(function(id) {
-    const item = registry[id];
-    if (scopeType === item.scopeType) {
-      const precondition = item.preconditionFn(scope);
-      if (precondition !== 'hidden') {
-        const displayText = typeof item.displayText === 'function' ?
-            item.displayText(scope) :
-            item.displayText;
-        /** @type {!ContextMenuRegistry.ContextMenuOption} */
-        const menuOption = {
-          text: displayText,
-          enabled: (precondition === 'enabled'),
-          callback: item.callback,
-          scope: scope,
-          weight: item.weight,
-        };
-        menuOptions.push(menuOption);
-      }
-    }
-  });
-  menuOptions.sort(function(a, b) {
-    return a.weight - b.weight;
-  });
-  return menuOptions;
-};
-
-// Creates and assigns the singleton instance.
-new ContextMenuRegistry();
+ContextMenuRegistry.registry = new ContextMenuRegistry();
 
 exports.ContextMenuRegistry = ContextMenuRegistry;