blockly 8.0.5 → 9.0.0-beta.0

package/core/interfaces/i_block_dragger.js

@@ -1,66 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a block dragger.
- */
-
-'use strict';
-
-/**
- * The interface for a block dragger.
- * @namespace Blockly.IBlockDragger
- */
-goog.module('Blockly.IBlockDragger');
-
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Coordinate} = goog.requireType('Blockly.utils.Coordinate');
-
-
-/**
- * A block dragger interface.
- * @interface
- * @alias Blockly.IBlockDragger
- */
-const IBlockDragger = function() {};
-
-/**
- * Start dragging a block.  This includes moving it to the drag surface.
- * @param {!Coordinate} currentDragDeltaXY How far the pointer has
- *     moved from the position at mouse down, in pixel units.
- * @param {boolean} healStack Whether or not to heal the stack after
- *     disconnecting.
- */
-IBlockDragger.prototype.startDrag;
-
-/**
- * Execute a step of block dragging, based on the given event.  Update the
- * display accordingly.
- * @param {!Event} e The most recent move event.
- * @param {!Coordinate} currentDragDeltaXY How far the pointer has
- *     moved from the position at the start of the drag, in pixel units.
- */
-IBlockDragger.prototype.drag;
-
-/**
- * Finish a block drag and put the block back on the workspace.
- * @param {!Event} e The mouseup/touchend event.
- * @param {!Coordinate} currentDragDeltaXY How far the pointer has
- *     moved from the position at the start of the drag, in pixel units.
- */
-IBlockDragger.prototype.endDrag;
-
-/**
- * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
- * or 2 insertion markers.
- * @return {!Array.<!BlockSvg>} A possibly empty list of insertion
- *     marker blocks.
- */
-IBlockDragger.prototype.getInsertionMarkers;
-
-exports.IBlockDragger = IBlockDragger;

package/core/interfaces/i_bounded_element.js

@@ -1,45 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a bounded element.
- */
-
-'use strict';
-
-/**
- * The interface for a bounded element.
- * @namespace Blockly.IBoundedElement
- */
-goog.module('Blockly.IBoundedElement');
-
-/* eslint-disable-next-line no-unused-vars */
-const {Rect} = goog.requireType('Blockly.utils.Rect');
-
-
-/**
- * A bounded element interface.
- * @interface
- * @alias Blockly.IBoundedElement
- */
-const IBoundedElement = function() {};
-
-/**
- * Returns the coordinates of a bounded element describing the dimensions of the
- * element.
- * Coordinate system: workspace coordinates.
- * @return {!Rect} Object with coordinates of the bounded element.
- */
-IBoundedElement.prototype.getBoundingRectangle;
-
-/**
- * Move the element by a relative offset.
- * @param {number} dx Horizontal offset in workspace units.
- * @param {number} dy Vertical offset in workspace units.
- */
-IBoundedElement.prototype.moveBy;
-
-exports.IBoundedElement = IBoundedElement;

package/core/interfaces/i_bubble.js

