blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/workspace_comment_svg.ts

@@ -1,1127 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing a code comment on a rendered workspace.
- */
-
-/**
- * Object representing a code comment on a rendered workspace.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.WorkspaceCommentSvg');
-
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './events/events_comment_create.js';
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './events/events_comment_delete.js';
-// Unused import preserved for side-effects. Remove if unneeded.
-import './events/events_selected.js';
-
-import type {BlockDragSurfaceSvg} from './block_drag_surface.js';
-import * as browserEvents from './browser_events.js';
-import * as common from './common.js';
-// import * as ContextMenu from './contextmenu.js';
-import * as Css from './css.js';
-import type {CommentMove} from './events/events_comment_move.js';
-import * as eventUtils from './events/utils.js';
-import type {IBoundedElement} from './interfaces/i_bounded_element.js';
-import type {IBubble} from './interfaces/i_bubble.js';
-import type {CopyData, ICopyable} from './interfaces/i_copyable.js';
-import * as Touch from './touch.js';
-import {Coordinate} from './utils/coordinate.js';
-import * as dom from './utils/dom.js';
-import {Rect} from './utils/rect.js';
-import {Svg} from './utils/svg.js';
-import * as svgMath from './utils/svg_math.js';
-import {WorkspaceComment} from './workspace_comment.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-
-
-/** Size of the resize icon. */
-const RESIZE_SIZE = 8;
-
-/** Radius of the border around the comment. */
-const BORDER_RADIUS = 3;
-
-/** Offset from the foreignobject edge to the textarea edge. */
-const TEXTAREA_OFFSET = 2;
-
-/**
- * Class for a workspace comment's SVG representation.
- * @alias Blockly.WorkspaceCommentSvg
- */
-export class WorkspaceCommentSvg extends WorkspaceComment implements
-    IBoundedElement, IBubble, ICopyable {
-  /**
-   * The width and height to use to size a workspace comment when it is first
-   * added, before it has been edited by the user.
-   * @internal
-   */
-  static DEFAULT_SIZE = 100;
-
-  /** Offset from the top to make room for a top bar. */
-  private static readonly TOP_OFFSET = 10;
-  override workspace: WorkspaceSvg;
-
-  /** Mouse up event data. */
-  private onMouseUpWrapper_: browserEvents.Data|null = null;
-
-  /** Mouse move event data. */
-  private onMouseMoveWrapper_: browserEvents.Data|null = null;
-
-  /** Whether event handlers have been initialized. */
-  private eventsInit_ = false;
-  private textarea_: HTMLTextAreaElement|null = null;
-
-  private svgRectTarget_: SVGRectElement|null = null;
-
-  private svgHandleTarget_: SVGRectElement|null = null;
-
-  private foreignObject_: SVGForeignObjectElement|null = null;
-
-  private resizeGroup_: SVGGElement|null = null;
-
-  private deleteGroup_: SVGGElement|null = null;
-
-  private deleteIconBorder_: SVGCircleElement|null = null;
-
-  private focused_ = false;
-  private autoLayout_ = false;
-  // Create core elements for the block.
-  private readonly svgGroup_: SVGElement;
-  svgRect_: AnyDuringMigration;
-
-  /** Whether the comment is rendered onscreen and is a part of the DOM. */
-  private rendered_ = false;
-  private readonly useDragSurface_: boolean;
-
-  /**
-   * @param workspace The block's workspace.
-   * @param content The content of this workspace comment.
-   * @param height Height of the comment.
-   * @param width Width of the comment.
-   * @param opt_id Optional ID.  Use this ID if provided, otherwise create a new
-   *     ID.
-   */
-  constructor(
-      workspace: WorkspaceSvg, content: string, height: number, width: number,
-      opt_id?: string) {
-    super(workspace, content, height, width, opt_id);
-    this.svgGroup_ = dom.createSvgElement(Svg.G, {'class': 'blocklyComment'});
-    (this.svgGroup_ as AnyDuringMigration).translate_ = '';
-    this.workspace = workspace;
-
-    this.svgRect_ = dom.createSvgElement(Svg.RECT, {
-      'class': 'blocklyCommentRect',
-      'x': 0,
-      'y': 0,
-      'rx': BORDER_RADIUS,
-      'ry': BORDER_RADIUS,
-    });
-    this.svgGroup_.appendChild(this.svgRect_);
-
-    /**
-     * Whether to move the comment to the drag surface when it is dragged.
-     * True if it should move, false if it should be translated directly.
-     */
-    this.useDragSurface_ =
-        svgMath.is3dSupported() && !!workspace.getBlockDragSurface();
-
-    this.render();
-  }
-
-  /**
-   * Dispose of this comment.
-   * @internal
-   */
-  override dispose() {
-    if (this.disposed_) {
-      return;
-    }
-    // If this comment is being dragged, unlink the mouse events.
-    if (common.getSelected() === this) {
-      this.unselect();
-      this.workspace.cancelCurrentGesture();
-    }
-
-    if (eventUtils.isEnabled()) {
-      eventUtils.fire(new (eventUtils.get(eventUtils.COMMENT_DELETE))!(this));
-    }
-
-    dom.removeNode(this.svgGroup_);
-    // Dispose of any rendered components
-    this.disposeInternal_();
-
-    eventUtils.disable();
-    super.dispose();
-    eventUtils.enable();
-  }
-
-  /**
-   * Create and initialize the SVG representation of a workspace comment.
-   * May be called more than once.
-   *
-   * @param opt_noSelect Text inside text area will be selected if false
-   * @internal
-   */
-  initSvg(opt_noSelect?: boolean) {
-    if (!this.workspace.rendered) {
-      throw TypeError('Workspace is headless.');
-    }
-    if (!this.workspace.options.readOnly && !this.eventsInit_) {
-      browserEvents.conditionalBind(
-          this.svgRectTarget_ as SVGRectElement, 'mousedown', this,
-          this.pathMouseDown_);
-      browserEvents.conditionalBind(
-          this.svgHandleTarget_ as SVGRectElement, 'mousedown', this,
-          this.pathMouseDown_);
-    }
-    this.eventsInit_ = true;
-
-    this.updateMovable();
-    if (!this.getSvgRoot().parentNode) {
-      this.workspace.getBubbleCanvas().appendChild(this.getSvgRoot());
-    }
-
-    if (!opt_noSelect && this.textarea_) {
-      this.textarea_.select();
-    }
-  }
-
-  /**
-   * Handle a mouse-down on an SVG comment.
-   * @param e Mouse down event or touch start event.
-   */
-  private pathMouseDown_(e: Event) {
-    const gesture = this.workspace.getGesture(e);
-    if (gesture) {
-      gesture.handleBubbleStart(e, this);
-    }
-  }
-
-  /**
-   * Show the context menu for this workspace comment.
-   * @param e Mouse event.
-   * @internal
-   */
-  showContextMenu(e: Event) {
-    throw new Error(
-        'The implementation of showContextMenu should be ' +
-        'monkey-patched in by blockly.ts');
-  }
-
-  /**
-   * Select this comment.  Highlight it visually.
-   * @internal
-   */
-  select() {
-    if (common.getSelected() === this) {
-      return;
-    }
-    let oldId = null;
-    if (common.getSelected()) {
-      oldId = common.getSelected()!.id;
-      // Unselect any previously selected block.
-      eventUtils.disable();
-      try {
-        common.getSelected()!.unselect();
-      } finally {
-        eventUtils.enable();
-      }
-    }
-    const event = new (eventUtils.get(eventUtils.SELECTED))!
-        (oldId, this.id, this.workspace.id);
-    eventUtils.fire(event);
-    common.setSelected(this);
-    this.addSelect();
-  }
-
-  /**
-   * Unselect this comment.  Remove its highlighting.
-   * @internal
-   */
-  unselect() {
-    if (common.getSelected() !== this) {
-      return;
-    }
-    const event = new (eventUtils.get(eventUtils.SELECTED))!
-        (this.id, null, this.workspace.id);
-    eventUtils.fire(event);
-    common.setSelected(null);
-    this.removeSelect();
-    this.blurFocus();
-  }
-
-  /**
-   * Select this comment.  Highlight it visually.
-   * @internal
-   */
-  addSelect() {
-    dom.addClass(this.svgGroup_ as Element, 'blocklySelected');
-    this.setFocus();
-  }
-
-  /**
-   * Unselect this comment.  Remove its highlighting.
-   * @internal
-   */
-  removeSelect() {
-    dom.removeClass(this.svgGroup_ as Element, 'blocklySelected');
-    this.blurFocus();
-  }
-
-  /**
-   * Focus this comment.  Highlight it visually.
-   * @internal
-   */
-  addFocus() {
-    dom.addClass(this.svgGroup_ as Element, 'blocklyFocused');
-  }
-
-  /**
-   * Unfocus this comment.  Remove its highlighting.
-   * @internal
-   */
-  removeFocus() {
-    dom.removeClass(this.svgGroup_ as Element, 'blocklyFocused');
-  }
-
-  /**
-   * Return the coordinates of the top-left corner of this comment relative to
-   * the drawing surface's origin (0,0), in workspace units.
-   * If the comment is on the workspace, (0, 0) is the origin of the workspace
-   * coordinate system.
-   * This does not change with workspace scale.
-   * @return Object with .x and .y properties in workspace coordinates.
-   * @internal
-   */
-  getRelativeToSurfaceXY(): Coordinate {
-    let x = 0;
-    let y = 0;
-
-    const dragSurfaceGroup = this.useDragSurface_ ?
-        this.workspace.getBlockDragSurface()!.getGroup() :
-        null;
-
-    let element = this.getSvgRoot();
-    if (element) {
-      do {
-        // Loop through this comment and every parent.
-        const xy = svgMath.getRelativeXY(element as Element);
-        x += xy.x;
-        y += xy.y;
-        // If this element is the current element on the drag surface, include
-        // the translation of the drag surface itself.
-        if (this.useDragSurface_ &&
-            this.workspace.getBlockDragSurface()!.getCurrentBlock() ===
-                element) {
-          const surfaceTranslation =
-              this.workspace.getBlockDragSurface()!.getSurfaceTranslation();
-          x += surfaceTranslation.x;
-          y += surfaceTranslation.y;
-        }
-        // AnyDuringMigration because:  Type 'ParentNode | null' is not
-        // assignable to type 'SVGElement'.
-        element = element.parentNode as AnyDuringMigration;
-      } while (element && element !== this.workspace.getBubbleCanvas() &&
-               element !== dragSurfaceGroup);
-    }
-    this.xy_ = new Coordinate(x, y);
-    return this.xy_;
-  }
-
-  /**
-   * Move a comment by a relative offset.
-   * @param dx Horizontal offset, in workspace units.
-   * @param dy Vertical offset, in workspace units.
-   * @internal
-   */
-  override moveBy(dx: number, dy: number) {
-    const event =
-        new (eventUtils.get(eventUtils.COMMENT_MOVE))!(this) as CommentMove;
-    // TODO: Do I need to look up the relative to surface XY position here?
-    const xy = this.getRelativeToSurfaceXY();
-    this.translate(xy.x + dx, xy.y + dy);
-    this.xy_ = new Coordinate(xy.x + dx, xy.y + dy);
-    event.recordNew();
-    eventUtils.fire(event);
-    this.workspace.resizeContents();
-  }
-
-  /**
-   * Transforms a comment by setting the translation on the transform attribute
-   * of the block's SVG.
-   * @param x The x coordinate of the translation in workspace units.
-   * @param y The y coordinate of the translation in workspace units.
-   * @internal
-   */
-  translate(x: number, y: number) {
-    this.xy_ = new Coordinate(x, y);
-    this.getSvgRoot().setAttribute(
-        'transform', 'translate(' + x + ',' + y + ')');
-  }
-
-  /**
-   * Move this comment to its workspace's drag surface, accounting for
-   * positioning.  Generally should be called at the same time as
-   * setDragging(true).  Does nothing if useDragSurface_ is false.
-   * @internal
-   */
-  moveToDragSurface() {
-    if (!this.useDragSurface_) {
-      return;
-    }
-    // The translation for drag surface blocks,
-    // is equal to the current relative-to-surface position,
-    // to keep the position in sync as it move on/off the surface.
-    // This is in workspace coordinates.
-    const xy = this.getRelativeToSurfaceXY();
-    this.clearTransformAttributes_();
-    this.workspace.getBlockDragSurface()!.translateSurface(xy.x, xy.y);
-    // Execute the move on the top-level SVG component
-    this.workspace.getBlockDragSurface()!.setBlocksAndShow(this.getSvgRoot());
-  }
-
-  /**
-   * Move this comment during a drag, taking into account whether we are using a
-   * drag surface to translate blocks.
-   * @param dragSurface The surface that carries rendered items during a drag,
-   *     or null if no drag surface is in use.
-   * @param newLoc The location to translate to, in workspace coordinates.
-   * @internal
-   */
-  moveDuringDrag(dragSurface: BlockDragSurfaceSvg, newLoc: Coordinate) {
-    if (dragSurface) {
-      dragSurface.translateSurface(newLoc.x, newLoc.y);
-    } else {
-      (this.svgGroup_ as AnyDuringMigration).translate_ =
-          'translate(' + newLoc.x + ',' + newLoc.y + ')';
-      (this.svgGroup_ as AnyDuringMigration)
-          .setAttribute(
-              'transform',
-              (this.svgGroup_ as AnyDuringMigration).translate_ +
-                  (this.svgGroup_ as AnyDuringMigration).skew_);
-    }
-  }
-
-  /**
-   * Move the bubble group to the specified location in workspace coordinates.
-   * @param x The x position to move to.
-   * @param y The y position to move to.
-   * @internal
-   */
-  moveTo(x: number, y: number) {
-    this.translate(x, y);
-  }
-
-  /**
-   * Clear the comment of transform="..." attributes.
-   * Used when the comment is switching from 3d to 2d transform or vice versa.
-   */
-  private clearTransformAttributes_() {
-    this.getSvgRoot().removeAttribute('transform');
-  }
-
-  /**
-   * Returns the coordinates of a bounding box describing the dimensions of this
-   * comment.
-   * Coordinate system: workspace coordinates.
-   * @return Object with coordinates of the bounding box.
-   * @internal
-   */
-  getBoundingRectangle(): Rect {
-    const blockXY = this.getRelativeToSurfaceXY();
-    const commentBounds = this.getHeightWidth();
-    const top = blockXY.y;
-    const bottom = blockXY.y + commentBounds.height;
-    let left;
-    let right;
-    if (this.RTL) {
-      left = blockXY.x - commentBounds.width;
-      // Add the width of the tab/puzzle piece knob to the x coordinate
-      // since X is the corner of the rectangle, not the whole puzzle piece.
-      right = blockXY.x;
-    } else {
-      // Subtract the width of the tab/puzzle piece knob to the x coordinate
-      // since X is the corner of the rectangle, not the whole puzzle piece.
-      left = blockXY.x;
-      right = blockXY.x + commentBounds.width;
-    }
-    return new Rect(top, bottom, left, right);
-  }
-
-  /**
-   * Add or remove the UI indicating if this comment is movable or not.
-   * @internal
-   */
-  updateMovable() {
-    if (this.isMovable()) {
-      dom.addClass(this.svgGroup_ as Element, 'blocklyDraggable');
-    } else {
-      dom.removeClass(this.svgGroup_ as Element, 'blocklyDraggable');
-    }
-  }
-
-  /**
-   * Set whether this comment is movable or not.
-   * @param movable True if movable.
-   * @internal
-   */
-  override setMovable(movable: boolean) {
-    super.setMovable(movable);
-    this.updateMovable();
-  }
-
-  /**
-   * Set whether this comment is editable or not.
-   * @param editable True if editable.
-   */
-  override setEditable(editable: boolean) {
-    super.setEditable(editable);
-    if (this.textarea_) {
-      this.textarea_.readOnly = !editable;
-    }
-  }
-
-  /**
-   * Recursively adds or removes the dragging class to this node and its
-   * children.
-   * @param adding True if adding, false if removing.
-   * @internal
-   */
-  setDragging(adding: boolean) {
-    if (adding) {
-      const group = this.getSvgRoot();
-      (group as AnyDuringMigration).translate_ = '';
-      (group as AnyDuringMigration).skew_ = '';
-      dom.addClass(this.svgGroup_ as Element, 'blocklyDragging');
-    } else {
-      dom.removeClass(this.svgGroup_ as Element, 'blocklyDragging');
-    }
-  }
-
-  /**
-   * Return the root node of the SVG or null if none exists.
-   * @return The root SVG node (probably a group).
-   * @internal
-   */
-  getSvgRoot(): SVGElement {
-    return this.svgGroup_;
-  }
-
-  /**
-   * Returns this comment's text.
-   * @return Comment text.
-   * @internal
-   */
-  override getContent(): string {
-    return this.textarea_ ? this.textarea_.value : this.content_;
-  }
-
-  /**
-   * Set this comment's content.
-   * @param content Comment content.
-   * @internal
-   */
-  override setContent(content: string) {
-    super.setContent(content);
-    if (this.textarea_) {
-      this.textarea_.value = content;
-    }
-  }
-
-  /**
-   * Update the cursor over this comment by adding or removing a class.
-   * @param enable True if the delete cursor should be shown, false otherwise.
-   * @internal
-   */
-  setDeleteStyle(enable: boolean) {
-    if (enable) {
-      dom.addClass(this.svgGroup_ as Element, 'blocklyDraggingDelete');
-    } else {
-      dom.removeClass(this.svgGroup_ as Element, 'blocklyDraggingDelete');
-    }
-  }
-
-  /**
-   * Set whether auto-layout of this bubble is enabled.  The first time a bubble
-   * is shown it positions itself to not cover any blocks.  Once a user has
-   * dragged it to reposition, it renders where the user put it.
-   * @param _enable True if auto-layout should be enabled, false otherwise.
-   * @internal
-   */
-  setAutoLayout(_enable: boolean) {}
-  // NOP for compatibility with the bubble dragger.
-
-  /**
-   * Encode a comment subtree as XML with XY coordinates.
-   * @param opt_noId True if the encoder should skip the comment ID.
-   * @return Tree of XML elements.
-   * @internal
-   */
-  override toXmlWithXY(opt_noId?: boolean): Element {
-    let width = 0;  // Not used in LTR.
-    if (this.workspace.RTL) {
-      // Here be performance dragons: This calls getMetrics().
-      width = this.workspace.getWidth();
-    }
-    const element = this.toXml(opt_noId);
-    const xy = this.getRelativeToSurfaceXY();
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute(
-        'x',
-        Math.round(this.workspace.RTL ? width - xy.x : xy.x) as
-            AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('y', Math.round(xy.y) as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('h', this.getHeight() as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('w', this.getWidth() as AnyDuringMigration);
-    return element;
-  }
-
-  /**
-   * Encode a comment for copying.
-   * @return Copy metadata.
-   * @internal
-   */
-  toCopyData(): CopyData {
-    return {
-      saveInfo: this.toXmlWithXY(),
-      source: this.workspace,
-      typeCounts: null,
-    };
-  }
-
-  /**
-   * Returns a bounding box describing the dimensions of this comment.
-   * @return Object with height and width properties in workspace units.
-   * @internal
-   */
-  getHeightWidth(): {height: number, width: number} {
-    return {width: this.getWidth(), height: this.getHeight()};
-  }
-
-  /**
-   * Renders the workspace comment.
-   * @internal
-   */
-  render() {
-    if (this.rendered_) {
-      return;
-    }
-
-    const size = this.getHeightWidth();
-
-    // Add text area
-    this.createEditor_();
-    // AnyDuringMigration because:  Argument of type 'SVGForeignObjectElement |
-    // null' is not assignable to parameter of type 'Node'.
-    this.svgGroup_.appendChild(this.foreignObject_ as AnyDuringMigration);
-
-    this.svgHandleTarget_ = dom.createSvgElement(
-        Svg.RECT, {'class': 'blocklyCommentHandleTarget', 'x': 0, 'y': 0});
-    // AnyDuringMigration because:  Argument of type 'SVGRectElement | null' is
-    // not assignable to parameter of type 'Node'.
-    this.svgGroup_.appendChild(this.svgHandleTarget_ as AnyDuringMigration);
-    this.svgRectTarget_ = dom.createSvgElement(Svg.RECT, {
-      'class': 'blocklyCommentTarget',
-      'x': 0,
-      'y': 0,
-      'rx': BORDER_RADIUS,
-      'ry': BORDER_RADIUS,
-    });
-    // AnyDuringMigration because:  Argument of type 'SVGRectElement | null' is
-    // not assignable to parameter of type 'Node'.
-    this.svgGroup_.appendChild(this.svgRectTarget_ as AnyDuringMigration);
-
-    // Add the resize icon
-    this.addResizeDom_();
-    if (this.isDeletable()) {
-      // Add the delete icon
-      this.addDeleteDom_();
-    }
-
-    this.setSize_(size.width, size.height);
-
-    // Set the content
-    this.textarea_!.value = this.content_;
-
-    this.rendered_ = true;
-
-    if (this.resizeGroup_) {
-      browserEvents.conditionalBind(
-          (this.resizeGroup_), 'mousedown', this, this.resizeMouseDown_);
-    }
-
-    if (this.isDeletable()) {
-      browserEvents.conditionalBind(
-          this.deleteGroup_ as SVGGElement, 'mousedown', this,
-          this.deleteMouseDown_);
-      browserEvents.conditionalBind(
-          this.deleteGroup_ as SVGGElement, 'mouseout', this,
-          this.deleteMouseOut_);
-      browserEvents.conditionalBind(
-          this.deleteGroup_ as SVGGElement, 'mouseup', this,
-          this.deleteMouseUp_);
-    }
-  }
-
-  /**
-   * Create the text area for the comment.
-   * @return The top-level node of the editor.
-   */
-  private createEditor_(): Element {
-    /* Create the editor.  Here's the markup that will be generated:
-          <foreignObject class="blocklyCommentForeignObject" x="0" y="10"
-          width="164" height="164"> <body xmlns="http://www.w3.org/1999/xhtml"
-          class="blocklyMinimalBody"> <textarea
-       xmlns="http://www.w3.org/1999/xhtml" class="blocklyCommentTextarea"
-                  style="height: 164px; width: 164px;"></textarea>
-            </body>
-          </foreignObject>
-        */
-    this.foreignObject_ = dom.createSvgElement(Svg.FOREIGNOBJECT, {
-      'x': 0,
-      'y': WorkspaceCommentSvg.TOP_OFFSET,
-      'class': 'blocklyCommentForeignObject',
-    });
-    const body = document.createElementNS(dom.HTML_NS, 'body');
-    body.setAttribute('xmlns', dom.HTML_NS);
-    body.className = 'blocklyMinimalBody';
-    const textarea = document.createElementNS(dom.HTML_NS, 'textarea') as
-        HTMLTextAreaElement;
-    textarea.className = 'blocklyCommentTextarea';
-    textarea.setAttribute('dir', this.RTL ? 'RTL' : 'LTR');
-    textarea.readOnly = !this.isEditable();
-    body.appendChild(textarea);
-    this.textarea_ = textarea;
-    this.foreignObject_!.appendChild(body);
-    // Don't zoom with mousewheel.
-    browserEvents.conditionalBind(
-        textarea, 'wheel', this, function(e: AnyDuringMigration) {
-          e.stopPropagation();
-        });
-    browserEvents.conditionalBind(
-        textarea, 'change', this,
-        /** @param e Unused event parameter */
-        /* eslint-enable no-unused-vars */
-        function(
-            this: WorkspaceCommentSvg,
-            /* eslint-disable no-unused-vars */ e: Event) {
-          this.setContent(textarea.value);
-        });
-    // AnyDuringMigration because:  Type 'SVGForeignObjectElement | null' is not
-    // assignable to type 'Element'.
-    return this.foreignObject_ as AnyDuringMigration;
-  }
-
-  /** Add the resize icon to the DOM */
-  private addResizeDom_() {
-    this.resizeGroup_ = dom.createSvgElement(
-        Svg.G, {'class': this.RTL ? 'blocklyResizeSW' : 'blocklyResizeSE'},
-        this.svgGroup_);
-    // AnyDuringMigration because:  Argument of type 'SVGGElement | null' is not
-    // assignable to parameter of type 'Element | undefined'.
-    dom.createSvgElement(
-        Svg.POLYGON,
-        {'points': '0,x x,x x,0'.replace(/x/g, RESIZE_SIZE.toString())},
-        this.resizeGroup_ as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'SVGGElement | null' is not
-    // assignable to parameter of type 'Element | undefined'.
-    dom.createSvgElement(
-        Svg.LINE, {
-          'class': 'blocklyResizeLine',
-          'x1': RESIZE_SIZE / 3,
-          'y1': RESIZE_SIZE - 1,
-          'x2': RESIZE_SIZE - 1,
-          'y2': RESIZE_SIZE / 3,
-        },
-        this.resizeGroup_ as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'SVGGElement | null' is not
-    // assignable to parameter of type 'Element | undefined'.
-    dom.createSvgElement(
-        Svg.LINE, {
-          'class': 'blocklyResizeLine',
-          'x1': RESIZE_SIZE * 2 / 3,
-          'y1': RESIZE_SIZE - 1,
-          'x2': RESIZE_SIZE - 1,
-          'y2': RESIZE_SIZE * 2 / 3,
-        },
-        this.resizeGroup_ as AnyDuringMigration);
-  }
-
-  /** Add the delete icon to the DOM */
-  private addDeleteDom_() {
-    this.deleteGroup_ = dom.createSvgElement(
-        Svg.G, {'class': 'blocklyCommentDeleteIcon'}, this.svgGroup_);
-    // AnyDuringMigration because:  Argument of type 'SVGGElement | null' is not
-    // assignable to parameter of type 'Element | undefined'.
-    this.deleteIconBorder_ = dom.createSvgElement(
-        Svg.CIRCLE,
-        {'class': 'blocklyDeleteIconShape', 'r': '7', 'cx': '7.5', 'cy': '7.5'},
-        this.deleteGroup_ as AnyDuringMigration);
-    // x icon.
-    // AnyDuringMigration because:  Argument of type 'SVGGElement | null' is not
-    // assignable to parameter of type 'Element | undefined'.
-    dom.createSvgElement(
-        Svg.LINE, {
-          'x1': '5',
-          'y1': '10',
-          'x2': '10',
-          'y2': '5',
-          'stroke': '#fff',
-          'stroke-width': '2',
-        },
-        this.deleteGroup_ as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'SVGGElement | null' is not
-    // assignable to parameter of type 'Element | undefined'.
-    dom.createSvgElement(
-        Svg.LINE, {
-          'x1': '5',
-          'y1': '5',
-          'x2': '10',
-          'y2': '10',
-          'stroke': '#fff',
-          'stroke-width': '2',
-        },
-        this.deleteGroup_ as AnyDuringMigration);
-  }
-
-  /**
-   * Handle a mouse-down on comment's resize corner.
-   * @param e Mouse down event.
-   */
-  private resizeMouseDown_(e: MouseEvent) {
-    this.unbindDragEvents_();
-    if (browserEvents.isRightButton(e)) {
-      // No right-click.
-      e.stopPropagation();
-      return;
-    }
-    // Left-click (or middle click)
-    this.workspace.startDrag(
-        e,
-        new Coordinate(
-            this.workspace.RTL ? -this.width_ : this.width_, this.height_));
-
-    this.onMouseUpWrapper_ = browserEvents.conditionalBind(
-        document, 'mouseup', this, this.resizeMouseUp_);
-    this.onMouseMoveWrapper_ = browserEvents.conditionalBind(
-        document, 'mousemove', this, this.resizeMouseMove_);
-    this.workspace.hideChaff();
-    // This event has been handled.  No need to bubble up to the document.
-    e.stopPropagation();
-  }
-
-  /**
-   * Handle a mouse-down on comment's delete icon.
-   * @param e Mouse down event.
-   */
-  private deleteMouseDown_(e: Event) {
-    // Highlight the delete icon.
-    dom.addClass(
-        this.deleteIconBorder_ as Element, 'blocklyDeleteIconHighlighted');
-    // This event has been handled.  No need to bubble up to the document.
-    e.stopPropagation();
-  }
-
-  /**
-   * Handle a mouse-out on comment's delete icon.
-   * @param _e Mouse out event.
-   */
-  private deleteMouseOut_(_e: Event) {
-    // Restore highlight on the delete icon.
-    dom.removeClass(
-        this.deleteIconBorder_ as Element, 'blocklyDeleteIconHighlighted');
-  }
-
-  /**
-   * Handle a mouse-up on comment's delete icon.
-   * @param e Mouse up event.
-   */
-  private deleteMouseUp_(e: Event) {
-    // Delete this comment.
-    this.dispose();
-    // This event has been handled.  No need to bubble up to the document.
-    e.stopPropagation();
-  }
-
-  /** Stop binding to the global mouseup and mousemove events. */
-  private unbindDragEvents_() {
-    if (this.onMouseUpWrapper_) {
-      browserEvents.unbind(this.onMouseUpWrapper_);
-      this.onMouseUpWrapper_ = null;
-    }
-    if (this.onMouseMoveWrapper_) {
-      browserEvents.unbind(this.onMouseMoveWrapper_);
-      this.onMouseMoveWrapper_ = null;
-    }
-  }
-
-  /**
-   * Handle a mouse-up event while dragging a comment's border or resize handle.
-   * @param _e Mouse up event.
-   */
-  private resizeMouseUp_(_e: Event) {
-    Touch.clearTouchIdentifier();
-    this.unbindDragEvents_();
-  }
-
-  /**
-   * Resize this comment to follow the mouse.
-   * @param e Mouse move event.
-   */
-  private resizeMouseMove_(e: MouseEvent) {
-    this.autoLayout_ = false;
-    const newXY = this.workspace.moveDrag(e);
-    this.setSize_(this.RTL ? -newXY.x : newXY.x, newXY.y);
-  }
-
-  /**
-   * Callback function triggered when the comment has resized.
-   * Resize the text area accordingly.
-   */
-  private resizeComment_() {
-    const size = this.getHeightWidth();
-    const topOffset = WorkspaceCommentSvg.TOP_OFFSET;
-    const textOffset = TEXTAREA_OFFSET * 2;
-
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    this.foreignObject_!.setAttribute(
-        'width', size.width as AnyDuringMigration);
-    this.foreignObject_!.setAttribute(
-        'height', (size.height - topOffset).toString());
-    if (this.RTL) {
-      this.foreignObject_!.setAttribute('x', (-size.width).toString());
-    }
-    this.textarea_!.style.width = size.width - textOffset + 'px';
-    this.textarea_!.style.height = size.height - textOffset - topOffset + 'px';
-  }
-
-  /**
-   * Set size
-   * @param width width of the container
-   * @param height height of the container
-   */
-  private setSize_(width: number, height: number) {
-    // Minimum size of a comment.
-    width = Math.max(width, 45);
-    height = Math.max(height, 20 + WorkspaceCommentSvg.TOP_OFFSET);
-    this.width_ = width;
-    this.height_ = height;
-    this.svgRect_.setAttribute('width', width);
-    this.svgRect_.setAttribute('height', height);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    this.svgRectTarget_!.setAttribute('width', width as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    this.svgRectTarget_!.setAttribute('height', height as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    this.svgHandleTarget_!.setAttribute('width', width as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    this.svgHandleTarget_!.setAttribute(
-        'height', WorkspaceCommentSvg.TOP_OFFSET as AnyDuringMigration);
-    if (this.RTL) {
-      this.svgRect_.setAttribute('transform', 'scale(-1 1)');
-      this.svgRectTarget_!.setAttribute('transform', 'scale(-1 1)');
-    }
-
-    if (this.resizeGroup_) {
-      if (this.RTL) {
-        // Mirror the resize group.
-        this.resizeGroup_.setAttribute(
-            'transform',
-            'translate(' + (-width + RESIZE_SIZE) + ',' +
-                (height - RESIZE_SIZE) + ') scale(-1 1)');
-        this.deleteGroup_!.setAttribute(
-            'transform',
-            'translate(' + (-width + RESIZE_SIZE) + ',' + -RESIZE_SIZE +
-                ') scale(-1 1)');
-      } else {
-        this.resizeGroup_.setAttribute(
-            'transform',
-            'translate(' + (width - RESIZE_SIZE) + ',' +
-                (height - RESIZE_SIZE) + ')');
-        this.deleteGroup_!.setAttribute(
-            'transform',
-            'translate(' + (width - RESIZE_SIZE) + ',' + -RESIZE_SIZE + ')');
-      }
-    }
-
-    // Allow the contents to resize.
-    this.resizeComment_();
-  }
-
-  /** Dispose of any rendered comment components. */
-  private disposeInternal_() {
-    this.textarea_ = null;
-    this.foreignObject_ = null;
-    this.svgRectTarget_ = null;
-    this.svgHandleTarget_ = null;
-    this.disposed_ = true;
-  }
-
-  /**
-   * Set the focus on the text area.
-   * @internal
-   */
-  setFocus() {
-    const comment = this;
-    this.focused_ = true;
-    // Defer CSS changes.
-    setTimeout(function() {
-      if (comment.disposed_) {
-        return;
-      }
-      comment.textarea_!.focus();
-      comment.addFocus();
-      dom.addClass(
-          comment.svgRectTarget_ as SVGRectElement,
-          'blocklyCommentTargetFocused');
-      dom.addClass(
-          comment.svgHandleTarget_ as SVGRectElement,
-          'blocklyCommentHandleTargetFocused');
-    }, 0);
-  }
-
-  /**
-   * Remove focus from the text area.
-   * @internal
-   */
-  blurFocus() {
-    const comment = this;
-    this.focused_ = false;
-    // Defer CSS changes.
-    setTimeout(function() {
-      if (comment.disposed_) {
-        return;
-      }
-
-      comment.textarea_!.blur();
-      comment.removeFocus();
-      dom.removeClass(
-          comment.svgRectTarget_ as SVGRectElement,
-          'blocklyCommentTargetFocused');
-      dom.removeClass(
-          comment.svgHandleTarget_ as SVGRectElement,
-          'blocklyCommentHandleTargetFocused');
-    }, 0);
-  }
-
-  /**
-   * Decode an XML comment tag and create a rendered comment on the workspace.
-   * @param xmlComment XML comment element.
-   * @param workspace The workspace.
-   * @param opt_wsWidth The width of the workspace, which is used to position
-   *     comments correctly in RTL.
-   * @return The created workspace comment.
-   * @internal
-   */
-  static fromXmlRendered(
-      xmlComment: Element, workspace: WorkspaceSvg,
-      opt_wsWidth?: number): WorkspaceCommentSvg {
-    eventUtils.disable();
-    let comment;
-    try {
-      const info = WorkspaceComment.parseAttributes(xmlComment);
-
-      comment = new WorkspaceCommentSvg(
-          workspace, info.content, info.h, info.w, info.id);
-      if (workspace.rendered) {
-        comment.initSvg(true);
-        comment.render();
-      }
-      // Position the comment correctly, taking into account the width of a
-      // rendered RTL workspace.
-      if (!isNaN(info.x) && !isNaN(info.y)) {
-        if (workspace.RTL) {
-          const wsWidth = opt_wsWidth || workspace.getWidth();
-          comment.moveBy(wsWidth - info.x, info.y);
-        } else {
-          comment.moveBy(info.x, info.y);
-        }
-      }
-    } finally {
-      eventUtils.enable();
-    }
-
-    WorkspaceComment.fireCreateEvent((comment));
-    return comment;
-  }
-}
-
-/** CSS for workspace comment.  See css.js for use. */
-Css.register(`
-.blocklyCommentForeignObject {
-  position: relative;
-  z-index: 0;
-}
-
-.blocklyCommentRect {
-  fill: #E7DE8E;
-  stroke: #bcA903;
-  stroke-width: 1px;
-}
-
-.blocklyCommentTarget {
-  fill: transparent;
-  stroke: #bcA903;
-}
-
-.blocklyCommentTargetFocused {
-  fill: none;
-}
-
-.blocklyCommentHandleTarget {
-  fill: none;
-}
-
-.blocklyCommentHandleTargetFocused {
-  fill: transparent;
-}
-
-.blocklyFocused>.blocklyCommentRect {
-  fill: #B9B272;
-  stroke: #B9B272;
-}
-
-.blocklySelected>.blocklyCommentTarget {
-  stroke: #fc3;
-  stroke-width: 3px;
-}
-
-.blocklyCommentDeleteIcon {
-  cursor: pointer;
-  fill: #000;
-  display: none;
-}
-
-.blocklySelected > .blocklyCommentDeleteIcon {
-  display: block;
-}
-
-.blocklyDeleteIconShape {
-  fill: #000;
-  stroke: #000;
-  stroke-width: 1px;
-}
-
-.blocklyDeleteIconShape.blocklyDeleteIconHighlighted {
-  stroke: #fc3;
-}
-`);