mirror of
https://github.com/google/blockly.git
synced 2026-01-08 17:40:09 +01:00
794c045691
* chore: rename bubble to old bubble * chore: work on new bubble class * chore: basic bubble implementation * chore: add positioning code * chore: add positioning code * chore: more layouting code * chore: implement IBubble thingies in new bubble * chore: add docs * chore: PR comments * chore: fixup positioning bugs * chore: fix lint * chore: change height and width to get methods
65 lines
1.6 KiB
TypeScript
65 lines
1.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
import type {Coordinate} from '../utils/coordinate.js';
|
|
goog.declareModuleId('Blockly.IBubble');
|
|
|
|
import type {IContextMenu} from './i_contextmenu.js';
|
|
import type {IDraggable} from './i_draggable.js';
|
|
|
|
/**
|
|
* A bubble interface.
|
|
*/
|
|
export interface IBubble extends IDraggable, IContextMenu {
|
|
/**
|
|
* Return the coordinates of the top-left corner of this bubble's body
|
|
* relative to the drawing surface's origin (0,0), in workspace units.
|
|
*
|
|
* @returns Object with .x and .y properties.
|
|
*/
|
|
getRelativeToSurfaceXY(): Coordinate;
|
|
|
|
/**
|
|
* Return the root node of the bubble's SVG group.
|
|
*
|
|
* @returns The root SVG node of the bubble's group.
|
|
*/
|
|
getSvgRoot(): SVGElement;
|
|
|
|
/**
|
|
* Sets whether or not this bubble is being dragged.
|
|
*
|
|
* @param adding True if dragging, false otherwise.
|
|
*/
|
|
setDragging(dragging: boolean): void;
|
|
|
|
/**
|
|
* Move this bubble during a drag.
|
|
*
|
|
* @param newLoc The location to translate to, in workspace coordinates.
|
|
*/
|
|
moveDuringDrag(newLoc: Coordinate): void;
|
|
|
|
/**
|
|
* Move the bubble to the specified location in workspace coordinates.
|
|
*
|
|
* @param x The x position to move to.
|
|
* @param y The y position to move to.
|
|
*/
|
|
moveTo(x: number, y: number): void;
|
|
|
|
/**
|
|
* Update the style of this bubble when it is dragged over a delete area.
|
|
*
|
|
* @param enable True if the bubble is about to be deleted, false otherwise.
|
|
*/
|
|
setDeleteStyle(enable: boolean): void;
|
|
|
|
/** Dispose of this bubble. */
|
|
dispose(): void;
|
|
}
|