scratch-blocks 2.0.0-beta.1 → 2.0.0-beta.2

package/blockly-rc/core/comments/rendered_workspace_comment.ts

@@ -1,297 +0,0 @@
-/**
- * @license
- * Copyright 2024 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {WorkspaceComment} from './workspace_comment.js';
-import {WorkspaceSvg} from '../workspace_svg.js';
-import {CommentView} from './comment_view.js';
-import {Coordinate} from '../utils/coordinate.js';
-import {Rect} from '../utils/rect.js';
-import {Size} from '../utils/size.js';
-import {IBoundedElement} from '../interfaces/i_bounded_element.js';
-import {IRenderedElement} from '../interfaces/i_rendered_element.js';
-import * as dom from '../utils/dom.js';
-import {IDraggable} from '../interfaces/i_draggable.js';
-import {CommentDragStrategy} from '../dragging/comment_drag_strategy.js';
-import * as browserEvents from '../browser_events.js';
-import * as common from '../common.js';
-import {ISelectable} from '../interfaces/i_selectable.js';
-import {IDeletable} from '../interfaces/i_deletable.js';
-import {ICopyable} from '../interfaces/i_copyable.js';
-import * as commentSerialization from '../serialization/workspace_comments.js';
-import {
-  WorkspaceCommentPaster,
-  WorkspaceCommentCopyData,
-} from '../clipboard/workspace_comment_paster.js';
-import {IContextMenu} from '../interfaces/i_contextmenu.js';
-import * as contextMenu from '../contextmenu.js';
-import {ContextMenuRegistry} from '../contextmenu_registry.js';
-
-export class RenderedWorkspaceComment
-  extends WorkspaceComment
-  implements
-    IBoundedElement,
-    IRenderedElement,
-    IDraggable,
-    ISelectable,
-    IDeletable,
-    ICopyable<WorkspaceCommentCopyData>,
-    IContextMenu
-{
-  /** The class encompassing the svg elements making up the workspace comment. */
-  private view: CommentView;
-
-  public readonly workspace: WorkspaceSvg;
-
-  private dragStrategy = new CommentDragStrategy(this);
-
-  /** Constructs the workspace comment, including the view. */
-  constructor(workspace: WorkspaceSvg, id?: string) {
-    super(workspace, id);
-
-    this.workspace = workspace;
-
-    this.view = new CommentView(workspace);
-    // Set the size to the default size as defined in the superclass.
-    this.view.setSize(this.getSize());
-    this.view.setEditable(this.isEditable());
-    this.view.getSvgRoot().setAttribute('data-id', this.id);
-
-    this.addModelUpdateBindings();
-
-    browserEvents.conditionalBind(
-      this.view.getSvgRoot(),
-      'pointerdown',
-      this,
-      this.startGesture,
-    );
-    // Don't zoom with mousewheel; let it scroll instead.
-    browserEvents.conditionalBind(
-      this.view.getSvgRoot(),
-      'wheel',
-      this,
-      (e: Event) => {
-        e.stopPropagation();
-      },
-    );
-  }
-
-  /**
-   * Adds listeners to the view that updates the model (i.e. the superclass)
-   * when changes are made to the view.
-   */
-  private addModelUpdateBindings() {
-    this.view.addTextChangeListener(
-      (_, newText: string) => void super.setText(newText),
-    );
-    this.view.addSizeChangeListener(
-      (_, newSize: Size) => void super.setSize(newSize),
-    );
-    this.view.addOnCollapseListener(
-      () => void super.setCollapsed(this.view.isCollapsed()),
-    );
-    this.view.addDisposeListener(() => {
-      if (!this.isDeadOrDying()) this.dispose();
-    });
-  }
-
-  /** Sets the text of the comment. */
-  override setText(text: string): void {
-    // setText will trigger the change listener that updates
-    // the model aka superclass.
-    this.view.setText(text);
-  }
-
-  /** Sets the placeholder text displayed if the comment is empty. */
-  setPlaceholderText(text: string): void {
-    this.view.setPlaceholderText(text);
-  }
-
-  /** Sets the size of the comment. */
-  override setSize(size: Size) {
-    // setSize will trigger the change listener that updates
-    // the model aka superclass.
-    this.view.setSize(size);
-  }
-
-  /** Sets whether the comment is collapsed or not. */
-  override setCollapsed(collapsed: boolean) {
-    // setCollapsed will trigger the change listener that updates
-    // the model aka superclass.
-    this.view.setCollapsed(collapsed);
-  }
-
-  /** Sets whether the comment is editable or not. */
-  override setEditable(editable: boolean): void {
-    super.setEditable(editable);
-    // Use isEditable rather than isOwnEditable to account for workspace state.
-    this.view.setEditable(this.isEditable());
-  }
-
-  /** Returns the root SVG element of this comment. */
-  getSvgRoot(): SVGElement {
-    return this.view.getSvgRoot();
-  }
-
-  /**
-   * Returns the comment's size in workspace units.
-   * Does not respect collapsing.
-   */
-  getSize(): Size {
-    return super.getSize();
-  }
-
-  /**
-   * Returns the bounding rectangle of this comment in workspace coordinates.
-   * Respects collapsing.
-   */
-  getBoundingRectangle(): Rect {
-    const loc = this.getRelativeToSurfaceXY();
-    const size = this.view?.getSize() ?? this.getSize();
-    let left;
-    let right;
-    if (this.workspace.RTL) {
-      left = loc.x - size.width;
-      right = loc.x;
-    } else {
-      left = loc.x;
-      right = loc.x + size.width;
-    }
-    return new Rect(loc.y, loc.y + size.height, left, right);
-  }
-
-  /** Move the comment by the given amounts in workspace coordinates. */
-  moveBy(dx: number, dy: number, reason?: string[] | undefined): void {
-    const loc = this.getRelativeToSurfaceXY();
-    const newLoc = new Coordinate(loc.x + dx, loc.y + dy);
-    this.moveTo(newLoc, reason);
-  }
-
-  /** Moves the comment to the given location in workspace coordinates. */
-  override moveTo(location: Coordinate, reason?: string[] | undefined): void {
-    super.moveTo(location, reason);
-    this.view.moveTo(location);
-  }
-
-  /**
-   * Moves the comment during a drag. Doesn't fire move events.
-   *
-   * @internal
-   */
-  moveDuringDrag(location: Coordinate): void {
-    this.location = location;
-    this.view.moveTo(location);
-  }
-
-  /**
-   * Adds the dragging CSS class to this comment.
-   *
-   * @internal
-   */
-  setDragging(dragging: boolean): void {
-    if (dragging) {
-      dom.addClass(this.getSvgRoot(), 'blocklyDragging');
-    } else {
-      dom.removeClass(this.getSvgRoot(), 'blocklyDragging');
-    }
-  }
-
-  /** Disposes of the view. */
-  override dispose() {
-    this.disposing = true;
-    if (!this.view.isDeadOrDying()) this.view.dispose();
-    super.dispose();
-  }
-
-  /**
-   * Starts a gesture because we detected a pointer down on the comment
-   * (that wasn't otherwise gobbled up, e.g. by resizing).
-   */
-  private startGesture(e: PointerEvent) {
-    const gesture = this.workspace.getGesture(e);
-    if (gesture) {
-      gesture.handleCommentStart(e, this);
-      common.setSelected(this);
-    }
-  }
-
-  /** Visually indicates that this comment would be deleted if dropped. */
-  setDeleteStyle(wouldDelete: boolean): void {
-    if (wouldDelete) {
-      dom.addClass(this.getSvgRoot(), 'blocklyDraggingDelete');
-    } else {
-      dom.removeClass(this.getSvgRoot(), 'blocklyDraggingDelete');
-    }
-  }
-
-  /** Returns whether this comment is movable or not. */
-  isMovable(): boolean {
-    return this.dragStrategy.isMovable();
-  }
-
-  /** Starts a drag on the comment. */
-  startDrag(): void {
-    this.dragStrategy.startDrag();
-  }
-
-  /** Drags the comment to the given location. */
-  drag(newLoc: Coordinate): void {
-    this.dragStrategy.drag(newLoc);
-  }
-
-  /** Ends the drag on the comment. */
-  endDrag(): void {
-    this.dragStrategy.endDrag();
-  }
-
-  /** Moves the comment back to where it was at the start of a drag. */
-  revertDrag(): void {
-    this.dragStrategy.revertDrag();
-  }
-
-  /** Visually highlights the comment. */
-  select(): void {
-    dom.addClass(this.getSvgRoot(), 'blocklySelected');
-  }
-
-  /** Visually unhighlights the comment. */
-  unselect(): void {
-    dom.removeClass(this.getSvgRoot(), 'blocklySelected');
-  }
-
-  /**
-   * Returns a JSON serializable representation of this comment's state that
-   * can be used for pasting.
-   */
-  toCopyData(): WorkspaceCommentCopyData | null {
-    return {
-      paster: WorkspaceCommentPaster.TYPE,
-      commentState: commentSerialization.save(this, {
-        addCoordinates: true,
-      }),
-    };
-  }
-
-  /** Show a context menu for this comment. */
-  showContextMenu(e: PointerEvent): void {
-    const menuOptions = ContextMenuRegistry.registry.getContextMenuOptions(
-      ContextMenuRegistry.ScopeType.COMMENT,
-      {comment: this},
-    );
-    contextMenu.show(e, menuOptions, this.workspace.RTL, this.workspace);
-  }
-
-  /** Snap this comment to the nearest grid point. */
-  snapToGrid(): void {
-    if (this.isDeadOrDying()) return;
-    const grid = this.workspace.getGrid();
-    if (!grid?.shouldSnap()) return;
-    const currentXY = this.getRelativeToSurfaceXY();
-    const alignedXY = grid.alignXY(currentXY);
-    if (alignedXY !== currentXY) {
-      this.moveTo(alignedXY, ['snap']);
-    }
-  }
-}

