blockly 12.4.0 → 12.4.1

package/core/clipboard.d.ts

@@ -0,0 +1,103 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BlockCopyData, BlockPaster } from './clipboard/block_paster.js';
+import * as registry from './clipboard/registry.js';
+import type { ICopyData, ICopyable } from './interfaces/i_copyable.js';
+import { Coordinate } from './utils/coordinate.js';
+import { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Copy a copyable item, and record its data and the workspace it was
+ * copied from.
+ *
+ * This function does not perform any checks to ensure the copy
+ * should be allowed, e.g. to ensure the block is deletable. Such
+ * checks should be done before calling this function.
+ *
+ * Note that if the copyable item is not an `ISelectable` or its
+ * `workspace` property is not a `WorkspaceSvg`, the copy will be
+ * successful, but there will be no saved workspace data. This will
+ * impact the ability to paste the data unless you explictily pass
+ * a workspace into the paste method.
+ *
+ * @param toCopy item to copy.
+ * @param location location to save as a potential paste location.
+ * @returns the copied data if copy was successful, otherwise null.
+ */
+export declare function copy<T extends ICopyData>(toCopy: ICopyable<T>, location?: Coordinate): T | null;
+/**
+ * Gets the copy data for the last item copied. This is useful if you
+ * are implementing custom copy/paste behavior. If you want the default
+ * behavior, just use the copy and paste methods directly.
+ *
+ * @returns copy data for the last item copied, or null if none set.
+ */
+export declare function getLastCopiedData(): ICopyable.ICopyData | null;
+/**
+ * Sets the last copied item. You should call this method if you implement
+ * custom copy behavior, so that other callers are working with the correct
+ * data. This method is called automatically if you use the built-in copy
+ * method.
+ *
+ * @param copyData copy data for the last item copied.
+ */
+export declare function setLastCopiedData(copyData: ICopyData): void;
+/**
+ * Gets the workspace that was last copied from. This is useful if you
+ * are implementing custom copy/paste behavior and want to paste on the
+ * same workspace that was copied from. If you want the default behavior,
+ * just use the copy and paste methods directly.
+ *
+ * @returns workspace that was last copied from, or null if none set.
+ */
+export declare function getLastCopiedWorkspace(): WorkspaceSvg | null;
+/**
+ * Sets the workspace that was last copied from. You should call this method
+ * if you implement custom copy behavior, so that other callers are working
+ * with the correct data. This method is called automatically if you use the
+ * built-in copy method.
+ *
+ * @param workspace workspace that was last copied from.
+ */
+export declare function setLastCopiedWorkspace(workspace: WorkspaceSvg): void;
+/**
+ * Gets the location that was last copied from. This is useful if you
+ * are implementing custom copy/paste behavior. If you want the
+ * default behavior, just use the copy and paste methods directly.
+ *
+ * @returns last saved location, or null if none set.
+ */
+export declare function getLastCopiedLocation(): Coordinate | undefined;
+/**
+ * Sets the location that was last copied from. You should call this method
+ * if you implement custom copy behavior, so that other callers are working
+ * with the correct data. This method is called automatically if you use the
+ * built-in copy method.
+ *
+ * @param location last saved location, which can be used to paste at.
+ */
+export declare function setLastCopiedLocation(location: Coordinate): void;
+/**
+ * Paste a pasteable element into the given workspace.
+ *
+ * This function does not perform any checks to ensure the paste
+ * is allowed, e.g. that the workspace is rendered or the block
+ * is pasteable. Such checks should be done before calling this
+ * function.
+ *
+ * @param copyData The data to paste into the workspace.
+ * @param workspace The workspace to paste the data into.
+ * @param coordinate The location to paste the thing at.
+ * @returns The pasted thing if the paste was successful, null otherwise.
+ */
+export declare function paste<T extends ICopyData>(copyData: T, workspace: WorkspaceSvg, coordinate?: Coordinate): ICopyable<T> | null;
+/**
+ * Pastes the last copied ICopyable into the last copied-from workspace.
+ *
+ * @returns the pasted thing if the paste was successful, null otherwise.
+ */
+export declare function paste(): ICopyable<ICopyData> | null;
+export { BlockCopyData, BlockPaster, registry };
+//# sourceMappingURL=clipboard.d.ts.map

package/core/comments/collapse_comment_bar_button.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceSvg } from '../workspace_svg.js';
+import { CommentBarButton } from './comment_bar_button.js';
+import type { CommentView } from './comment_view.js';
+/**
+ * Magic string appended to the comment ID to create a unique ID for this button.
+ */
+export declare const COMMENT_COLLAPSE_BAR_BUTTON_FOCUS_IDENTIFIER = "_collapse_bar_button";
+/**
+ * Button that toggles the collapsed state of a comment.
+ */
+export declare class CollapseCommentBarButton extends CommentBarButton {
+    protected readonly id: string;
+    protected readonly workspace: WorkspaceSvg;
+    protected readonly container: SVGGElement;
+    protected readonly commentView: CommentView;
+    /**
+     * Opaque ID used to unbind event handlers during disposal.
+     */
+    private readonly bindId;
+    /**
+     * SVG image displayed on this button.
+     */
+    protected readonly icon: SVGImageElement;
+    /**
+     * Creates a new CollapseCommentBarButton instance.
+     *
+     * @param id The ID of this button's parent comment.
+     * @param workspace The workspace this button's parent comment is displayed on.
+     * @param container An SVG group that this button should be a child of.
+     */
+    constructor(id: string, workspace: WorkspaceSvg, container: SVGGElement, commentView: CommentView);
+    /**
+     * Disposes of this button.
+     */
+    dispose(): void;
+    /**
+     * Adjusts the positioning of this button within its container.
+     */
+    reposition(): void;
+    /**
+     * Toggles the collapsed state of the parent comment.
+     *
+     * @param e The event that triggered this action.
+     */
+    performAction(e?: Event): void;
+}
+//# sourceMappingURL=collapse_comment_bar_button.d.ts.map

