blockly 7.20211209.2 → 8.0.0

package/core/keyboard_nav/marker.js

@@ -26,105 +26,109 @@ const {MarkerSvg} = goog.requireType('Blockly.blockRendering.MarkerSvg');
 /**
  * Class for a marker.
  * This is used in keyboard navigation to save a location in the Blockly AST.
- * @constructor
  * @alias Blockly.Marker
  */
-const Marker = function() {
+class Marker {
   /**
-   * The colour of the marker.
-   * @type {?string}
+   * Constructs a new Marker instance.
    */
-  this.colour = null;
+  constructor() {
+    /**
+     * The colour of the marker.
+     * @type {?string}
+     */
+    this.colour = null;
+
+    /**
+     * The current location of the marker.
+     * @type {ASTNode}
+     * @private
+     */
+    this.curNode_ = null;
+
+    /**
+     * The object in charge of drawing the visual representation of the current
+     * node.
+     * @type {MarkerSvg}
+     * @private
+     */
+    this.drawer_ = null;
+
+    /**
+     * The type of the marker.
+     * @type {string}
+     */
+    this.type = 'marker';
+  }
 
   /**
-   * The current location of the marker.
-   * @type {ASTNode}
-   * @private
+   * Sets the object in charge of drawing the marker.
+   * @param {MarkerSvg} drawer The object in charge of
+   *     drawing the marker.
    */
-  this.curNode_ = null;
+  setDrawer(drawer) {
+    this.drawer_ = drawer;
+  }
 
   /**
-   * The object in charge of drawing the visual representation of the current
-   * node.
-   * @type {MarkerSvg}
-   * @private
+   * Get the current drawer for the marker.
+   * @return {MarkerSvg} The object in charge of drawing
+   *     the marker.
    */
-  this.drawer_ = null;
+  getDrawer() {
+    return this.drawer_;
+  }
 
   /**
-   * The type of the marker.
-   * @type {string}
+   * Gets the current location of the marker.
+   * @return {ASTNode} The current field, connection, or block the marker
+   *     is on.
    */
-  this.type = 'marker';
-};
-
-/**
- * Sets the object in charge of drawing the marker.
- * @param {MarkerSvg} drawer The object in charge of
- *     drawing the marker.
- */
-Marker.prototype.setDrawer = function(drawer) {
-  this.drawer_ = drawer;
-};
-
-/**
- * Get the current drawer for the marker.
- * @return {MarkerSvg} The object in charge of drawing
- *     the marker.
- */
-Marker.prototype.getDrawer = function() {
-  return this.drawer_;
-};
-
-/**
- * Gets the current location of the marker.
- * @return {ASTNode} The current field, connection, or block the marker
- *     is on.
- */
-Marker.prototype.getCurNode = function() {
-  return this.curNode_;
-};
+  getCurNode() {
+    return this.curNode_;
+  }
 
-/**
- * Set the location of the marker and call the update method.
- * Setting isStack to true will only work if the newLocation is the top most
- * output or previous connection on a stack.
- * @param {ASTNode} newNode The new location of the marker.
- */
-Marker.prototype.setCurNode = function(newNode) {
-  const oldNode = this.curNode_;
-  this.curNode_ = newNode;
-  if (this.drawer_) {
-    this.drawer_.draw(oldNode, this.curNode_);
+  /**
+   * Set the location of the marker and call the update method.
+   * Setting isStack to true will only work if the newLocation is the top most
+   * output or previous connection on a stack.
+   * @param {ASTNode} newNode The new location of the marker.
+   */
+  setCurNode(newNode) {
+    const oldNode = this.curNode_;
+    this.curNode_ = newNode;
+    if (this.drawer_) {
+      this.drawer_.draw(oldNode, this.curNode_);
+    }
   }
-};
 
-/**
- * Redraw the current marker.
- * @package
- */
-Marker.prototype.draw = function() {
-  if (this.drawer_) {
-    this.drawer_.draw(this.curNode_, this.curNode_);
+  /**
+   * Redraw the current marker.
+   * @package
+   */
+  draw() {
+    if (this.drawer_) {
+      this.drawer_.draw(this.curNode_, this.curNode_);
+    }
   }
-};
 
-/**
- * Hide the marker SVG.
- */
-Marker.prototype.hide = function() {
-  if (this.drawer_) {
-    this.drawer_.hide();
+  /**
+   * Hide the marker SVG.
+   */
+  hide() {
+    if (this.drawer_) {
+      this.drawer_.hide();
+    }
   }
-};
 
-/**
- * Dispose of this marker.
- */
-Marker.prototype.dispose = function() {
-  if (this.getDrawer()) {
-    this.getDrawer().dispose();
+  /**
+   * Dispose of this marker.
+   */
+  dispose() {
+    if (this.getDrawer()) {
+      this.getDrawer().dispose();
+    }
   }
-};
+}
 
 exports.Marker = Marker;

package/core/keyboard_nav/tab_navigate_cursor.js

@@ -17,7 +17,6 @@
  */
 goog.module('Blockly.TabNavigateCursor');
 
-const object = goog.require('Blockly.utils.object');
 const {ASTNode} = goog.require('Blockly.ASTNode');
 const {BasicCursor} = goog.require('Blockly.BasicCursor');
 /* eslint-disable-next-line no-unused-vars */
@@ -26,32 +25,28 @@ const {Field} = goog.requireType('Blockly.Field');
 
 /**
  * A cursor for navigating between tab navigable fields.
- * @constructor
  * @extends {BasicCursor}
  * @alias Blockly.TabNavigateCursor
  */
-const TabNavigateCursor = function() {
-  TabNavigateCursor.superClass_.constructor.call(this);
-};
-object.inherits(TabNavigateCursor, BasicCursor);
-
-/**
- * Skip all nodes except for tab navigable fields.
- * @param {?ASTNode} node The AST node to check whether it is valid.
- * @return {boolean} True if the node should be visited, false otherwise.
- * @override
- */
-TabNavigateCursor.prototype.validNode_ = function(node) {
-  let isValid = false;
-  const type = node && node.getType();
-  if (node) {
-    const location = /** @type {Field} */ (node.getLocation());
-    if (type === ASTNode.types.FIELD && location && location.isTabNavigable() &&
-        location.isClickable()) {
-      isValid = true;
+class TabNavigateCursor extends BasicCursor {
+  /**
+   * Skip all nodes except for tab navigable fields.
+   * @param {?ASTNode} node The AST node to check whether it is valid.
+   * @return {boolean} True if the node should be visited, false otherwise.
+   * @override
+   */
+  validNode_(node) {
+    let isValid = false;
+    const type = node && node.getType();
+    if (node) {
+      const location = /** @type {Field} */ (node.getLocation());
+      if (type === ASTNode.types.FIELD && location &&
+          location.isTabNavigable() && location.isClickable()) {
+        isValid = true;
+      }
     }
+    return isValid;
   }
-  return isValid;
-};
+}
 
 exports.TabNavigateCursor = TabNavigateCursor;

package/core/marker_manager.js

@@ -25,177 +25,189 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
 
 /**
  * Class to manage the multiple markers and the cursor on a workspace.
- * @param {!WorkspaceSvg} workspace The workspace for the marker manager.
- * @constructor
  * @alias Blockly.MarkerManager
- * @package
  */
-const MarkerManager = function(workspace) {
+class MarkerManager {
   /**
-   * The cursor.
-   * @type {?Cursor}
-   * @private
+   * @param {!WorkspaceSvg} workspace The workspace for the marker manager.
+   * @package
    */
-  this.cursor_ = null;
+  constructor(workspace) {
+    /**
+     * The cursor.
+     * @type {?Cursor}
+     * @private
+     */
+    this.cursor_ = null;
+
+    /**
+     * The cursor's SVG element.
+     * @type {?SVGElement}
+     * @private
+     */
+    this.cursorSvg_ = null;
+
+    /**
+     * The map of markers for the workspace.
+     * @type {!Object<string, !Marker>}
+     * @private
+     */
+    this.markers_ = Object.create(null);
+
+    /**
+     * The workspace this marker manager is associated with.
+     * @type {!WorkspaceSvg}
+     * @private
+     */
+    this.workspace_ = workspace;
+
+    /**
+     * The marker's SVG element.
+     * @type {?SVGElement}
+     * @private
+     */
+    this.markerSvg_ = null;
+  }
 
   /**
-   * The cursor's SVG element.
-   * @type {?SVGElement}
-   * @private
+   * Register the marker by adding it to the map of markers.
+   * @param {string} id A unique identifier for the marker.
+   * @param {!Marker} marker The marker to register.
    */
-  this.cursorSvg_ = null;
+  registerMarker(id, marker) {
+    if (this.markers_[id]) {
+      this.unregisterMarker(id);
+    }
+    marker.setDrawer(this.workspace_.getRenderer().makeMarkerDrawer(
+        this.workspace_, marker));
+    this.setMarkerSvg(marker.getDrawer().createDom());
+    this.markers_[id] = marker;
+  }
 
   /**
-   * The map of markers for the workspace.
-   * @type {!Object<string, !Marker>}
-   * @private
+   * Unregister the marker by removing it from the map of markers.
+   * @param {string} id The ID of the marker to unregister.
    */
-  this.markers_ = Object.create(null);
+  unregisterMarker(id) {
+    const marker = this.markers_[id];
+    if (marker) {
+      marker.dispose();
+      delete this.markers_[id];
+    } else {
+      throw Error(
+          'Marker with ID ' + id + ' does not exist. ' +
+          'Can only unregister markers that exist.');
+    }
+  }
 
   /**
-   * The workspace this marker manager is associated with.
-   * @type {!WorkspaceSvg}
-   * @private
+   * Get the cursor for the workspace.
+   * @return {?Cursor} The cursor for this workspace.
    */
-  this.workspace_ = workspace;
-};
-
-/**
- * The name of the local marker.
- * @type {string}
- * @const
- */
-MarkerManager.LOCAL_MARKER = 'local_marker_1';
-
-/**
- * Register the marker by adding it to the map of markers.
- * @param {string} id A unique identifier for the marker.
- * @param {!Marker} marker The marker to register.
- */
-MarkerManager.prototype.registerMarker = function(id, marker) {
-  if (this.markers_[id]) {
-    this.unregisterMarker(id);
+  getCursor() {
+    return this.cursor_;
   }
-  marker.setDrawer(
-      this.workspace_.getRenderer().makeMarkerDrawer(this.workspace_, marker));
-  this.setMarkerSvg(marker.getDrawer().createDom());
-  this.markers_[id] = marker;
-};
 
-/**
- * Unregister the marker by removing it from the map of markers.
- * @param {string} id The ID of the marker to unregister.
- */
-MarkerManager.prototype.unregisterMarker = function(id) {
-  const marker = this.markers_[id];
-  if (marker) {
-    marker.dispose();
-    delete this.markers_[id];
-  } else {
-    throw Error(
-        'Marker with ID ' + id + ' does not exist. ' +
-        'Can only unregister markers that exist.');
+  /**
+   * Get a single marker that corresponds to the given ID.
+   * @param {string} id A unique identifier for the marker.
+   * @return {?Marker} The marker that corresponds to the given ID,
+   *     or null if none exists.
+   */
+  getMarker(id) {
+    return this.markers_[id] || null;
   }
-};
 
-/**
- * Get the cursor for the workspace.
- * @return {?Cursor} The cursor for this workspace.
- */
-MarkerManager.prototype.getCursor = function() {
-  return this.cursor_;
-};
-
-/**
- * Get a single marker that corresponds to the given ID.
- * @param {string} id A unique identifier for the marker.
- * @return {?Marker} The marker that corresponds to the given ID,
- *     or null if none exists.
- */
-MarkerManager.prototype.getMarker = function(id) {
-  return this.markers_[id] || null;
-};
-
-/**
- * Sets the cursor and initializes the drawer for use with keyboard navigation.
- * @param {Cursor} cursor The cursor used to move around this workspace.
- */
-MarkerManager.prototype.setCursor = function(cursor) {
-  if (this.cursor_ && this.cursor_.getDrawer()) {
-    this.cursor_.getDrawer().dispose();
-  }
-  this.cursor_ = cursor;
-  if (this.cursor_) {
-    const drawer = this.workspace_.getRenderer().makeMarkerDrawer(
-        this.workspace_, this.cursor_);
-    this.cursor_.setDrawer(drawer);
-    this.setCursorSvg(this.cursor_.getDrawer().createDom());
+  /**
+   * Sets the cursor and initializes the drawer for use with keyboard
+   * navigation.
+   * @param {Cursor} cursor The cursor used to move around this workspace.
+   */
+  setCursor(cursor) {
+    if (this.cursor_ && this.cursor_.getDrawer()) {
+      this.cursor_.getDrawer().dispose();
+    }
+    this.cursor_ = cursor;
+    if (this.cursor_) {
+      const drawer = this.workspace_.getRenderer().makeMarkerDrawer(
+          this.workspace_, this.cursor_);
+      this.cursor_.setDrawer(drawer);
+      this.setCursorSvg(this.cursor_.getDrawer().createDom());
+    }
   }
-};
 
-/**
- * Add the cursor SVG to this workspace SVG group.
- * @param {?SVGElement} cursorSvg The SVG root of the cursor to be added to the
- *     workspace SVG group.
- * @package
- */
-MarkerManager.prototype.setCursorSvg = function(cursorSvg) {
-  if (!cursorSvg) {
-    this.cursorSvg_ = null;
-    return;
+  /**
+   * Add the cursor SVG to this workspace SVG group.
+   * @param {?SVGElement} cursorSvg The SVG root of the cursor to be added to
+   *     the workspace SVG group.
+   * @package
+   */
+  setCursorSvg(cursorSvg) {
+    if (!cursorSvg) {
+      this.cursorSvg_ = null;
+      return;
+    }
+
+    this.workspace_.getBlockCanvas().appendChild(cursorSvg);
+    this.cursorSvg_ = cursorSvg;
   }
 
-  this.workspace_.getBlockCanvas().appendChild(cursorSvg);
-  this.cursorSvg_ = cursorSvg;
-};
+  /**
+   * Add the marker SVG to this workspaces SVG group.
+   * @param {?SVGElement} markerSvg The SVG root of the marker to be added to
+   *     the workspace SVG group.
+   * @package
+   */
+  setMarkerSvg(markerSvg) {
+    if (!markerSvg) {
+      this.markerSvg_ = null;
+      return;
+    }
 
-/**
- * Add the marker SVG to this workspaces SVG group.
- * @param {?SVGElement} markerSvg The SVG root of the marker to be added to the
- *     workspace SVG group.
- * @package
- */
-MarkerManager.prototype.setMarkerSvg = function(markerSvg) {
-  if (!markerSvg) {
-    this.markerSvg_ = null;
-    return;
+    if (this.workspace_.getBlockCanvas()) {
+      if (this.cursorSvg_) {
+        this.workspace_.getBlockCanvas().insertBefore(
+            markerSvg, this.cursorSvg_);
+      } else {
+        this.workspace_.getBlockCanvas().appendChild(markerSvg);
+      }
+    }
   }
 
-  if (this.workspace_.getBlockCanvas()) {
-    if (this.cursorSvg_) {
-      this.workspace_.getBlockCanvas().insertBefore(markerSvg, this.cursorSvg_);
-    } else {
-      this.workspace_.getBlockCanvas().appendChild(markerSvg);
+  /**
+   * Redraw the attached cursor SVG if needed.
+   * @package
+   */
+  updateMarkers() {
+    if (this.workspace_.keyboardAccessibilityMode && this.cursorSvg_) {
+      this.workspace_.getCursor().draw();
     }
   }
-};
 
-/**
- * Redraw the attached cursor SVG if needed.
- * @package
- */
-MarkerManager.prototype.updateMarkers = function() {
-  if (this.workspace_.keyboardAccessibilityMode && this.cursorSvg_) {
-    this.workspace_.getCursor().draw();
+  /**
+   * Dispose of the marker manager.
+   * Go through and delete all markers associated with this marker manager.
+   * @suppress {checkTypes}
+   * @package
+   */
+  dispose() {
+    const markerIds = Object.keys(this.markers_);
+    for (let i = 0, markerId; (markerId = markerIds[i]); i++) {
+      this.unregisterMarker(markerId);
+    }
+    this.markers_ = null;
+    if (this.cursor_) {
+      this.cursor_.dispose();
+      this.cursor_ = null;
+    }
   }
-};
+}
 
 /**
- * Dispose of the marker manager.
- * Go through and delete all markers associated with this marker manager.
- * @suppress {checkTypes}
- * @package
+ * The name of the local marker.
+ * @type {string}
+ * @const
  */
-MarkerManager.prototype.dispose = function() {
-  const markerIds = Object.keys(this.markers_);
-  for (let i = 0, markerId; (markerId = markerIds[i]); i++) {
-    this.unregisterMarker(markerId);
-  }
-  this.markers_ = null;
-  if (this.cursor_) {
-    this.cursor_.dispose();
-    this.cursor_ = null;
-  }
-};
+MarkerManager.LOCAL_MARKER = 'local_marker_1';
 
 exports.MarkerManager = MarkerManager;