blockly 8.0.5 → 9.0.0-beta.0

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;

package/core/interfaces/i_metrics_manager.js

@@ -1,154 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a metrics manager.
- */
-
-'use strict';
-
-/**
- * The interface for a metrics manager.
- * @namespace Blockly.IMetricsManager
- */
-goog.module('Blockly.IMetricsManager');
-
-/* eslint-disable-next-line no-unused-vars */
-const {MetricsManager} = goog.requireType('Blockly.MetricsManager');
-/* eslint-disable-next-line no-unused-vars */
-const {Metrics} = goog.requireType('Blockly.utils.Metrics');
-/* eslint-disable-next-line no-unused-vars */
-const {Size} = goog.requireType('Blockly.utils.Size');
-
-
-/**
- * Interface for a metrics manager.
- * @interface
- * @alias Blockly.IMetricsManager
- */
-const IMetricsManager = function() {};
-
-/**
- * Returns whether the scroll area has fixed edges.
- * @return {boolean} Whether the scroll area has fixed edges.
- * @package
- */
-IMetricsManager.prototype.hasFixedEdges;
-
-/**
- * Returns the metrics for the scroll area of the workspace.
- * @param {boolean=} opt_getWorkspaceCoordinates True to get the scroll metrics
- *     in workspace coordinates, false to get them in pixel coordinates.
- * @param {!MetricsManager.ContainerRegion=} opt_viewMetrics The view
- *     metrics if they have been previously computed. Passing in null may cause
- *     the view metrics to be computed again, if it is needed.
- * @param {!MetricsManager.ContainerRegion=} opt_contentMetrics The
- *     content metrics if they have been previously computed. Passing in null
- *     may cause the content metrics to be computed again, if it is needed.
- * @return {!MetricsManager.ContainerRegion} The metrics for the scroll
- *    container
- */
-IMetricsManager.prototype.getScrollMetrics;
-
-/**
- * Gets the width and the height of the flyout on the workspace in pixel
- * coordinates. Returns 0 for the width and height if the workspace has a
- * category toolbox instead of a simple toolbox.
- * @param {boolean=} opt_own Whether to only return the workspace's own flyout.
- * @return {!MetricsManager.ToolboxMetrics} The width and height of the
- *     flyout.
- * @public
- */
-IMetricsManager.prototype.getFlyoutMetrics;
-
-/**
- * Gets the width, height and position of the toolbox on the workspace in pixel
- * coordinates. Returns 0 for the width and height if the workspace has a simple
- * toolbox instead of a category toolbox. To get the width and height of a
- * simple toolbox @see {@link getFlyoutMetrics}.
- * @return {!MetricsManager.ToolboxMetrics} The object with the width,
- *     height and position of the toolbox.
- * @public
- */
-IMetricsManager.prototype.getToolboxMetrics;
-
-/**
- * Gets the width and height of the workspace's parent SVG element in pixel
- * coordinates. This area includes the toolbox and the visible workspace area.
- * @return {!Size} The width and height of the workspace's parent
- *     SVG element.
- * @public
- */
-IMetricsManager.prototype.getSvgMetrics;
-
-/**
- * Gets the absolute left and absolute top in pixel coordinates.
- * This is where the visible workspace starts in relation to the SVG container.
- * @return {!MetricsManager.AbsoluteMetrics} The absolute metrics for
- *     the workspace.
- * @public
- */
-IMetricsManager.prototype.getAbsoluteMetrics;
-
-/**
- * Gets the metrics for the visible workspace in either pixel or workspace
- * coordinates. The visible workspace does not include the toolbox or flyout.
- * @param {boolean=} opt_getWorkspaceCoordinates True to get the view metrics in
- *     workspace coordinates, false to get them in pixel coordinates.
- * @return {!MetricsManager.ContainerRegion} The width, height, top and
- *     left of the viewport in either workspace coordinates or pixel
- *     coordinates.
- * @public
- */
-IMetricsManager.prototype.getViewMetrics;
-
-/**
- * Gets content metrics in either pixel or workspace coordinates.
- * The content area is a rectangle around all the top bounded elements on the
- * workspace (workspace comments and blocks).
- * @param {boolean=} opt_getWorkspaceCoordinates True to get the content metrics
- *     in workspace coordinates, false to get them in pixel coordinates.
- * @return {!MetricsManager.ContainerRegion} The
- *     metrics for the content container.
- * @public
- */
-IMetricsManager.prototype.getContentMetrics;
-
-/**
- * Returns an object with all the metrics required to size scrollbars for a
- * top level workspace.  The following properties are computed:
- * Coordinate system: pixel coordinates, -left, -up, +right, +down
- * .viewHeight: Height of the visible portion of the workspace.
- * .viewWidth: Width of the visible portion of the workspace.
- * .contentHeight: Height of the content.
- * .contentWidth: Width of the content.
- * .svgHeight: Height of the Blockly div (the view + the toolbox,
- *    simple or otherwise),
- * .svgWidth: Width of the Blockly div (the view + the toolbox,
- *    simple or otherwise),
- * .viewTop: Top-edge of the visible portion of the workspace, relative to
- *     the workspace origin.
- * .viewLeft: Left-edge of the visible portion of the workspace, relative to
- *     the workspace origin.
- * .contentTop: Top-edge of the content, relative to the workspace origin.
- * .contentLeft: Left-edge of the content relative to the workspace origin.
- * .absoluteTop: Top-edge of the visible portion of the workspace, relative
- *     to the blocklyDiv.
- * .absoluteLeft: Left-edge of the visible portion of the workspace, relative
- *     to the blocklyDiv.
- * .toolboxWidth: Width of the toolbox, if it exists.  Otherwise zero.
- * .toolboxHeight: Height of the toolbox, if it exists.  Otherwise zero.
- * .flyoutWidth: Width of the flyout if it is always open.  Otherwise zero.
- * .flyoutHeight: Height of the flyout if it is always open.  Otherwise zero.
- * .toolboxPosition: Top, bottom, left or right. Use TOOLBOX_AT constants to
- *     compare.
- * @return {!Metrics} Contains size and position metrics of a top
- *     level workspace.
- * @public
- */
-IMetricsManager.prototype.getMetrics;
-
-exports.IMetricsManager = IMetricsManager;