package/core/comments/comment_bar_button.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IFocusableNode } from '../interfaces/i_focusable_node.js';
+import { Rect } from '../utils/rect.js';
+import type { WorkspaceSvg } from '../workspace_svg.js';
+import type { CommentView } from './comment_view.js';
+/**
+ * Button displayed on a comment's top bar.
+ */
+export declare abstract class CommentBarButton implements IFocusableNode {
+    protected readonly id: string;
+    protected readonly workspace: WorkspaceSvg;
+    protected readonly container: SVGGElement;
+    protected readonly commentView: CommentView;
+    /**
+     * SVG image displayed on this button.
+     */
+    protected abstract readonly icon: SVGImageElement;
+    /**
+     * Creates a new CommentBarButton instance.
+     *
+     * @param id The ID of this button's parent comment.
+     * @param workspace The workspace this button's parent comment is on.
+     * @param container An SVG group that this button should be a child of.
+     */
+    constructor(id: string, workspace: WorkspaceSvg, container: SVGGElement, commentView: CommentView);
+    /**
+     * Returns whether or not this button is currently visible.
+     */
+    isVisible(): boolean;
+    /**
+     * Returns the parent comment view of this comment bar button.
+     */
+    getCommentView(): CommentView;
+    /** Adjusts the position of this button within its parent container. */
+    abstract reposition(): void;
+    /** Perform the action this button should take when it is acted on. */
+    abstract performAction(e?: Event): void;
+    /**
+     * Returns the dimensions of this button in workspace coordinates.
+     *
+     * @param includeMargin True to include the margin when calculating the size.
+     * @returns The size of this button.
+     */
+    getSize(includeMargin?: boolean): Rect;
+    /** Returns the margin in workspace coordinates surrounding this button. */
+    getMargin(): number;
+    /** Returns a DOM element representing this button that can receive focus. */
+    getFocusableElement(): SVGImageElement;
+    /** Returns the workspace this button is a child of. */
+    getFocusableTree(): WorkspaceSvg;
+    /** Called when this button's focusable DOM element gains focus. */
+    onNodeFocus(): void;
+    /** Called when this button's focusable DOM element loses focus. */
+    onNodeBlur(): void;
+    /** Returns whether this button can be focused. True if it is visible. */
+    canBeFocused(): boolean;
+}
+//# sourceMappingURL=comment_bar_button.d.ts.map

