blockly 8.20220331.0-beta.1 → 9.0.0-beta.0

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;

package/core/interfaces/i_flyout.js

@@ -1,201 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a flyout.
- */
-
-'use strict';
-
-/**
- * The interface for a flyout.
- * @namespace Blockly.IFlyout
- */
-goog.module('Blockly.IFlyout');
-
-/* eslint-disable-next-line no-unused-vars */
-const toolbox = goog.requireType('Blockly.utils.toolbox');
-/* 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');
-/* eslint-disable-next-line no-unused-vars */
-const {IRegistrable} = goog.require('Blockly.IRegistrable');
-/* eslint-disable-next-line no-unused-vars */
-const {Svg} = goog.requireType('Blockly.utils.Svg');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
-
-
-/**
- * Interface for a flyout.
- * @extends {IRegistrable}
- * @interface
- * @alias Blockly.IFlyout
- */
-const IFlyout = function() {};
-
-/**
- * Whether the flyout is laid out horizontally or not.
- * @type {boolean}
- */
-IFlyout.prototype.horizontalLayout;
-
-/**
- * Is RTL vs LTR.
- * @type {boolean}
- */
-IFlyout.prototype.RTL;
-
-/**
- * The target workspace
- * @type {?WorkspaceSvg}
- */
-IFlyout.prototype.targetWorkspace;
-
-/**
- * Margin around the edges of the blocks in the flyout.
- * @type {number}
- * @const
- */
-IFlyout.prototype.MARGIN;
-
-/**
- * Does the flyout automatically close when a block is created?
- * @type {boolean}
- */
-IFlyout.prototype.autoClose;
-
-/**
- * Corner radius of the flyout background.
- * @type {number}
- * @const
- */
-IFlyout.prototype.CORNER_RADIUS;
-
-/**
- * Creates the flyout's DOM.  Only needs to be called once.  The flyout can
- * either exist as its own svg element or be a g element nested inside a
- * separate svg element.
- * @param {string|
- * !Svg<!SVGSVGElement>|
- * !Svg<!SVGGElement>} tagName The type of tag to
- *     put the flyout in. This should be <svg> or <g>.
- * @return {!SVGElement} The flyout's SVG group.
- */
-IFlyout.prototype.createDom;
-
-/**
- * Initializes the flyout.
- * @param {!WorkspaceSvg} targetWorkspace The workspace in which to
- *     create new blocks.
- */
-IFlyout.prototype.init;
-
-/**
- * Dispose of this flyout.
- * Unlink from all DOM elements to prevent memory leaks.
- */
-IFlyout.prototype.dispose;
-
-/**
- * Get the width of the flyout.
- * @return {number} The width of the flyout.
- */
-IFlyout.prototype.getWidth;
-
-/**
- * Get the height of the flyout.
- * @return {number} The width of the flyout.
- */
-IFlyout.prototype.getHeight;
-
-/**
- * Get the workspace inside the flyout.
- * @return {!WorkspaceSvg} The workspace inside the flyout.
- */
-IFlyout.prototype.getWorkspace;
-
-/**
- * Is the flyout visible?
- * @return {boolean} True if visible.
- */
-IFlyout.prototype.isVisible;
-
-/**
- * Set whether the flyout is visible. A value of true does not necessarily mean
- * that the flyout is shown. It could be hidden because its container is hidden.
- * @param {boolean} visible True if visible.
- */
-IFlyout.prototype.setVisible;
-
-/**
- * Set whether this flyout's container is visible.
- * @param {boolean} visible Whether the container is visible.
- */
-IFlyout.prototype.setContainerVisible;
-
-/**
- * Hide and empty the flyout.
- */
-IFlyout.prototype.hide;
-
-/**
- * Show and populate the flyout.
- * @param {!toolbox.FlyoutDefinition|string} flyoutDef Contents to
- *     display in the flyout. This is either an array of Nodes, a NodeList, a
- *     toolbox definition, or a string with the name of the dynamic category.
- */
-IFlyout.prototype.show;
-
-/**
- * Create a copy of this block on the workspace.
- * @param {!BlockSvg} originalBlock The block to copy from the flyout.
- * @return {!BlockSvg} The newly created block.
- * @throws {Error} if something went wrong with deserialization.
- */
-IFlyout.prototype.createBlock;
-
-/**
- * Reflow blocks and their mats.
- */
-IFlyout.prototype.reflow;
-
-/**
- * @return {boolean} True if this flyout may be scrolled with a scrollbar or by
- *     dragging.
- */
-IFlyout.prototype.isScrollable;
-
-/**
- * Calculates the x coordinate for the flyout position.
- * @return {number} X coordinate.
- */
-IFlyout.prototype.getX;
-
-/**
- * Calculates the y coordinate for the flyout position.
- * @return {number} Y coordinate.
- */
-IFlyout.prototype.getY;
-
-/**
- * Position the flyout.
- * @return {void}
- */
-IFlyout.prototype.position;
-
-/**
- * Determine if a drag delta is toward the workspace, based on the position
- * and orientation of the flyout. This is used in determineDragIntention_ to
- * determine if a new block should be created or if the flyout should scroll.
- * @param {!Coordinate} currentDragDeltaXY How far the pointer has
- *     moved from the position at mouse down, in pixel units.
- * @return {boolean} True if the drag is toward the workspace.
- */
-IFlyout.prototype.isDragTowardWorkspace;
-
-exports.IFlyout = IFlyout;

package/core/interfaces/i_keyboard_accessible.js

@@ -1,38 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for objects that handle keyboard shortcuts.
- */
-
-'use strict';
-
-/**
- * The interface for objects that handle keyboard shortcuts.
- * @namespace Blockly.IKeyboardAccessible
- */
-goog.module('Blockly.IKeyboardAccessible');
-
-/* eslint-disable-next-line no-unused-vars */
-const {ShortcutRegistry} = goog.requireType('Blockly.ShortcutRegistry');
-
-
-/**
- * An interface for an object that handles keyboard shortcuts.
- * @interface
- * @alias Blockly.IKeyboardAccessible
- */
-const IKeyboardAccessible = function() {};
-
-/**
- * Handles the given keyboard shortcut.
- * @param {!ShortcutRegistry.KeyboardShortcut} shortcut The shortcut to be
- *     handled.
- * @return {boolean} True if the shortcut has been handled, false otherwise.
- */
-IKeyboardAccessible.prototype.onShortcut;
-
-exports.IKeyboardAccessible = IKeyboardAccessible;