package/core/interfaces/i_positionable.js

@@ -1,51 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a positionable UI element.
- */
-
-'use strict';
-
-/**
- * The interface for a positionable UI element.
- * @namespace Blockly.IPositionable
- */
-goog.module('Blockly.IPositionable');
-
-/* eslint-disable-next-line no-unused-vars */
-const {IComponent} = goog.require('Blockly.IComponent');
-/* eslint-disable-next-line no-unused-vars */
-const {MetricsManager} = goog.requireType('Blockly.MetricsManager');
-/* eslint-disable-next-line no-unused-vars */
-const {Rect} = goog.requireType('Blockly.utils.Rect');
-
-
-/**
- * Interface for a component that is positioned on top of the workspace.
- * @extends {IComponent}
- * @interface
- * @alias Blockly.IPositionable
- */
-const IPositionable = function() {};
-
-/**
- * Positions the element. Called when the window is resized.
- * @param {!MetricsManager.UiMetrics} metrics The workspace metrics.
- * @param {!Array<!Rect>} savedPositions List of rectangles that
- *     are already on the workspace.
- */
-IPositionable.prototype.position;
-
-/**
- * Returns the bounding rectangle of the UI element in pixel units relative to
- * the Blockly injection div.
- * @return {?Rect} The UI elements's bounding box. Null if
- *   bounding box should be ignored by other UI elements.
- */
-IPositionable.prototype.getBoundingRectangle;
-
-exports.IPositionable = IPositionable;

package/core/interfaces/i_selectable.js

@@ -1,51 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that is selectable.
- */
-
-'use strict';
-
-/**
- * The interface for an object that is selectable.
- * @namespace Blockly.ISelectable
- */
-goog.module('Blockly.ISelectable');
-
-// eslint-disable-next-line no-unused-vars
-const {IDeletable} = goog.require('Blockly.IDeletable');
-// eslint-disable-next-line no-unused-vars
-const {IMovable} = goog.require('Blockly.IMovable');
-
-
-/**
- * The interface for an object that is selectable.
- * @extends {IDeletable}
- * @extends {IMovable}
- * @interface
- * @alias Blockly.ISelectable
- */
-const ISelectable = function() {};
-
-/**
- * @type {string}
- */
-ISelectable.prototype.id;
-
-/**
- * Select this.  Highlight it visually.
- * @return {void}
- */
-ISelectable.prototype.select;
-
-/**
- * Unselect this.  Unhighlight it visually.
- * @return {void}
- */
-ISelectable.prototype.unselect;
-
-exports.ISelectable = ISelectable;

package/core/interfaces/i_selectable_toolbox_item.js