package/core/comments/comment_editor.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IFocusableNode } from '../interfaces/i_focusable_node.js';
+import { IFocusableTree } from '../interfaces/i_focusable_tree.js';
+import { Size } from '../utils/size.js';
+import { WorkspaceSvg } from '../workspace_svg.js';
+/**
+ * String added to the ID of a workspace comment to identify
+ * the focusable node for the comment editor.
+ */
+export declare const COMMENT_EDITOR_FOCUS_IDENTIFIER = "_comment_textarea_";
+/** The part of a comment that can be typed into. */
+export declare class CommentEditor implements IFocusableNode {
+    workspace: WorkspaceSvg;
+    private onFinishEditing?;
+    id?: string;
+    /** The foreignObject containing the HTML text area. */
+    private foreignObject;
+    /** The text area where the user can type. */
+    private textArea;
+    /** Listeners for changes to text. */
+    private textChangeListeners;
+    /** The current text of the comment. Updates on text area change. */
+    private text;
+    constructor(workspace: WorkspaceSvg, commentId?: string, onFinishEditing?: (() => void) | undefined);
+    /** Gets the dom structure for this comment editor. */
+    getDom(): SVGForeignObjectElement;
+    /** Gets the current text of the comment. */
+    getText(): string;
+    /** Sets the current text of the comment and fires change listeners. */
+    setText(text: string): void;
+    /**
+     * Triggers listeners when the text of the comment changes, either
+     * programmatically or manually by the user.
+     */
+    private onTextChange;
+    /**
+     * Do something when the user indicates they've finished editing.
+     *
+     * @param e Keyboard event.
+     */
+    private handleKeyDown;
+    /** Registers a callback that listens for text changes. */
+    addTextChangeListener(listener: (oldText: string, newText: string) => void): void;
+    /** Removes the given listener from the list of text change listeners. */
+    removeTextChangeListener(listener: () => void): void;
+    /** Sets the placeholder text displayed for an empty comment. */
+    setPlaceholderText(text: string): void;
+    /** Sets whether the textarea is editable. If not, the textarea will be readonly. */
+    setEditable(isEditable: boolean): void;
+    /** Update the size of the comment editor element. */
+    updateSize(size: Size, topBarSize: Size): void;
+    getFocusableElement(): HTMLElement | SVGElement;
+    getFocusableTree(): IFocusableTree;
+    onNodeFocus(): void;
+    onNodeBlur(): void;
+    canBeFocused(): boolean;
+}
+//# sourceMappingURL=comment_editor.d.ts.map

package/core/comments/comment_view.d.ts