@@ -1,95 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a bubble.
- */
-
-'use strict';
-
-/**
- * The interface for a bubble.
- * @namespace Blockly.IBubble
- */
-goog.module('Blockly.IBubble');
-
-/* eslint-disable-next-line no-unused-vars */
-const {BlockDragSurfaceSvg} = goog.requireType('Blockly.BlockDragSurfaceSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Coordinate} = goog.requireType('Blockly.utils.Coordinate');
-/* eslint-disable-next-line no-unused-vars */
-const {IContextMenu} = goog.require('Blockly.IContextMenu');
-/* eslint-disable-next-line no-unused-vars */
-const {IDraggable} = goog.require('Blockly.IDraggable');
-
-
-/**
- * A bubble interface.
- * @interface
- * @extends {IDraggable}
- * @extends {IContextMenu}
- * @alias Blockly.IBubble
- */
-const IBubble = function() {};
-
-/**
- * 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.
- * @return {!Coordinate} Object with .x and .y properties.
- */
-IBubble.prototype.getRelativeToSurfaceXY;
-
-/**
- * Return the root node of the bubble's SVG group.
- * @return {!SVGElement} The root SVG node of the bubble's group.
- */
-IBubble.prototype.getSvgRoot;
-
-/**
- * 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 {boolean} enable True if auto-layout should be enabled, false
- *     otherwise.
- */
-IBubble.prototype.setAutoLayout;
-
-/**
- * Triggers a move callback if one exists at the end of a drag.
- * @param {boolean} adding True if adding, false if removing.
- */
-IBubble.prototype.setDragging;
-
-/**
- * Move this bubble during a drag, taking into account whether or not there is
- * a drag surface.
- * @param {?BlockDragSurfaceSvg} dragSurface The surface that carries
- *     rendered items during a drag, or null if no drag surface is in use.
- * @param {!Coordinate} newLoc The location to translate to, in
- *     workspace coordinates.
- */
-IBubble.prototype.moveDuringDrag;
-
-/**
- * Move the bubble to the specified location in workspace coordinates.
- * @param {number} x The x position to move to.
- * @param {number} y The y position to move to.
- */
-IBubble.prototype.moveTo;
-
-/**
- * Update the style of this bubble when it is dragged over a delete area.
- * @param {boolean} enable True if the bubble is about to be deleted, false
- *     otherwise.
- */
-IBubble.prototype.setDeleteStyle;
-
-/**
- * Dispose of this bubble.
- */
-IBubble.prototype.dispose;
-
-exports.IBubble = IBubble;

package/core/interfaces/i_collapsible_toolbox_item.js

@@ -1,53 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a collapsible toolbox item.
- */
-
-'use strict';
-
-/**
- * The interface for a collapsible toolbox item.
- * @namespace Blockly.ICollapsibleToolboxItem
- */
-goog.module('Blockly.ICollapsibleToolboxItem');
-
-/* eslint-disable-next-line no-unused-vars */
-const {ISelectableToolboxItem} = goog.require('Blockly.ISelectableToolboxItem');
-/* eslint-disable-next-line no-unused-vars */
-const {IToolboxItem} = goog.requireType('Blockly.IToolboxItem');
-
-
-/**
- * Interface for an item in the toolbox that can be collapsed.
- * @extends {ISelectableToolboxItem}
- * @interface
- * @alias Blockly.ICollapsibleToolboxItem
- */
-const ICollapsibleToolboxItem = function() {};
-
-/**
- * Gets any children toolbox items. (ex. Gets the subcategories)
- * @return {!Array<!IToolboxItem>} The child toolbox items.
- */
-ICollapsibleToolboxItem.prototype.getChildToolboxItems;
-
-/**
- * Whether the toolbox item is expanded to show its child subcategories.
- * @return {boolean} True if the toolbox item shows its children, false if it
- *     is collapsed.
- * @public
- */
-ICollapsibleToolboxItem.prototype.isExpanded;
-
-/**
- * Toggles whether or not the toolbox item is expanded.
- * @public
- */
-ICollapsibleToolboxItem.prototype.toggleExpanded;
-
-exports.ICollapsibleToolboxItem = ICollapsibleToolboxItem;

package/core/interfaces/i_connection_checker.js

@@ -1,104 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that encapsulates logic for
- * checking whether a potential connection is safe and valid.
- */
-'use strict';
-
-/**
- * The interface for an object that encapsulates logic for
- * checking whether a potential connection is safe and valid.
- * @namespace Blockly.IConnectionChecker
- */
-goog.module('Blockly.IConnectionChecker');
-
-/* eslint-disable-next-line no-unused-vars */
-const {Connection} = goog.requireType('Blockly.Connection');
-/* eslint-disable-next-line no-unused-vars */
-const {RenderedConnection} = goog.requireType('Blockly.RenderedConnection');
-
-
-/**
- * Class for connection type checking logic.
- * @interface
- * @alias Blockly.IConnectionChecker
- */
-const IConnectionChecker = function() {};
-
-/**
- * Check whether the current connection can connect with the target
- * connection.
- * @param {Connection} a Connection to check compatibility with.
- * @param {Connection} b Connection to check compatibility with.
- * @param {boolean} isDragging True if the connection is being made by dragging
- *     a block.
- * @param {number=} opt_distance The max allowable distance between the
- *     connections for drag checks.
- * @return {boolean} Whether the connection is legal.
- * @public
- */
-IConnectionChecker.prototype.canConnect;
-
-/**
- * Checks whether the current connection can connect with the target
- * connection, and return an error code if there are problems.
- * @param {Connection} a Connection to check compatibility with.
- * @param {Connection} b Connection to check compatibility with.
- * @param {boolean} isDragging True if the connection is being made by dragging
- *     a block.
- * @param {number=} opt_distance The max allowable distance between the
- *     connections for drag checks.
- * @return {number} Connection.CAN_CONNECT if the connection is legal,
- *    an error code otherwise.
- * @public
- */
-IConnectionChecker.prototype.canConnectWithReason;
-
-/**
- * Helper method that translates a connection error code into a string.
- * @param {number} errorCode The error code.
- * @param {Connection} a One of the two connections being checked.
- * @param {Connection} b The second of the two connections being
- *     checked.
- * @return {string} A developer-readable error string.
- * @public
- */
-IConnectionChecker.prototype.getErrorMessage;
-
-/**
- * Check that connecting the given connections is safe, meaning that it would
- * not break any of Blockly's basic assumptions (e.g. no self connections).
- * @param {Connection} a The first of the connections to check.
- * @param {Connection} b The second of the connections to check.
- * @return {number} An enum with the reason this connection is safe or unsafe.
- * @public
- */
-IConnectionChecker.prototype.doSafetyChecks;
-
-/**
- * Check whether this connection is compatible with another connection with
- * respect to the value type system.  E.g. square_root("Hello") is not
- * compatible.
- * @param {!Connection} a Connection to compare.
- * @param {!Connection} b Connection to compare against.
- * @return {boolean} True if the connections share a type.
- * @public
- */
-IConnectionChecker.prototype.doTypeChecks;
-
-/**
- * Check whether this connection can be made by dragging.
- * @param {!RenderedConnection} a Connection to compare.
- * @param {!RenderedConnection} b Connection to compare against.
- * @param {number} distance The maximum allowable distance between connections.
- * @return {boolean} True if the connection is allowed during a drag.
- * @public
- */
-IConnectionChecker.prototype.doDragChecks;
-
-exports.IConnectionChecker = IConnectionChecker;

package/core/interfaces/i_contextmenu.js

@@ -1,32 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that supports a right-click.
- */
-
-'use strict';
-
-/**
- * The interface for an object that supports a right-click.
- * @namespace Blockly.IContextMenu
- */
-goog.module('Blockly.IContextMenu');
-
-
-/**
- * @interface
- * @alias Blockly.IContextMenu
- */
-const IContextMenu = function() {};
-
-/**
- * Show the context menu for this object.
- * @param {!Event} e Mouse event.
- */
-IContextMenu.prototype.showContextMenu;
-
-exports.IContextMenu = IContextMenu;

package/core/interfaces/i_copyable.js

@@ -1,49 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that is copyable.
- */
-
-'use strict';
-
-/**
- * The interface for an object that is copyable.
- * @namespace Blockly.ICopyable
- */
-goog.module('Blockly.ICopyable');
-
-/* eslint-disable-next-line no-unused-vars */
-const {ISelectable} = goog.require('Blockly.ISelectable');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
-
-
-/**
- * @extends {ISelectable}
- * @interface
- * @alias Blockly.ICopyable
- */
-const ICopyable = function() {};
-
-/**
- * Encode for copying.
- * @return {?ICopyable.CopyData} Copy metadata.
- * @package
- */
-ICopyable.prototype.toCopyData;
-
-/**
- * Copy Metadata.
- * @typedef {{
- *            saveInfo:(!Object|!Element),
- *            source:WorkspaceSvg,
- *            typeCounts:?Object
- *          }}
- */
-ICopyable.CopyData;
-
-exports.ICopyable = ICopyable;

package/core/interfaces/i_delete_area.js

@@ -1,50 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a component that can delete a block or bubble
- * that is dropped on top of it.
- */
-
-'use strict';
-
-/**
- * The interface for a component that can delete a block or bubble
- * that is dropped on top of it.
- * @namespace Blockly.IDeleteArea
- */
-goog.module('Blockly.IDeleteArea');
-
-/* eslint-disable-next-line no-unused-vars */
-const {IDragTarget} = goog.require('Blockly.IDragTarget');
-/* eslint-disable-next-line no-unused-vars */
-const {IDraggable} = goog.requireType('Blockly.IDraggable');
-
-
-/**
- * Interface for a component that can delete a block or bubble that is dropped
- * on top of it.
- * @extends {IDragTarget}
- * @interface
- * @alias Blockly.IDeleteArea
- */
-const IDeleteArea = function() {};
-
-/**
- * Returns whether the provided block or bubble would be deleted if dropped on
- * this area.
- * This method should check if the element is deletable and is always called
- * before onDragEnter/onDragOver/onDragExit.
- * @param {!IDraggable} element The block or bubble currently being
- *   dragged.
- * @param {boolean} couldConnect Whether the element could could connect to
- *     another.
- * @return {boolean} Whether the element provided would be deleted if dropped on
- *     this area.
- */
-IDeleteArea.prototype.wouldDelete;
-
-exports.IDeleteArea = IDeleteArea;

package/core/interfaces/i_drag_target.js

@@ -1,88 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a component that has a handler for when a
- * block is dropped on top of it.
- */
-
-'use strict';
-
-/**
- * The interface for a component that has a handler for when a
- * block is dropped on top of it.
- * @namespace Blockly.IDragTarget
- */
-goog.module('Blockly.IDragTarget');
-
-/* eslint-disable-next-line no-unused-vars */
-const {IComponent} = goog.require('Blockly.IComponent');
-/* eslint-disable-next-line no-unused-vars */
-const {IDraggable} = goog.requireType('Blockly.IDraggable');
-/* eslint-disable-next-line no-unused-vars */
-const {Rect} = goog.requireType('Blockly.utils.Rect');
-
-
-/**
- * Interface for a component with custom behaviour when a block or bubble is
- * dragged over or dropped on top of it.
- * @extends {IComponent}
- * @interface
- * @alias Blockly.IDragTarget
- */
-const IDragTarget = function() {};
-
-/**
- * Returns the bounding rectangle of the drag target area in pixel units
- * relative to viewport.
- * @return {?Rect} The component's bounding box. Null if drag
- *   target area should be ignored.
- */
-IDragTarget.prototype.getClientRect;
-
-/**
- * Handles when a cursor with a block or bubble enters this drag target.
- * @param {!IDraggable} dragElement The block or bubble currently being
- *   dragged.
- */
-IDragTarget.prototype.onDragEnter;
-
-/**
- * Handles when a cursor with a block or bubble is dragged over this drag
- * target.
- * @param {!IDraggable} dragElement The block or bubble currently being
- *   dragged.
- */
-IDragTarget.prototype.onDragOver;
-
-
-/**
- * Handles when a cursor with a block or bubble exits this drag target.
- * @param {!IDraggable} dragElement The block or bubble currently being
- *   dragged.
- */
-IDragTarget.prototype.onDragExit;
-
-/**
- * Handles when a block or bubble is dropped on this component.
- * Should not handle delete here.
- * @param {!IDraggable} dragElement The block or bubble currently being
- *   dragged.
- */
-IDragTarget.prototype.onDrop;
-
-/**
- * Returns whether the provided block or bubble should not be moved after being
- * dropped on this component. If true, the element will return to where it was
- * when the drag started.
- * @param {!IDraggable} dragElement The block or bubble currently being
- *   dragged.
- * @return {boolean} Whether the block or bubble provided should be returned to
- *     drag start.
- */
-IDragTarget.prototype.shouldPreventMove;
-
-exports.IDragTarget = IDragTarget;