@@ -1,73 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a selectable toolbox item.
- */
-
-'use strict';
-
-/**
- * The interface for a selectable toolbox item.
- * @namespace Blockly.ISelectableToolboxItem
- */
-goog.module('Blockly.ISelectableToolboxItem');
-
-/* eslint-disable-next-line no-unused-vars */
-const toolbox = goog.requireType('Blockly.utils.toolbox');
-/* eslint-disable-next-line no-unused-vars */
-const {IToolboxItem} = goog.require('Blockly.IToolboxItem');
-
-
-/**
- * Interface for an item in the toolbox that can be selected.
- * @extends {IToolboxItem}
- * @interface
- * @alias Blockly.ISelectableToolboxItem
- */
-const ISelectableToolboxItem = function() {};
-
-/**
- * Gets the name of the toolbox item. Used for emitting events.
- * @return {string} The name of the toolbox item.
- * @public
- */
-ISelectableToolboxItem.prototype.getName;
-
-/**
- * Gets the contents of the toolbox item. These are items that are meant to be
- * displayed in the flyout.
- * @return {!toolbox.FlyoutItemInfoArray|string} The definition
- *     of items to be displayed in the flyout.
- * @public
- */
-ISelectableToolboxItem.prototype.getContents;
-
-/**
- * Sets the current toolbox item as selected.
- * @param {boolean} _isSelected True if this category is selected, false
- *     otherwise.
- * @public
- */
-ISelectableToolboxItem.prototype.setSelected;
-
-/**
- * Gets the HTML element that is clickable.
- * The parent toolbox element receives clicks. The parent toolbox will add an ID
- * to this element so it can pass the onClick event to the correct toolboxItem.
- * @return {!Element} The HTML element that receives clicks.
- * @public
- */
-ISelectableToolboxItem.prototype.getClickTarget;
-
-/**
- * Handles when the toolbox item is clicked.
- * @param {!Event} _e Click event to handle.
- * @public
- */
-ISelectableToolboxItem.prototype.onClick;
-
-exports.ISelectableToolboxItem = ISelectableToolboxItem;

package/core/interfaces/i_serializer.js

@@ -1,77 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The record type for an object containing functions for
- * serializing part of the workspace.
- */
-
-'use strict';
-
-/**
- * The record type for an object containing functions for
- *     serializing part of the workspace.
- * @namespace Blockly.serialization.ISerializer
- */
-goog.module('Blockly.serialization.ISerializer');
-
-// eslint-disable-next-line no-unused-vars
-const {Workspace} = goog.requireType('Blockly.Workspace');
-
-
-/**
- * Serializes and deserializes a plugin or system.
- * @interface
- * @alias Blockly.serialization.ISerializer.ISerializer
- */
-class ISerializer {
-  /* eslint-disable-next-line require-jsdoc */
-  constructor() {
-    /**
-     * A priority value used to determine the order of deserializing state.
-     * More positive priorities are deserialized before less positive
-     * priorities. Eg if you have priorities (0, -10, 10, 100) the order of
-     * deserialiation will be (100, 10, 0, -10).
-     * If two serializers have the same priority, they are deserialized in an
-     * arbitrary order relative to each other.
-     * @type {number}
-     */
-    this.priority;
-  }
-
-  /* eslint-disable no-unused-vars, valid-jsdoc */
-
-  /**
-   * Saves the state of the plugin or system.
-   * @param {!Workspace} workspace The workspace the system to serialize is
-   *     associated with.
-   * @return {?} A JS object containing the system's state, or null if
-   *     there is no state to record.
-   */
-  save(workspace) {}
-
-  /* eslint-enable valid-jsdoc */
-
-  /**
-   * Loads the state of the plugin or system.
-   * @param {?} state The state of the system to deserialize. This will always
-   *     be non-null.
-   * @param {!Workspace} workspace The workspace the system to deserialize is
-   *     associated with.
-   */
-  load(state, workspace) {}
-
-  /**
-   * Clears the state of the plugin or system.
-   * @param {!Workspace} workspace The workspace the system to clear the state
-   *     of is associated with.
-   */
-  clear(workspace) {}
-
-  /* eslint-enable no-unused-vars */
-}
-
-exports.ISerializer = ISerializer;

package/core/interfaces/i_styleable.js

@@ -1,39 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an object that a style can be added to.
- */
-
-'use strict';
-
-/**
- * The interface for an object that a style can be added to.
- * @namespace Blockly.IStyleable
- */
-goog.module('Blockly.IStyleable');
-
-
-/**
- * Interface for an object that a style can be added to.
- * @interface
- * @alias Blockly.IStyleable
- */
-const IStyleable = function() {};
-
-/**
- * Adds a style on the toolbox. Usually used to change the cursor.
- * @param {string} style The name of the class to add.
- */
-IStyleable.prototype.addStyle;
-
-/**
- * Removes a style from the toolbox. Usually used to change the cursor.
- * @param {string} style The name of the class to remove.
- */
-IStyleable.prototype.removeStyle;
-
-exports.IStyleable = IStyleable;