@@ -0,0 +1,213 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IFocusableNode } from '../interfaces/i_focusable_node';
+import { IRenderedElement } from '../interfaces/i_rendered_element.js';
+import { Coordinate } from '../utils/coordinate.js';
+import { Size } from '../utils/size.js';
+import { WorkspaceSvg } from '../workspace_svg.js';
+import { CommentBarButton } from './comment_bar_button.js';
+export declare class CommentView implements IRenderedElement {
+    readonly workspace: WorkspaceSvg;
+    readonly commentId: string;
+    /** The root group element of the comment view. */
+    private svgRoot;
+    /**
+     * The SVG rect element that we use to create a highlight around the comment.
+     */
+    private highlightRect;
+    /** The group containing all of the top bar elements. */
+    private topBarGroup;
+    /** The rect background for the top bar. */
+    private topBarBackground;
+    /** The delete button that goes in the top bar. */
+    private deleteButton;
+    /** The foldout button that goes in the top bar. */
+    private foldoutButton;
+    /** The text element that goes in the top bar. */
+    private textPreview;
+    /** The actual text node in the text preview. */
+    private textPreviewNode;
+    /** The resize handle element. */
+    private resizeHandle;
+    /** The part of the comment view that contains the textarea to edit the comment. */
+    private commentEditor;
+    /** The current size of the comment in workspace units. */
+    private size;
+    /** Whether the comment is collapsed or not. */
+    private collapsed;
+    /** Whether the comment is editable or not. */
+    private editable;
+    /** The current location of the comment in workspace coordinates. */
+    private location;
+    /** Listeners for changes to size. */
+    private sizeChangeListeners;
+    /** Listeners for disposal. */
+    private disposeListeners;
+    /** Listeners for collapsing. */
+    private collapseChangeListeners;
+    /**
+     * Event data for the pointer up event on the resize handle. Used to
+     * unregister the listener.
+     */
+    private resizePointerUpListener;
+    /**
+     * Event data for the pointer move event on the resize handle. Used to
+     * unregister the listener.
+     */
+    private resizePointerMoveListener;
+    /** Whether this comment view is currently being disposed or not. */
+    protected disposing: boolean;
+    /** Whether this comment view has been disposed or not. */
+    protected disposed: boolean;
+    /** Size of this comment when the resize drag was initiated. */
+    private preResizeSize?;
+    /** The default size of newly created comments. */
+    static defaultCommentSize: Size;
+    constructor(workspace: WorkspaceSvg, commentId: string);
+    /**
+     * Creates the rect we use for highlighting the comment when it's selected.
+     */
+    private createHighlightRect;
+    /**
+     * Creates the top bar and the elements visually within it.
+     * Registers event listeners.
+     */
+    private createTopBar;
+    /**
+     * Creates the text area where users can type. Registers event listeners.
+     */
+    private createTextArea;
+    /**
+     *
+     * @returns The FocusableNode representing the editor portion of this comment.
+     */
+    getEditorFocusableNode(): IFocusableNode;
+    /** Creates the DOM elements for the comment resize handle. */
+    private createResizeHandle;
+    /** Returns the root SVG group element of the comment view. */
+    getSvgRoot(): SVGGElement;
+    /**
+     * Returns the current size of the comment in workspace units.
+     * Respects collapsing.
+     */
+    getSize(): Size;
+    /**
+     * Sets the size of the comment in workspace units, and updates the view
+     * elements to reflect the new size.
+     */
+    setSizeWithoutFiringEvents(size: Size): void;
+    /**
+     * Sets the size of the comment in workspace units, updates the view
+     * elements to reflect the new size, and triggers size change listeners.
+     */
+    setSize(size: Size): void;
+    /**
+     * Calculates the minimum size for the uncollapsed comment based on text
+     * size and visible icons.
+     *
+     * The minimum width is based on the width of the truncated preview text.
+     *
+     * The minimum height is based on the height of the top bar.
+     */
+    private calcMinSize;
+    /** Updates the size of the highlight rect to reflect the new size. */
+    private updateHighlightRect;
+    /** Updates the size of the top bar to reflect the new size. */
+    private updateTopBarSize;
+    /**
+     * Updates the size and position of the text preview elements to reflect the new size.
+     */
+    private updateTextPreviewSize;
+    /** Updates the position of the resize handle to reflect the new size. */
+    private updateResizeHandlePosition;
+    /**
+     * Triggers listeners when the size of the comment changes, either
+     * programmatically or manually by the user.
+     */
+    private onSizeChange;
+    /**
+     * Registers a callback that listens for size changes.
+     *
+     * @param listener Receives callbacks when the size of the comment changes.
+     *     The new and old size are in workspace units.
+     */
+    addSizeChangeListener(listener: (oldSize: Size, newSize: Size) => void): void;
+    /** Removes the given listener from the list of size change listeners. */
+    removeSizeChangeListener(listener: () => void): void;
+    /**
+     * Handles starting an interaction with the resize handle to resize the
+     * comment.
+     */
+    private onResizePointerDown;
+    /** Ends an interaction with the resize handle. */
+    private onResizePointerUp;
+    /** Resizes the comment in response to a drag on the resize handle. */
+    private onResizePointerMove;
+    /** Returns true if the comment is currently collapsed. */
+    isCollapsed(): boolean;
+    /** Sets whether the comment is currently collapsed or not. */
+    setCollapsed(collapsed: boolean): void;
+    /**
+     * Triggers listeners when the collapsed-ness of the comment changes, either
+     * progrmatically or manually by the user.
+     */
+    private onCollapse;
+    /** Registers a callback that listens for collapsed-ness changes. */
+    addOnCollapseListener(listener: (newCollapse: boolean) => void): void;
+    /** Removes the given listener from the list of on collapse listeners. */
+    removeOnCollapseListener(listener: () => void): void;
+    /** Returns true if the comment is currently editable. */
+    isEditable(): boolean;
+    /** Sets the editability of the comment. */
+    setEditable(editable: boolean): void;
+    /** Returns the current location of the comment in workspace coordinates. */
+    getRelativeToSurfaceXY(): Coordinate;
+    /**
+     * Moves the comment view to the given location.
+     *
+     * @param location The location to move to in workspace coordinates.
+     */
+    moveTo(location: Coordinate): void;
+    /** Returns the current text of the comment. */
+    getText(): string;
+    /** Sets the current text of the comment. */
+    setText(text: string): void;
+    /** Sets the placeholder text displayed for an empty comment. */
+    setPlaceholderText(text: string): void;
+    /** Registers a callback that listens for text changes on the comment editor. */
+    addTextChangeListener(listener: (oldText: string, newText: string) => void): void;
+    /** Removes the given listener from the comment editor. */
+    removeTextChangeListener(listener: () => void): void;
+    /** Updates the preview text element to reflect the given text. */
+    private updateTextPreview;
+    /** Truncates the text to fit within the top view. */
+    private truncateText;
+    /** Brings the workspace comment to the front of its layer. */
+    bringToFront(): void;
+    /**
+     * Handles disposing of the comment when we get a pointer down event on the
+     * delete icon.
+     */
+    private onDeleteDown;
+    /** Disposes of this comment view. */
+    dispose(): void;
+    /** Returns whether this comment view has been disposed or not. */
+    isDisposed(): boolean;
+    /**
+     * Returns true if this comment view is currently being disposed or has
+     * already been disposed.
+     */
+    isDeadOrDying(): boolean;
+    /** Registers a callback that listens for disposal of this view. */
+    addDisposeListener(listener: () => void): void;
+    /** Removes the given listener from the list of disposal listeners. */
+    removeDisposeListener(listener: () => void): void;
+    /**
+     * @internal
+     */
+    getCommentBarButtons(): CommentBarButton[];
+}
+//# sourceMappingURL=comment_view.d.ts.map