package/blockly-rc/core/comments/workspace_comment.ts

@@ -1,237 +0,0 @@
-/**
- * @license
- * Copyright 2024 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Workspace} from '../workspace.js';
-import {Size} from '../utils/size.js';
-import {Coordinate} from '../utils/coordinate.js';
-import * as idGenerator from '../utils/idgenerator.js';
-import * as eventUtils from '../events/utils.js';
-import {CommentMove} from '../events/events_comment_move.js';
-import {CommentResize} from '../events/events_comment_resize.js';
-import {CommentView} from './comment_view.js';
-
-export class WorkspaceComment {
-  /** The unique identifier for this comment. */
-  public readonly id: string;
-
-  /** The text of the comment. */
-  private text = '';
-
-  /** The size of the comment in workspace units. */
-  private size: Size;
-
-  /** Whether the comment is collapsed or not. */
-  private collapsed = false;
-
-  /** Whether the comment is editable or not. */
-  private editable = true;
-
-  /** Whether the comment is movable or not. */
-  private movable = true;
-
-  /** Whether the comment is deletable or not. */
-  private deletable = true;
-
-  /** The location of the comment in workspace coordinates. */
-  protected location = new Coordinate(0, 0);
-
-  /** Whether this comment has been disposed or not. */
-  protected disposed = false;
-
-  /** Whether this comment is being disposed or not. */
-  protected disposing = false;
-
-  /**
-   * Constructs the comment.
-   *
-   * @param workspace The workspace to construct the comment in.
-   * @param id An optional ID to give to the comment. If not provided, one will
-   *     be generated.
-   */
-  constructor(
-    public readonly workspace: Workspace,
-    id?: string,
-  ) {
-    this.id = id && !workspace.getCommentById(id) ? id : idGenerator.genUid();
-    this.size = CommentView.defaultCommentSize;
-
-    workspace.addTopComment(this);
-
-    this.fireCreateEvent();
-  }
-
-  private fireCreateEvent() {
-    if (eventUtils.isEnabled()) {
-      eventUtils.fire(new (eventUtils.get(eventUtils.COMMENT_CREATE))(this));
-    }
-  }
-
-  private fireDeleteEvent() {
-    if (eventUtils.isEnabled()) {
-      eventUtils.fire(new (eventUtils.get(eventUtils.COMMENT_DELETE))(this));
-    }
-  }
-
-  /** Fires a comment change event. */
-  private fireChangeEvent(oldText: string, newText: string) {
-    if (eventUtils.isEnabled()) {
-      eventUtils.fire(
-        new (eventUtils.get(eventUtils.COMMENT_CHANGE))(this, oldText, newText),
-      );
-    }
-  }
-
-  /** Fires a comment collapse event. */
-  private fireCollapseEvent(newCollapsed: boolean) {
-    if (eventUtils.isEnabled()) {
-      eventUtils.fire(
-        new (eventUtils.get(eventUtils.COMMENT_COLLAPSE))(this, newCollapsed),
-      );
-    }
-  }
-
-  /** Sets the text of the comment. */
-  setText(text: string) {
-    const oldText = this.text;
-    this.text = text;
-    this.fireChangeEvent(oldText, text);
-  }
-
-  /** Returns the text of the comment. */
-  getText(): string {
-    return this.text;
-  }
-
-  /** Sets the comment's size in workspace units. */
-  setSize(size: Size) {
-    const event = new (eventUtils.get(eventUtils.COMMENT_RESIZE))(
-      this,
-    ) as CommentResize;
-
-    this.size = size;
-
-    event.recordCurrentSizeAsNewSize();
-    eventUtils.fire(event);
-  }
-
-  /** Returns the comment's size in workspace units. */
-  getSize(): Size {
-    return this.size;
-  }
-
-  /** Sets whether the comment is collapsed or not. */
-  setCollapsed(collapsed: boolean) {
-    this.collapsed = collapsed;
-    this.fireCollapseEvent(collapsed);
-  }
-
-  /** Returns whether the comment is collapsed or not. */
-  isCollapsed(): boolean {
-    return this.collapsed;
-  }
-
-  /** Sets whether the comment is editable or not. */
-  setEditable(editable: boolean) {
-    this.editable = editable;
-  }
-
-  /**
-   * Returns whether the comment is editable or not, respecting whether the
-   * workspace is read-only.
-   */
-  isEditable(): boolean {
-    return this.isOwnEditable() && !this.workspace.options.readOnly;
-  }
-
-  /**
-   * Returns whether the comment is editable or not, only examining its own
-   * state and ignoring the state of the workspace.
-   */
-  isOwnEditable(): boolean {
-    return this.editable;
-  }
-
-  /** Sets whether the comment is movable or not. */
-  setMovable(movable: boolean) {
-    this.movable = movable;
-  }
-
-  /**
-   * Returns whether the comment is movable or not, respecting whether the
-   * workspace is read-only.
-   */
-  isMovable() {
-    return this.isOwnMovable() && !this.workspace.options.readOnly;
-  }
-
-  /**
-   * Returns whether the comment is movable or not, only examining its own
-   * state and ignoring the state of the workspace.
-   */
-  isOwnMovable() {
-    return this.movable;
-  }
-
-  /** Sets whether the comment is deletable or not. */
-  setDeletable(deletable: boolean) {
-    this.deletable = deletable;
-  }
-
-  /**
-   * Returns whether the comment is deletable or not, respecting whether the
-   * workspace is read-only.
-   */
-  isDeletable(): boolean {
-    return this.isOwnDeletable() && !this.workspace.options.readOnly;
-  }
-
-  /**
-   * Returns whether the comment is deletable or not, only examining its own
-   * state and ignoring the state of the workspace.
-   */
-  isOwnDeletable(): boolean {
-    return this.deletable;
-  }
-
-  /** Moves the comment to the given location in workspace coordinates. */
-  moveTo(location: Coordinate, reason?: string[] | undefined) {
-    const event = new (eventUtils.get(eventUtils.COMMENT_MOVE))(
-      this,
-    ) as CommentMove;
-    if (reason) event.setReason(reason);
-
-    this.location = location;
-
-    event.recordNew();
-    eventUtils.fire(event);
-  }
-
-  /** Returns the position of the comment in workspace coordinates. */
-  getRelativeToSurfaceXY(): Coordinate {
-    return this.location;
-  }
-
-  /** Disposes of this comment. */
-  dispose() {
-    this.disposing = true;
-    this.fireDeleteEvent();
-    this.workspace.removeTopComment(this);
-    this.disposed = true;
-  }
-
-  /** Returns whether the comment has been disposed or not. */
-  isDisposed() {
-    return this.disposed;
-  }
-
-  /**
-   * Returns true if this comment view is currently being disposed or has
-   * already been disposed.
-   */
-  isDeadOrDying(): boolean {
-    return this.disposing || this.disposed;
-  }
-}

package/blockly-rc/core/comments.ts

@@ -1,9 +0,0 @@
-/**
- * @license
- * Copyright 2024 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-export {CommentView} from './comments/comment_view.js';
-export {WorkspaceComment} from './comments/workspace_comment.js';
-export {RenderedWorkspaceComment} from './comments/rendered_workspace_comment.js';