package/core/comments/delete_comment_bar_button.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { WorkspaceSvg } from '../workspace_svg.js';
+import { CommentBarButton } from './comment_bar_button.js';
+import type { CommentView } from './comment_view.js';
+/**
+ * Magic string appended to the comment ID to create a unique ID for this button.
+ */
+export declare const COMMENT_DELETE_BAR_BUTTON_FOCUS_IDENTIFIER = "_delete_bar_button";
+/**
+ * Button that deletes a comment.
+ */
+export declare class DeleteCommentBarButton extends CommentBarButton {
+    protected readonly id: string;
+    protected readonly workspace: WorkspaceSvg;
+    protected readonly container: SVGGElement;
+    protected readonly commentView: CommentView;
+    /**
+     * Opaque ID used to unbind event handlers during disposal.
+     */
+    private readonly bindId;
+    /**
+     * SVG image displayed on this button.
+     */
+    protected readonly icon: SVGImageElement;
+    /**
+     * Creates a new DeleteCommentBarButton instance.
+     *
+     * @param id The ID of this button's parent comment.
+     * @param workspace The workspace this button's parent comment is shown on.
+     * @param container An SVG group that this button should be a child of.
+     */
+    constructor(id: string, workspace: WorkspaceSvg, container: SVGGElement, commentView: CommentView);
+    /**
+     * Disposes of this button.
+     */
+    dispose(): void;
+    /**
+     * Adjusts the positioning of this button within its container.
+     */
+    reposition(): void;
+    /**
+     * Deletes parent comment.
+     *
+     * @param e The event that triggered this action.
+     */
+    performAction(e?: Event): void;
+}
+//# sourceMappingURL=delete_comment_bar_button.d.ts.map

package/core/comments/rendered_workspace_comment.d.ts

@@ -0,0 +1,121 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { WorkspaceCommentCopyData } from '../clipboard/workspace_comment_paster.js';
+import { IBoundedElement } from '../interfaces/i_bounded_element.js';
+import { IContextMenu } from '../interfaces/i_contextmenu.js';
+import { ICopyable } from '../interfaces/i_copyable.js';
+import { IDeletable } from '../interfaces/i_deletable.js';
+import { IDraggable } from '../interfaces/i_draggable.js';
+import { IFocusableNode } from '../interfaces/i_focusable_node.js';
+import type { IFocusableTree } from '../interfaces/i_focusable_tree.js';
+import { IRenderedElement } from '../interfaces/i_rendered_element.js';
+import { ISelectable } from '../interfaces/i_selectable.js';
+import { Coordinate } from '../utils/coordinate.js';
+import { Rect } from '../utils/rect.js';
+import { Size } from '../utils/size.js';
+import { WorkspaceSvg } from '../workspace_svg.js';
+import { CommentView } from './comment_view.js';
+import { WorkspaceComment } from './workspace_comment.js';
+export declare class RenderedWorkspaceComment extends WorkspaceComment implements IBoundedElement, IRenderedElement, IDraggable, ISelectable, IDeletable, ICopyable<WorkspaceCommentCopyData>, IContextMenu, IFocusableNode {
+    /** The class encompassing the svg elements making up the workspace comment. */
+    view: CommentView;
+    readonly workspace: WorkspaceSvg;
+    private dragStrategy;
+    /** Constructs the workspace comment, including the view. */
+    constructor(workspace: WorkspaceSvg, id?: string);
+    /**
+     * Adds listeners to the view that updates the model (i.e. the superclass)
+     * when changes are made to the view.
+     */
+    private addModelUpdateBindings;
+    /** Sets the text of the comment. */
+    setText(text: string): void;
+    /** Sets the placeholder text displayed if the comment is empty. */
+    setPlaceholderText(text: string): void;
+    /** Sets the size of the comment. */
+    setSize(size: Size): void;
+    /** Sets whether the comment is collapsed or not. */
+    setCollapsed(collapsed: boolean): void;
+    /** Sets whether the comment is editable or not. */
+    setEditable(editable: boolean): void;
+    /** Returns the root SVG element of this comment. */
+    getSvgRoot(): SVGElement;
+    /**
+     * Returns the comment's size in workspace units.
+     * Does not respect collapsing.
+     */
+    getSize(): Size;
+    /**
+     * Returns the bounding rectangle of this comment in workspace coordinates.
+     * Respects collapsing.
+     */
+    getBoundingRectangle(): Rect;
+    /** Move the comment by the given amounts in workspace coordinates. */
+    moveBy(dx: number, dy: number, reason?: string[] | undefined): void;
+    /** Moves the comment to the given location in workspace coordinates. */
+    moveTo(location: Coordinate, reason?: string[] | undefined): void;
+    /**
+     * Moves the comment during a drag. Doesn't fire move events.
+     *
+     * @internal
+     */
+    moveDuringDrag(location: Coordinate): void;
+    /**
+     * Adds the dragging CSS class to this comment.
+     *
+     * @internal
+     */
+    setDragging(dragging: boolean): void;
+    /** Disposes of the view. */
+    dispose(): void;
+    /**
+     * Starts a gesture because we detected a pointer down on the comment
+     * (that wasn't otherwise gobbled up, e.g. by resizing).
+     */
+    private startGesture;
+    /** Visually indicates that this comment would be deleted if dropped. */
+    setDeleteStyle(wouldDelete: boolean): void;
+    /** Returns whether this comment is copyable or not */
+    isCopyable(): boolean;
+    /** Returns whether this comment is movable or not. */
+    isMovable(): boolean;
+    /** Starts a drag on the comment. */
+    startDrag(): void;
+    /** Drags the comment to the given location. */
+    drag(newLoc: Coordinate): void;
+    /** Ends the drag on the comment. */
+    endDrag(): void;
+    /** Moves the comment back to where it was at the start of a drag. */
+    revertDrag(): void;
+    /** Visually highlights the comment. */
+    select(): void;
+    /** Visually unhighlights the comment. */
+    unselect(): void;
+    /**
+     * Returns a JSON serializable representation of this comment's state that
+     * can be used for pasting.
+     */
+    toCopyData(): WorkspaceCommentCopyData | null;
+    /** Show a context menu for this comment. */
+    showContextMenu(e: Event): void;
+    /** Snap this comment to the nearest grid point. */
+    snapToGrid(): void;
+    /**
+     * @returns The FocusableNode representing the editor portion of this comment.
+     */
+    getEditorFocusableNode(): IFocusableNode;
+    /** See IFocusableNode.getFocusableElement. */
+    getFocusableElement(): HTMLElement | SVGElement;
+    /** See IFocusableNode.getFocusableTree. */
+    getFocusableTree(): IFocusableTree;
+    /** See IFocusableNode.onNodeFocus. */
+    onNodeFocus(): void;
+    /** See IFocusableNode.onNodeBlur. */
+    onNodeBlur(): void;
+    /** See IFocusableNode.canBeFocused. */
+    canBeFocused(): boolean;
+}
+//# sourceMappingURL=rendered_workspace_comment.d.ts.map