mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +01:00
fix: Move @alias onto classes instead of constructors (#6003)
* fix: Move @alias onto classes instead of constructors * fix: Fix JSDoc for constructors.
This commit is contained in:
@@ -67,6 +67,7 @@ goog.require('Blockly.Events.BlockMove');
|
||||
* @implements {IASTNodeLocation}
|
||||
* @implements {IDeletable}
|
||||
* @unrestricted
|
||||
* @alias Blockly.Block
|
||||
*/
|
||||
class Block {
|
||||
/**
|
||||
@@ -76,7 +77,6 @@ class Block {
|
||||
* @param {string=} opt_id Optional ID. Use this ID if provided, otherwise
|
||||
* create a new ID.
|
||||
* @throws When the prototypeName is not valid or not allowed.
|
||||
* @alias Blockly.Block
|
||||
*/
|
||||
constructor(workspace, prototypeName, opt_id) {
|
||||
const {Generator} = goog.module.get('Blockly.Generator');
|
||||
|
||||
@@ -35,11 +35,11 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
/**
|
||||
* Class for a drag surface for the currently dragged block. This is a separate
|
||||
* SVG that contains only the currently moving block, or nothing.
|
||||
* @alias Blockly.BlockDragSurfaceSvg
|
||||
*/
|
||||
const BlockDragSurfaceSvg = class {
|
||||
/**
|
||||
* @param {!Element} container Containing element.
|
||||
* @alias Blockly.BlockDragSurfaceSvg
|
||||
*/
|
||||
constructor(container) {
|
||||
/**
|
||||
|
||||
@@ -43,12 +43,12 @@ goog.require('Blockly.Events.BlockMove');
|
||||
* Class for a block dragger. It moves blocks around the workspace when they
|
||||
* are being dragged by a mouse or touch.
|
||||
* @implements {IBlockDragger}
|
||||
* @alias Blockly.BlockDragger
|
||||
*/
|
||||
const BlockDragger = class {
|
||||
/**
|
||||
* @param {!BlockSvg} block The block to drag.
|
||||
* @param {!WorkspaceSvg} workspace The workspace to drag on.
|
||||
* @alias Blockly.BlockDragger
|
||||
*/
|
||||
constructor(block, workspace) {
|
||||
/**
|
||||
|
||||
@@ -88,6 +88,7 @@ goog.require('Blockly.Touch');
|
||||
* @implements {IBoundedElement}
|
||||
* @implements {ICopyable}
|
||||
* @implements {IDraggable}
|
||||
* @alias Blockly.BlockSvg
|
||||
*/
|
||||
class BlockSvg extends Block {
|
||||
/**
|
||||
@@ -96,7 +97,6 @@ class BlockSvg extends Block {
|
||||
* type-specific functions for this block.
|
||||
* @param {string=} opt_id Optional ID. Use this ID if provided, otherwise
|
||||
* create a new ID.
|
||||
* @alias Blockly.BlockSvg
|
||||
*/
|
||||
constructor(workspace, prototypeName, opt_id) {
|
||||
super(workspace, prototypeName, opt_id);
|
||||
|
||||
@@ -41,6 +41,7 @@ goog.require('Blockly.Workspace');
|
||||
/**
|
||||
* Class for UI bubble.
|
||||
* @implements {IBubble}
|
||||
* @alias Blockly.Bubble
|
||||
*/
|
||||
const Bubble = class {
|
||||
/**
|
||||
@@ -53,7 +54,6 @@ const Bubble = class {
|
||||
* @param {?number} bubbleWidth Width of bubble, or null if not resizable.
|
||||
* @param {?number} bubbleHeight Height of bubble, or null if not resizable.
|
||||
* @struct
|
||||
* @alias Blockly.Bubble
|
||||
*/
|
||||
constructor(workspace, content, shape, anchorXY, bubbleWidth, bubbleHeight) {
|
||||
this.workspace_ = workspace;
|
||||
|
||||
@@ -45,12 +45,12 @@ goog.require('Blockly.constants');
|
||||
* Class for a bubble dragger. It moves things on the bubble canvas around the
|
||||
* workspace when they are being dragged by a mouse or touch. These can be
|
||||
* block comments, mutators, warnings, or workspace comments.
|
||||
* @alias Blockly.BubbleDragger
|
||||
*/
|
||||
const BubbleDragger = class {
|
||||
/**
|
||||
* @param {!IBubble} bubble The item on the bubble canvas to drag.
|
||||
* @param {!WorkspaceSvg} workspace The workspace to drag on.
|
||||
* @alias Blockly.BubbleDragger
|
||||
*/
|
||||
constructor(bubble, workspace) {
|
||||
/**
|
||||
|
||||
@@ -44,11 +44,11 @@ goog.require('Blockly.Warning');
|
||||
/**
|
||||
* Class for a comment.
|
||||
* @extends {Icon}
|
||||
* @alias Blockly.Comment
|
||||
*/
|
||||
class Comment extends Icon {
|
||||
/**
|
||||
* @param {!BlockSvg} block The block associated with this comment.
|
||||
* @alias Blockly.Comment
|
||||
*/
|
||||
constructor(block) {
|
||||
super(block);
|
||||
|
||||
@@ -31,10 +31,11 @@ const {IPositionable} = goog.requireType('Blockly.IPositionable');
|
||||
|
||||
/**
|
||||
* Manager for all items registered with the workspace.
|
||||
* @alias Blockly.ComponentManager
|
||||
*/
|
||||
class ComponentManager {
|
||||
/**
|
||||
* @alias Blockly.ComponentManager
|
||||
* Creates a new ComponentManager instance.
|
||||
*/
|
||||
constructor() {
|
||||
/**
|
||||
@@ -219,6 +220,7 @@ ComponentManager.ComponentDatum;
|
||||
/**
|
||||
* A name with the capability of the element stored in the generic.
|
||||
* @template T
|
||||
* @alias Blockly.ComponentManager.Capability
|
||||
*/
|
||||
ComponentManager.Capability = class {
|
||||
/**
|
||||
|
||||
@@ -38,12 +38,12 @@ goog.require('Blockly.constants');
|
||||
/**
|
||||
* Class for a connection between blocks.
|
||||
* @implements {IASTNodeLocationWithBlock}
|
||||
* @alias Blockly.Connection
|
||||
*/
|
||||
class Connection {
|
||||
/**
|
||||
* @param {!Block} source The block establishing this connection.
|
||||
* @param {number} type The type of the connection.
|
||||
* @alias Blockly.Connection
|
||||
*/
|
||||
constructor(source, type) {
|
||||
/**
|
||||
|
||||
@@ -31,13 +31,9 @@ const {RenderedConnection} = goog.requireType('Blockly.RenderedConnection');
|
||||
/**
|
||||
* Class for connection type checking logic.
|
||||
* @implements {IConnectionChecker}
|
||||
* @alias Blockly.ConnectionChecker
|
||||
*/
|
||||
class ConnectionChecker {
|
||||
/**
|
||||
* @alias Blockly.ConnectionChecker
|
||||
*/
|
||||
constructor() {}
|
||||
|
||||
/**
|
||||
* Check whether the current connection can connect with the target
|
||||
* connection.
|
||||
|
||||
@@ -34,13 +34,13 @@ goog.require('Blockly.constants');
|
||||
* Database of connections.
|
||||
* Connections are stored in order of their vertical component. This way
|
||||
* connections in an area may be looked up quickly using a binary search.
|
||||
* @alias Blockly.ConnectionDB
|
||||
*/
|
||||
class ConnectionDB {
|
||||
/**
|
||||
* @param {!IConnectionChecker} checker The workspace's
|
||||
* connection type checker, used to decide if connections are valid during
|
||||
* a drag.
|
||||
* @alias Blockly.ConnectionDB
|
||||
*/
|
||||
constructor(checker) {
|
||||
/**
|
||||
|
||||
@@ -25,10 +25,11 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
* Class for the registry of context menu items. This is intended to be a
|
||||
* singleton. You should not create a new instance, and only access this class
|
||||
* from ContextMenuRegistry.registry.
|
||||
* @alias Blockly.ContextMenuRegistry
|
||||
*/
|
||||
class ContextMenuRegistry {
|
||||
/**
|
||||
* @alias Blockly.ContextMenuRegistry
|
||||
* Resets the existing singleton instance of ContextMenuRegistry.
|
||||
*/
|
||||
constructor() {
|
||||
this.reset();
|
||||
|
||||
@@ -31,10 +31,12 @@ const {IDraggable} = goog.requireType('Blockly.IDraggable');
|
||||
* dropped on top of it.
|
||||
* @extends {DragTarget}
|
||||
* @implements {IDeleteArea}
|
||||
* @alias Blockly.DeleteArea
|
||||
*/
|
||||
class DeleteArea extends DragTarget {
|
||||
/**
|
||||
* @alias Blockly.DeleteArea
|
||||
* Constructor for DeleteArea. Should not be called directly, only by a
|
||||
* subclass.
|
||||
*/
|
||||
constructor() {
|
||||
super();
|
||||
|
||||
@@ -30,13 +30,9 @@ const {Rect} = goog.requireType('Blockly.utils.Rect');
|
||||
* Abstract class for a component with custom behaviour when a block or bubble
|
||||
* is dragged over or dropped on top of it.
|
||||
* @implements {IDragTarget}
|
||||
* @alias Blockly.DragTarget
|
||||
*/
|
||||
class DragTarget {
|
||||
/**
|
||||
* @alias Blockly.DragTarget
|
||||
*/
|
||||
constructor() {}
|
||||
|
||||
/**
|
||||
* Handles when a cursor with a block or bubble enters this drag target.
|
||||
* @param {!IDraggable} _dragElement The block or bubble currently being
|
||||
|
||||
@@ -25,6 +25,7 @@ const {Workspace} = goog.requireType('Blockly.Workspace');
|
||||
/**
|
||||
* Abstract class for an event.
|
||||
* @abstract
|
||||
* @alias Blockly.Events.Abstract
|
||||
*/
|
||||
class Abstract {
|
||||
/**
|
||||
|
||||
@@ -23,12 +23,12 @@ const {Block} = goog.requireType('Blockly.Block');
|
||||
/**
|
||||
* Abstract class for a block event.
|
||||
* @extends {AbstractEvent}
|
||||
* @alias Blockly.Events.BlockBase
|
||||
*/
|
||||
class BlockBase extends AbstractEvent {
|
||||
/**
|
||||
* @param {!Block=} opt_block The block this event corresponds to.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.BlockBase
|
||||
*/
|
||||
constructor(opt_block) {
|
||||
super();
|
||||
|
||||
@@ -28,6 +28,7 @@ const {Block} = goog.requireType('Blockly.Block');
|
||||
/**
|
||||
* Class for a block change event.
|
||||
* @extends {BlockBase}
|
||||
* @alias Blockly.Events.BlockChange
|
||||
*/
|
||||
class BlockChange extends BlockBase {
|
||||
/**
|
||||
@@ -37,7 +38,6 @@ class BlockChange extends BlockBase {
|
||||
* @param {?string=} opt_name Name of input or field affected, or null.
|
||||
* @param {*=} opt_oldValue Previous value of element.
|
||||
* @param {*=} opt_newValue New value of element.
|
||||
* @alias Blockly.Events.BlockChange
|
||||
*/
|
||||
constructor(opt_block, opt_element, opt_name, opt_oldValue, opt_newValue) {
|
||||
super(opt_block);
|
||||
|
||||
@@ -27,12 +27,12 @@ const {Block} = goog.requireType('Blockly.Block');
|
||||
/**
|
||||
* Class for a block creation event.
|
||||
* @extends {BlockBase}
|
||||
* @alias Blockly.Events.BlockCreate
|
||||
*/
|
||||
class BlockCreate extends BlockBase {
|
||||
/**
|
||||
* @param {!Block=} opt_block The created block. Undefined for a blank
|
||||
* event.
|
||||
* @alias Blockly.Events.BlockCreate
|
||||
*/
|
||||
constructor(opt_block) {
|
||||
super(opt_block);
|
||||
|
||||
@@ -27,12 +27,12 @@ const {Block} = goog.requireType('Blockly.Block');
|
||||
/**
|
||||
* Class for a block deletion event.
|
||||
* @extends {BlockBase}
|
||||
* @alias Blockly.Events.BlockDelete
|
||||
*/
|
||||
class BlockDelete extends BlockBase {
|
||||
/**
|
||||
* @param {!Block=} opt_block The deleted block. Undefined for a blank
|
||||
* event.
|
||||
* @alias Blockly.Events.BlockDelete
|
||||
*/
|
||||
constructor(opt_block) {
|
||||
super(opt_block);
|
||||
|
||||
@@ -25,6 +25,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a block drag event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.BlockDrag
|
||||
*/
|
||||
class BlockDrag extends UiBase {
|
||||
/**
|
||||
@@ -34,7 +35,6 @@ class BlockDrag extends UiBase {
|
||||
* Undefined for a blank event.
|
||||
* @param {!Array<!Block>=} opt_blocks The blocks affected by this
|
||||
* drag. Undefined for a blank event.
|
||||
* @alias Blockly.Events.BlockDrag
|
||||
*/
|
||||
constructor(opt_block, opt_isStart, opt_blocks) {
|
||||
const workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
||||
|
||||
@@ -27,12 +27,12 @@ const {Coordinate} = goog.require('Blockly.utils.Coordinate');
|
||||
/**
|
||||
* Class for a block move event. Created before the move.
|
||||
* @extends {BlockBase}
|
||||
* @alias Blockly.Events.BlockMove
|
||||
*/
|
||||
class BlockMove extends BlockBase {
|
||||
/**
|
||||
* @param {!Block=} opt_block The moved block. Undefined for a blank
|
||||
* event.
|
||||
* @alias Blockly.Events.BlockMove
|
||||
*/
|
||||
constructor(opt_block) {
|
||||
super(opt_block);
|
||||
|
||||
@@ -25,6 +25,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a bubble open event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.BubbleOpen
|
||||
*/
|
||||
class BubbleOpen extends UiBase {
|
||||
/**
|
||||
@@ -35,7 +36,6 @@ class BubbleOpen extends UiBase {
|
||||
* @param {string=} opt_bubbleType The type of bubble. One of 'mutator',
|
||||
* 'comment'
|
||||
* or 'warning'. Undefined for a blank event.
|
||||
* @alias Blockly.Events.BubbleOpen
|
||||
*/
|
||||
constructor(opt_block, opt_isOpen, opt_bubbleType) {
|
||||
const workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
||||
|
||||
@@ -25,6 +25,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a click event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.Click
|
||||
*/
|
||||
class Click extends UiBase {
|
||||
/**
|
||||
@@ -35,7 +36,6 @@ class Click extends UiBase {
|
||||
* Not used if block is passed. Undefined for a blank event.
|
||||
* @param {string=} opt_targetType The type of element targeted by this click
|
||||
* event. Undefined for a blank event.
|
||||
* @alias Blockly.Events.Click
|
||||
*/
|
||||
constructor(opt_block, opt_workspaceId, opt_targetType) {
|
||||
let workspaceId = opt_block ? opt_block.workspace.id : opt_workspaceId;
|
||||
|
||||
@@ -30,12 +30,12 @@ const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
|
||||
/**
|
||||
* Abstract class for a comment event.
|
||||
* @extends {AbstractEvent}
|
||||
* @alias Blockly.Events.CommentBase
|
||||
*/
|
||||
class CommentBase extends AbstractEvent {
|
||||
/**
|
||||
* @param {!WorkspaceComment=} opt_comment The comment this event
|
||||
* corresponds to. Undefined for a blank event.
|
||||
* @alias Blockly.Events.CommentBase
|
||||
*/
|
||||
constructor(opt_comment) {
|
||||
super();
|
||||
|
||||
@@ -25,6 +25,7 @@ const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
|
||||
/**
|
||||
* Class for a comment change event.
|
||||
* @extends {CommentBase}
|
||||
* @alias Blockly.Events.CommentChange
|
||||
*/
|
||||
class CommentChange extends CommentBase {
|
||||
/**
|
||||
@@ -32,7 +33,6 @@ class CommentChange extends CommentBase {
|
||||
* changed. Undefined for a blank event.
|
||||
* @param {string=} opt_oldContents Previous contents of the comment.
|
||||
* @param {string=} opt_newContents New contents of the comment.
|
||||
* @alias Blockly.Events.CommentChange
|
||||
*/
|
||||
constructor(opt_comment, opt_oldContents, opt_newContents) {
|
||||
super(opt_comment);
|
||||
|
||||
@@ -26,12 +26,12 @@ const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
|
||||
/**
|
||||
* Class for a comment creation event.
|
||||
* @extends {CommentBase}
|
||||
* @alias Blockly.Events.CommentCreate
|
||||
*/
|
||||
class CommentCreate extends CommentBase {
|
||||
/**
|
||||
* @param {!WorkspaceComment=} opt_comment The created comment.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.CommentCreate
|
||||
*/
|
||||
constructor(opt_comment) {
|
||||
super(opt_comment);
|
||||
|
||||
@@ -25,12 +25,12 @@ const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
|
||||
/**
|
||||
* Class for a comment deletion event.
|
||||
* @extends {CommentBase}
|
||||
* @alias Blockly.Events.CommentDelete
|
||||
*/
|
||||
class CommentDelete extends CommentBase {
|
||||
/**
|
||||
* @param {!WorkspaceComment=} opt_comment The deleted comment.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.CommentDelete
|
||||
*/
|
||||
constructor(opt_comment) {
|
||||
super(opt_comment);
|
||||
|
||||
@@ -26,12 +26,12 @@ const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
|
||||
/**
|
||||
* Class for a comment move event. Created before the move.
|
||||
* @extends {CommentBase}
|
||||
* @alias Blockly.Events.CommentMove
|
||||
*/
|
||||
class CommentMove extends CommentBase {
|
||||
/**
|
||||
* @param {!WorkspaceComment=} opt_comment The comment that is being
|
||||
* moved. Undefined for a blank event.
|
||||
* @alias Blockly.Events.CommentMove
|
||||
*/
|
||||
constructor(opt_comment) {
|
||||
super(opt_comment);
|
||||
|
||||
@@ -28,6 +28,7 @@ const {Workspace} = goog.requireType('Blockly.Workspace');
|
||||
/**
|
||||
* Class for a marker move event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.MarkerMove
|
||||
*/
|
||||
class MarkerMove extends UiBase {
|
||||
/**
|
||||
@@ -39,7 +40,6 @@ class MarkerMove extends UiBase {
|
||||
* Undefined for a blank event.
|
||||
* @param {!ASTNode=} opt_newNode The new node the marker is now on.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.MarkerMove
|
||||
*/
|
||||
constructor(opt_block, isCursor, opt_oldNode, opt_newNode) {
|
||||
let workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
||||
|
||||
@@ -23,6 +23,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a selected event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.Selected
|
||||
*/
|
||||
class Selected extends UiBase {
|
||||
/**
|
||||
@@ -32,7 +33,6 @@ class Selected extends UiBase {
|
||||
* no element currently selected (deselect). Undefined for a blank event.
|
||||
* @param {string=} opt_workspaceId The workspace identifier for this event.
|
||||
* Null if no element previously selected. Undefined for a blank event.
|
||||
* @alias Blockly.Events.Selected
|
||||
*/
|
||||
constructor(opt_oldElementId, opt_newElementId, opt_workspaceId) {
|
||||
super(opt_workspaceId);
|
||||
|
||||
@@ -23,13 +23,13 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a theme change event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.ThemeChange
|
||||
*/
|
||||
class ThemeChange extends UiBase {
|
||||
/**
|
||||
* @param {string=} opt_themeName The theme name. Undefined for a blank event.
|
||||
* @param {string=} opt_workspaceId The workspace identifier for this event.
|
||||
* event. Undefined for a blank event.
|
||||
* @alias Blockly.Events.ThemeChange
|
||||
*/
|
||||
constructor(opt_themeName, opt_workspaceId) {
|
||||
super(opt_workspaceId);
|
||||
|
||||
@@ -23,6 +23,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a toolbox item select event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.ToolboxItemSelect
|
||||
*/
|
||||
class ToolboxItemSelect extends UiBase {
|
||||
/**
|
||||
@@ -32,7 +33,6 @@ class ToolboxItemSelect extends UiBase {
|
||||
* for a blank event.
|
||||
* @param {string=} opt_workspaceId The workspace identifier for this event.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.ToolboxItemSelect
|
||||
*/
|
||||
constructor(opt_oldItem, opt_newItem, opt_workspaceId) {
|
||||
super(opt_workspaceId);
|
||||
|
||||
@@ -23,6 +23,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a trashcan open event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.TrashcanOpen
|
||||
*/
|
||||
class TrashcanOpen extends UiBase {
|
||||
/**
|
||||
@@ -30,7 +31,6 @@ class TrashcanOpen extends UiBase {
|
||||
* if opening). Undefined for a blank event.
|
||||
* @param {string=} opt_workspaceId The workspace identifier for this event.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.TrashcanOpen
|
||||
*/
|
||||
constructor(opt_isOpen, opt_workspaceId) {
|
||||
super(opt_workspaceId);
|
||||
|
||||
@@ -28,6 +28,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
* Class for a UI event.
|
||||
* @extends {UiBase}
|
||||
* @deprecated December 2020. Instead use a more specific UI event.
|
||||
* @alias Blockly.Events.Ui
|
||||
*/
|
||||
class Ui extends UiBase {
|
||||
/**
|
||||
@@ -37,7 +38,6 @@ class Ui extends UiBase {
|
||||
* etc.
|
||||
* @param {*=} opt_oldValue Previous value of element.
|
||||
* @param {*=} opt_newValue New value of element.
|
||||
* @alias Blockly.Events.Ui
|
||||
*/
|
||||
constructor(opt_block, opt_element, opt_oldValue, opt_newValue) {
|
||||
const workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
||||
|
||||
@@ -27,12 +27,12 @@ const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
|
||||
* categories).
|
||||
* UI events do not undo or redo.
|
||||
* @extends {AbstractEvent}
|
||||
* @alias Blockly.Events.UiBase
|
||||
*/
|
||||
class UiBase extends AbstractEvent {
|
||||
/**
|
||||
* @param {string=} opt_workspaceId The workspace identifier for this event.
|
||||
* Undefined for a blank event.
|
||||
* @alias Blockly.Events.UiBase
|
||||
*/
|
||||
constructor(opt_workspaceId) {
|
||||
super();
|
||||
|
||||
@@ -23,12 +23,12 @@ const {VariableModel} = goog.requireType('Blockly.VariableModel');
|
||||
/**
|
||||
* Abstract class for a variable event.
|
||||
* @extends {AbstractEvent}
|
||||
* @alias Blockly.Events.VarBase
|
||||
*/
|
||||
class VarBase extends AbstractEvent {
|
||||
/**
|
||||
* @param {!VariableModel=} opt_variable The variable this event
|
||||
* corresponds to. Undefined for a blank event.
|
||||
* @alias Blockly.Events.VarBase
|
||||
*/
|
||||
constructor(opt_variable) {
|
||||
super();
|
||||
|
||||
@@ -25,12 +25,12 @@ const {VariableModel} = goog.requireType('Blockly.VariableModel');
|
||||
/**
|
||||
* Class for a variable creation event.
|
||||
* @extends {VarBase}
|
||||
* @alias Blockly.Events.VarCreate
|
||||
*/
|
||||
class VarCreate extends VarBase {
|
||||
/**
|
||||
* @param {!VariableModel=} opt_variable The created variable. Undefined
|
||||
* for a blank event.
|
||||
* @alias Blockly.Events.VarCreate
|
||||
*/
|
||||
constructor(opt_variable) {
|
||||
super(opt_variable);
|
||||
|
||||
@@ -25,12 +25,12 @@ const {VariableModel} = goog.requireType('Blockly.VariableModel');
|
||||
/**
|
||||
* Class for a variable deletion event.
|
||||
* @extends {VarBase}
|
||||
* @alias Blockly.Events.VarDelete
|
||||
*/
|
||||
class VarDelete extends VarBase {
|
||||
/**
|
||||
* @param {!VariableModel=} opt_variable The deleted variable. Undefined
|
||||
* for a blank event.
|
||||
* @alias Blockly.Events.VarDelete
|
||||
*/
|
||||
constructor(opt_variable) {
|
||||
super(opt_variable);
|
||||
|
||||
@@ -25,13 +25,13 @@ const {VariableModel} = goog.requireType('Blockly.VariableModel');
|
||||
/**
|
||||
* Class for a variable rename event.
|
||||
* @extends {VarBase}
|
||||
* @alias Blockly.Events.VarRename
|
||||
*/
|
||||
class VarRename extends VarBase {
|
||||
/**
|
||||
* @param {!VariableModel=} opt_variable The renamed variable. Undefined
|
||||
* for a blank event.
|
||||
* @param {string=} newName The new name the variable will be changed to.
|
||||
* @alias Blockly.Events.VarRename
|
||||
*/
|
||||
constructor(opt_variable, newName) {
|
||||
super(opt_variable);
|
||||
|
||||
@@ -23,6 +23,7 @@ const {UiBase} = goog.require('Blockly.Events.UiBase');
|
||||
/**
|
||||
* Class for a viewport change event.
|
||||
* @extends {UiBase}
|
||||
* @alias Blockly.Events.ViewportChange
|
||||
*/
|
||||
class ViewportChange extends UiBase {
|
||||
/**
|
||||
@@ -37,7 +38,6 @@ class ViewportChange extends UiBase {
|
||||
* Undefined for a blank event.
|
||||
* @param {number=} opt_oldScale The old scale of the workspace. Undefined for
|
||||
* a blank event.
|
||||
* @alias Blockly.Events.ViewportChange
|
||||
*/
|
||||
constructor(opt_top, opt_left, opt_scale, opt_workspaceId, opt_oldScale) {
|
||||
super(opt_workspaceId);
|
||||
|
||||
@@ -28,12 +28,12 @@ const {Workspace} = goog.requireType('Blockly.Workspace');
|
||||
* domToWorkspace).
|
||||
* Finished loading events do not record undo or redo.
|
||||
* @extends {AbstractEvent}
|
||||
* @alias Blockly.Events.FinishedLoading
|
||||
*/
|
||||
class FinishedLoading extends AbstractEvent {
|
||||
/**
|
||||
* @param {!Workspace=} opt_workspace The workspace that has finished
|
||||
* loading. Undefined for a blank event.
|
||||
* @alias Blockly.Events.FinishedLoading
|
||||
*/
|
||||
constructor(opt_workspace) {
|
||||
super();
|
||||
|
||||
@@ -70,6 +70,7 @@ goog.require('Blockly.Gesture');
|
||||
* @implements {IKeyboardAccessible}
|
||||
* @implements {IRegistrable}
|
||||
* @abstract
|
||||
* @alias Blockly.Field
|
||||
*/
|
||||
class Field {
|
||||
/**
|
||||
@@ -83,7 +84,6 @@ class Field {
|
||||
* @param {Object=} opt_config A map of options used to configure the field.
|
||||
* Refer to the individual field's documentation for a list of properties
|
||||
* this parameter supports.
|
||||
* @alias Blockly.Field
|
||||
*/
|
||||
constructor(value, opt_validator, opt_config) {
|
||||
/**
|
||||
|
||||
@@ -34,6 +34,7 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
/**
|
||||
* Class for an editable angle field.
|
||||
* @extends {FieldTextInput}
|
||||
* @alias Blockly.FieldAngle
|
||||
*/
|
||||
class FieldAngle extends FieldTextInput {
|
||||
/**
|
||||
@@ -49,7 +50,6 @@ class FieldAngle extends FieldTextInput {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/angle#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldAngle
|
||||
*/
|
||||
constructor(opt_value, opt_validator, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -27,6 +27,7 @@ goog.require('Blockly.Events.BlockChange');
|
||||
/**
|
||||
* Class for a checkbox field.
|
||||
* @extends {Field}
|
||||
* @alias Blockly.FieldCheckbox
|
||||
*/
|
||||
class FieldCheckbox extends Field {
|
||||
/**
|
||||
@@ -44,7 +45,6 @@ class FieldCheckbox extends Field {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/checkbox#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldCheckbox
|
||||
*/
|
||||
constructor(opt_value, opt_validator, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -35,6 +35,7 @@ goog.require('Blockly.Events.BlockChange');
|
||||
/**
|
||||
* Class for a colour input field.
|
||||
* @extends {Field}
|
||||
* @alias Blockly.FieldColour
|
||||
*/
|
||||
class FieldColour extends Field {
|
||||
/**
|
||||
@@ -52,7 +53,6 @@ class FieldColour extends Field {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/colour}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldColour
|
||||
*/
|
||||
constructor(opt_value, opt_validator, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -38,6 +38,7 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
/**
|
||||
* Class for an editable dropdown field.
|
||||
* @extends {Field}
|
||||
* @alias Blockly.FieldDropdown
|
||||
*/
|
||||
class FieldDropdown extends Field {
|
||||
/**
|
||||
@@ -56,7 +57,6 @@ class FieldDropdown extends Field {
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/dropdown#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @throws {TypeError} If `menuGenerator` options are incorrectly structured.
|
||||
* @alias Blockly.FieldDropdown
|
||||
*/
|
||||
constructor(menuGenerator, opt_validator, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -28,6 +28,7 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
/**
|
||||
* Class for an image on a block.
|
||||
* @extends {Field}
|
||||
* @alias Blockly.FieldImage
|
||||
*/
|
||||
class FieldImage extends Field {
|
||||
/**
|
||||
@@ -46,7 +47,6 @@ class FieldImage extends Field {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/image#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldImage
|
||||
*/
|
||||
constructor(
|
||||
src, width, height, opt_alt, opt_onClick, opt_flipRtl, opt_config) {
|
||||
|
||||
@@ -28,6 +28,7 @@ const {Sentinel} = goog.requireType('Blockly.utils.Sentinel');
|
||||
/**
|
||||
* Class for a non-editable, non-serializable text field.
|
||||
* @extends {Field}
|
||||
* @alias Blockly.FieldLabel
|
||||
*/
|
||||
class FieldLabel extends Field {
|
||||
/**
|
||||
@@ -42,7 +43,6 @@ class FieldLabel extends Field {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldLabel
|
||||
*/
|
||||
constructor(opt_value, opt_class, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -27,6 +27,7 @@ const {FieldLabel} = goog.require('Blockly.FieldLabel');
|
||||
/**
|
||||
* Class for a non-editable, serializable text field.
|
||||
* @extends {FieldLabel}
|
||||
* @alias Blockly.FieldLabelSerializable
|
||||
*/
|
||||
class FieldLabelSerializable extends FieldLabel {
|
||||
/**
|
||||
@@ -37,7 +38,6 @@ class FieldLabelSerializable extends FieldLabel {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label-serializable#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldLabelSerializable
|
||||
*/
|
||||
constructor(opt_value, opt_class, opt_config) {
|
||||
super(String(opt_value ?? ''), opt_class, opt_config);
|
||||
|
||||
@@ -33,6 +33,7 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
/**
|
||||
* Class for an editable text area field.
|
||||
* @extends {FieldTextInput}
|
||||
* @alias Blockly.FieldMultilineInput
|
||||
*/
|
||||
class FieldMultilineInput extends FieldTextInput {
|
||||
/**
|
||||
@@ -50,7 +51,6 @@ class FieldMultilineInput extends FieldTextInput {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/multiline-text-input#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldMultilineInput
|
||||
*/
|
||||
constructor(opt_value, opt_validator, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -26,6 +26,7 @@ const {Sentinel} = goog.requireType('Blockly.utils.Sentinel');
|
||||
/**
|
||||
* Class for an editable number field.
|
||||
* @extends {FieldTextInput}
|
||||
* @alias Blockly.FieldNumber
|
||||
*/
|
||||
class FieldNumber extends FieldTextInput {
|
||||
/**
|
||||
@@ -47,7 +48,6 @@ class FieldNumber extends FieldTextInput {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/number#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldNumber
|
||||
*/
|
||||
constructor(
|
||||
opt_value, opt_min, opt_max, opt_precision, opt_validator, opt_config) {
|
||||
|
||||
@@ -41,6 +41,7 @@ goog.require('Blockly.Events.BlockChange');
|
||||
|
||||
/**
|
||||
* Class for an editable text field.
|
||||
* @alias Blockly.FieldTextInput
|
||||
*/
|
||||
class FieldTextInput extends Field {
|
||||
/**
|
||||
@@ -57,7 +58,6 @@ class FieldTextInput extends Field {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/text-input#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldTextInput
|
||||
*/
|
||||
constructor(opt_value, opt_validator, opt_config) {
|
||||
super(Field.SKIP_SETUP);
|
||||
|
||||
@@ -40,6 +40,7 @@ goog.require('Blockly.Events.BlockChange');
|
||||
/**
|
||||
* Class for a variable's dropdown field.
|
||||
* @extends {FieldDropdown}
|
||||
* @alias Blockly.FieldVariable
|
||||
*/
|
||||
class FieldVariable extends FieldDropdown {
|
||||
/**
|
||||
@@ -61,7 +62,6 @@ class FieldVariable extends FieldDropdown {
|
||||
* See the [field creation documentation]{@link
|
||||
* https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/variable#creation}
|
||||
* for a list of properties this parameter supports.
|
||||
* @alias Blockly.FieldVariable
|
||||
*/
|
||||
constructor(
|
||||
varName, opt_validator, opt_variableTypes, opt_defaultType, opt_config) {
|
||||
|
||||
@@ -61,12 +61,12 @@ goog.require('Blockly.blockRendering');
|
||||
* @abstract
|
||||
* @implements {IFlyout}
|
||||
* @extends {DeleteArea}
|
||||
* @alias Blockly.Flyout
|
||||
*/
|
||||
class Flyout extends DeleteArea {
|
||||
/**
|
||||
* @param {!Options} workspaceOptions Dictionary of options for the
|
||||
* workspace.
|
||||
* @alias Blockly.Flyout
|
||||
*/
|
||||
constructor(workspaceOptions) {
|
||||
super();
|
||||
|
||||
@@ -30,6 +30,7 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
|
||||
/**
|
||||
* Class for a button or label in the flyout.
|
||||
* @alias Blockly.FlyoutButton
|
||||
*/
|
||||
class FlyoutButton {
|
||||
/**
|
||||
@@ -40,7 +41,6 @@ class FlyoutButton {
|
||||
* The JSON specifying the label/button.
|
||||
* @param {boolean} isLabel Whether this button should be styled as a label.
|
||||
* @package
|
||||
* @alias Blockly.FlyoutButton
|
||||
*/
|
||||
constructor(workspace, targetWorkspace, json, isLabel) {
|
||||
/**
|
||||
|
||||
@@ -32,12 +32,12 @@ const {Scrollbar} = goog.require('Blockly.Scrollbar');
|
||||
/**
|
||||
* Class for a flyout.
|
||||
* @extends {Flyout}
|
||||
* @alias Blockly.HorizontalFlyout
|
||||
*/
|
||||
class HorizontalFlyout extends Flyout {
|
||||
/**
|
||||
* @param {!Options} workspaceOptions Dictionary of options for the
|
||||
* workspace.
|
||||
* @alias Blockly.HorizontalFlyout
|
||||
*/
|
||||
constructor(workspaceOptions) {
|
||||
super(workspaceOptions);
|
||||
|
||||
@@ -26,12 +26,12 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
* Calculates metrics for a flyout's workspace.
|
||||
* The metrics are mainly used to size scrollbars for the flyout.
|
||||
* @extends {MetricsManager}
|
||||
* @alias Blockly.FlyoutMetricsManager
|
||||
*/
|
||||
class FlyoutMetricsManager extends MetricsManager {
|
||||
/**
|
||||
* @param {!WorkspaceSvg} workspace The flyout's workspace.
|
||||
* @param {!IFlyout} flyout The flyout.
|
||||
* @alias Blockly.FlyoutMetricsManager
|
||||
*/
|
||||
constructor(workspace, flyout) {
|
||||
super(workspace);
|
||||
|
||||
@@ -36,12 +36,12 @@ goog.require('Blockly.constants');
|
||||
/**
|
||||
* Class for a flyout.
|
||||
* @extends {Flyout}
|
||||
* @alias Blockly.VerticalFlyout
|
||||
*/
|
||||
class VerticalFlyout extends Flyout {
|
||||
/**
|
||||
* @param {!Options} workspaceOptions Dictionary of options for the
|
||||
* workspace.
|
||||
* @alias Blockly.VerticalFlyout
|
||||
*/
|
||||
constructor(workspaceOptions) {
|
||||
super(workspaceOptions);
|
||||
|
||||
@@ -30,11 +30,11 @@ const {Workspace} = goog.requireType('Blockly.Workspace');
|
||||
/**
|
||||
* Class for a code generator that translates the blocks into a language.
|
||||
* @unrestricted
|
||||
* @alias Blockly.Generator
|
||||
*/
|
||||
class Generator {
|
||||
/**
|
||||
* @param {string} name Language name of this generator.
|
||||
* @alias Blockly.Generator
|
||||
*/
|
||||
constructor(name) {
|
||||
this.name_ = name;
|
||||
|
||||
@@ -56,13 +56,13 @@ goog.require('Blockly.Events.Click');
|
||||
|
||||
/**
|
||||
* Class for one gesture.
|
||||
* @alias Blockly.Gesture
|
||||
*/
|
||||
class Gesture {
|
||||
/**
|
||||
* @param {!Event} e The event that kicked off this gesture.
|
||||
* @param {!WorkspaceSvg} creatorWorkspace The workspace that created
|
||||
* this gesture and has a reference to it.
|
||||
* @alias Blockly.Gesture
|
||||
*/
|
||||
constructor(e, creatorWorkspace) {
|
||||
/**
|
||||
|
||||
@@ -24,6 +24,7 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
|
||||
/**
|
||||
* Class for a workspace's grid.
|
||||
* @alias Blockly.Grid
|
||||
*/
|
||||
class Grid {
|
||||
/**
|
||||
@@ -32,7 +33,6 @@ class Grid {
|
||||
* @param {!Object} options A dictionary of normalized options for the grid.
|
||||
* See grid documentation:
|
||||
* https://developers.google.com/blockly/guides/configure/web/grid
|
||||
* @alias Blockly.Grid
|
||||
*/
|
||||
constructor(pattern, options) {
|
||||
/**
|
||||
|
||||
@@ -30,11 +30,11 @@ const {Svg} = goog.require('Blockly.utils.Svg');
|
||||
/**
|
||||
* Class for an icon.
|
||||
* @abstract
|
||||
* @alias Blockly.Icon
|
||||
*/
|
||||
class Icon {
|
||||
/**
|
||||
* @param {BlockSvg} block The block associated with this icon.
|
||||
* @alias Blockly.Icon
|
||||
*/
|
||||
constructor(block) {
|
||||
/**
|
||||
|
||||
@@ -45,6 +45,7 @@ exports.Align = Align;
|
||||
|
||||
/**
|
||||
* Class for an input with an optional field.
|
||||
* @alias Blockly.Input
|
||||
*/
|
||||
class Input {
|
||||
/**
|
||||
@@ -53,7 +54,6 @@ class Input {
|
||||
* this input again.
|
||||
* @param {!Block} block The block containing this input.
|
||||
* @param {Connection} connection Optional connection for this input.
|
||||
* @alias Blockly.Input
|
||||
*/
|
||||
constructor(type, name, block, connection) {
|
||||
if (type !== inputTypes.DUMMY && !name) {
|
||||
|
||||
@@ -52,11 +52,11 @@ const DUPLICATE_BLOCK_ERROR = 'The insertion marker ' +
|
||||
* Class that controls updates to connections during drags. It is primarily
|
||||
* responsible for finding the closest eligible connection and highlighting or
|
||||
* unhighlighting it as needed during a drag.
|
||||
* @alias Blockly.InsertionMarkerManager
|
||||
*/
|
||||
class InsertionMarkerManager {
|
||||
/**
|
||||
* @param {!BlockSvg} block The top block in the stack being dragged.
|
||||
* @alias Blockly.InsertionMarkerManager
|
||||
*/
|
||||
constructor(block) {
|
||||
common.setSelected(block);
|
||||
|
||||
@@ -39,6 +39,7 @@ const {Workspace} = goog.requireType('Blockly.Workspace');
|
||||
* Class for an AST node.
|
||||
* It is recommended that you use one of the createNode methods instead of
|
||||
* creating a node directly.
|
||||
* @alias Blockly.ASTNode
|
||||
*/
|
||||
class ASTNode {
|
||||
/**
|
||||
|
||||
@@ -27,6 +27,7 @@ const {Cursor} = goog.require('Blockly.Cursor');
|
||||
* This will allow the user to get to all nodes in the AST by hitting next or
|
||||
* previous.
|
||||
* @extends {Cursor}
|
||||
* @alias Blockly.BasicCursor
|
||||
*/
|
||||
class BasicCursor extends Cursor {
|
||||
/**
|
||||
|
||||
@@ -25,6 +25,7 @@ const {Marker} = goog.require('Blockly.Marker');
|
||||
* Class for a cursor.
|
||||
* A cursor controls how a user navigates the Blockly AST.
|
||||
* @extends {Marker}
|
||||
* @alias Blockly.Cursor
|
||||
*/
|
||||
class Cursor extends Marker {
|
||||
/**
|
||||
|
||||
@@ -26,10 +26,11 @@ const {MarkerSvg} = goog.requireType('Blockly.blockRendering.MarkerSvg');
|
||||
/**
|
||||
* Class for a marker.
|
||||
* This is used in keyboard navigation to save a location in the Blockly AST.
|
||||
* @alias Blockly.Marker
|
||||
*/
|
||||
class Marker {
|
||||
/**
|
||||
* @alias Blockly.Marker
|
||||
* Constructs a new Marker instance.
|
||||
*/
|
||||
constructor() {
|
||||
/**
|
||||
|
||||
@@ -26,15 +26,9 @@ const {Field} = goog.requireType('Blockly.Field');
|
||||
/**
|
||||
* A cursor for navigating between tab navigable fields.
|
||||
* @extends {BasicCursor}
|
||||
* @alias Blockly.TabNavigateCursor
|
||||
*/
|
||||
class TabNavigateCursor extends BasicCursor {
|
||||
/**
|
||||
* @alias Blockly.TabNavigateCursor
|
||||
*/
|
||||
constructor() {
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Skip all nodes except for tab navigable fields.
|
||||
* @param {?ASTNode} node The AST node to check whether it is valid.
|
||||
|
||||
@@ -25,11 +25,11 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
|
||||
/**
|
||||
* Class to manage the multiple markers and the cursor on a workspace.
|
||||
* @alias Blockly.MarkerManager
|
||||
*/
|
||||
class MarkerManager {
|
||||
/**
|
||||
* @param {!WorkspaceSvg} workspace The workspace for the marker manager.
|
||||
* @alias Blockly.MarkerManager
|
||||
* @package
|
||||
*/
|
||||
constructor(workspace) {
|
||||
|
||||
@@ -29,10 +29,11 @@ const {Size} = goog.requireType('Blockly.utils.Size');
|
||||
|
||||
/**
|
||||
* A basic menu class.
|
||||
* @alias Blockly.Menu
|
||||
*/
|
||||
const Menu = class {
|
||||
/**
|
||||
* @alias Blockly.Menu
|
||||
* Constructs a new Menu instance.
|
||||
*/
|
||||
constructor() {
|
||||
/**
|
||||
|
||||
@@ -22,13 +22,13 @@ const idGenerator = goog.require('Blockly.utils.idGenerator');
|
||||
|
||||
/**
|
||||
* Class representing an item in a menu.
|
||||
* @alias Blockly.MenuItem
|
||||
*/
|
||||
const MenuItem = class {
|
||||
/**
|
||||
* @param {string|!HTMLElement} content Text caption to display as the content
|
||||
* of the item, or a HTML element to display.
|
||||
* @param {string=} opt_value Data/model associated with the menu item.
|
||||
* @alias Blockly.MenuItem
|
||||
*/
|
||||
constructor(content, opt_value) {
|
||||
/**
|
||||
|
||||
@@ -33,12 +33,12 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
/**
|
||||
* The manager for all workspace metrics calculations.
|
||||
* @implements {IMetricsManager}
|
||||
* @alias Blockly.MetricsManager
|
||||
*/
|
||||
class MetricsManager {
|
||||
/**
|
||||
* @param {!WorkspaceSvg} workspace The workspace to calculate metrics
|
||||
* for.
|
||||
* @alias Blockly.MetricsManager
|
||||
*/
|
||||
constructor(workspace) {
|
||||
/**
|
||||
|
||||
@@ -47,11 +47,11 @@ goog.require('Blockly.Events.BubbleOpen');
|
||||
/**
|
||||
* Class for a mutator dialog.
|
||||
* @extends {Icon}
|
||||
* @alias Blockly.Mutator
|
||||
*/
|
||||
class Mutator extends Icon {
|
||||
/**
|
||||
* @param {!Array<string>} quarkNames List of names of sub-blocks for flyout.
|
||||
* @alias Blockly.Mutator
|
||||
*/
|
||||
constructor(quarkNames) {
|
||||
super(null);
|
||||
|
||||
@@ -27,6 +27,7 @@ goog.requireType('Blockly.Procedures');
|
||||
|
||||
/**
|
||||
* Class for a database of entity names (variables, procedures, etc).
|
||||
* @alias Blockly.Names
|
||||
*/
|
||||
const Names = class {
|
||||
/**
|
||||
@@ -34,7 +35,6 @@ const Names = class {
|
||||
* illegal for use as names in a language (e.g. 'new,if,this,...').
|
||||
* @param {string=} opt_variablePrefix Some languages need a '$' or a
|
||||
* namespace before all variable names (but not procedure names).
|
||||
* @alias Blockly.Names
|
||||
*/
|
||||
constructor(reservedWords, opt_variablePrefix) {
|
||||
/**
|
||||
|
||||
@@ -31,13 +31,13 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
/**
|
||||
* Parse the user-specified options, using reasonable defaults where behaviour
|
||||
* is unspecified.
|
||||
* @alias Blockly.Options
|
||||
*/
|
||||
class Options {
|
||||
/**
|
||||
* @param {!BlocklyOptions} options Dictionary of options.
|
||||
* Specification:
|
||||
* https://developers.google.com/blockly/guides/get-started/web#configuration
|
||||
* @alias Blockly.Options
|
||||
*/
|
||||
constructor(options) {
|
||||
let toolboxJsonDef = null;
|
||||
|
||||
@@ -74,11 +74,11 @@ exports.DEFAULT = DEFAULT;
|
||||
/**
|
||||
* A name with the type of the element stored in the generic.
|
||||
* @template T
|
||||
* @alias Blockly.registry.Type
|
||||
*/
|
||||
class Type {
|
||||
/**
|
||||
* @param {string} name The name of the registry type.
|
||||
* @alias Blockly.registry.Type
|
||||
*/
|
||||
constructor(name) {
|
||||
/**
|
||||
|
||||
@@ -43,12 +43,12 @@ const BUMP_RANDOMNESS = 10;
|
||||
/**
|
||||
* Class for a connection between blocks that may be rendered on screen.
|
||||
* @extends {Connection}
|
||||
* @alias Blockly.RenderedConnection
|
||||
*/
|
||||
class RenderedConnection extends Connection {
|
||||
/**
|
||||
* @param {!BlockSvg} source The block establishing this connection.
|
||||
* @param {number} type The type of the connection.
|
||||
* @alias Blockly.RenderedConnection
|
||||
*/
|
||||
constructor(source, type) {
|
||||
super(source, type);
|
||||
|
||||
@@ -31,11 +31,11 @@ const {Theme} = goog.requireType('Blockly.Theme');
|
||||
|
||||
/**
|
||||
* An object that provides constants for rendering blocks.
|
||||
* @alias Blockly.blockRendering.ConstantProvider
|
||||
*/
|
||||
class ConstantProvider {
|
||||
/**
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.ConstantProvider
|
||||
*/
|
||||
constructor() {
|
||||
/**
|
||||
|
||||
@@ -43,13 +43,13 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
|
||||
/**
|
||||
* An object that renders rectangles and dots for debugging rendering code.
|
||||
* @alias Blockly.blockRendering.Debug
|
||||
*/
|
||||
class Debug {
|
||||
/**
|
||||
* @param {!ConstantProvider} constants The renderer's
|
||||
* constants.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Debug
|
||||
*/
|
||||
constructor(constants) {
|
||||
/**
|
||||
|
||||
@@ -39,6 +39,7 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
|
||||
/**
|
||||
* An object that draws a block based on the given rendering information.
|
||||
* @alias Blockly.blockRendering.Drawer
|
||||
*/
|
||||
class Drawer {
|
||||
/**
|
||||
@@ -46,7 +47,6 @@ class Drawer {
|
||||
* @param {!RenderInfo} info An object containing all
|
||||
* information needed to render this block.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Drawer
|
||||
*/
|
||||
constructor(block, info) {
|
||||
this.block_ = block;
|
||||
|
||||
@@ -57,13 +57,13 @@ const {inputTypes} = goog.require('Blockly.inputTypes');
|
||||
* This measure pass does not propagate changes to the block (although fields
|
||||
* may choose to rerender when getSize() is called). However, calling it
|
||||
* repeatedly may be expensive.
|
||||
* @alias Blockly.blockRendering.RenderInfo
|
||||
*/
|
||||
class RenderInfo {
|
||||
/**
|
||||
* @param {!Renderer} renderer The renderer in use.
|
||||
* @param {!BlockSvg} block The block to measure.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.RenderInfo
|
||||
*/
|
||||
constructor(renderer, block) {
|
||||
this.block_ = block;
|
||||
|
||||
@@ -63,6 +63,7 @@ const HEIGHT_MULTIPLIER = 3 / 4;
|
||||
|
||||
/**
|
||||
* Class for a marker.
|
||||
* @alias Blockly.blockRendering.MarkerSvg
|
||||
*/
|
||||
class MarkerSvg {
|
||||
/**
|
||||
@@ -70,7 +71,6 @@ class MarkerSvg {
|
||||
* @param {!ConstantProvider} constants The constants for
|
||||
* the renderer.
|
||||
* @param {!Marker} marker The marker to draw.
|
||||
* @alias Blockly.blockRendering.MarkerSvg
|
||||
*/
|
||||
constructor(workspace, constants, marker) {
|
||||
/**
|
||||
|
||||
@@ -34,6 +34,7 @@ const {Theme} = goog.requireType('Blockly.Theme');
|
||||
* An object that handles creating and setting each of the SVG elements
|
||||
* used by the renderer.
|
||||
* @implements {IPathObject}
|
||||
* @alias Blockly.blockRendering.PathObject
|
||||
*/
|
||||
class PathObject {
|
||||
/**
|
||||
@@ -43,7 +44,6 @@ class PathObject {
|
||||
* @param {!ConstantProvider} constants The renderer's
|
||||
* constants.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.PathObject
|
||||
*/
|
||||
constructor(root, style, constants) {
|
||||
/**
|
||||
|
||||
@@ -48,12 +48,12 @@ const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
|
||||
/**
|
||||
* The base class for a block renderer.
|
||||
* @implements {IRegistrable}
|
||||
* @alias Blockly.blockRendering.Renderer
|
||||
*/
|
||||
class Renderer {
|
||||
/**
|
||||
* @param {string} name The renderer name.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Renderer
|
||||
*/
|
||||
constructor(name) {
|
||||
/**
|
||||
|
||||
@@ -23,11 +23,11 @@ const {ConstantProvider: BaseConstantProvider} = goog.require('Blockly.blockRend
|
||||
/**
|
||||
* An object that provides constants for rendering blocks in Geras mode.
|
||||
* @extends {BaseConstantProvider}
|
||||
* @alias Blockly.geras.ConstantProvider
|
||||
*/
|
||||
class ConstantProvider extends BaseConstantProvider {
|
||||
/**
|
||||
* @package
|
||||
* @alias Blockly.geras.ConstantProvider
|
||||
*/
|
||||
constructor() {
|
||||
super();
|
||||
|
||||
@@ -34,6 +34,7 @@ const {RenderInfo} = goog.requireType('Blockly.geras.RenderInfo');
|
||||
/**
|
||||
* An object that draws a block based on the given rendering information.
|
||||
* @extends {BaseDrawer}
|
||||
* @alias Blockly.geras.Drawer
|
||||
*/
|
||||
class Drawer extends BaseDrawer {
|
||||
/**
|
||||
@@ -41,7 +42,6 @@ class Drawer extends BaseDrawer {
|
||||
* @param {!RenderInfo} info An object containing all
|
||||
* information needed to render this block.
|
||||
* @package
|
||||
* @alias Blockly.geras.Drawer
|
||||
*/
|
||||
constructor(block, info) {
|
||||
super(block, info);
|
||||
|
||||
@@ -25,13 +25,13 @@ const {ConstantProvider} = goog.requireType('Blockly.blockRendering.ConstantProv
|
||||
* Some highlights are simple offsets of the parent paths and can be generated
|
||||
* programmatically. Others, especially on curves, are just made out of piles
|
||||
* of constants and are hard to tweak.
|
||||
* @alias Blockly.geras.HighlightConstantProvider
|
||||
*/
|
||||
class HighlightConstantProvider {
|
||||
/**
|
||||
* @param {!ConstantProvider} constants The rendering
|
||||
* constants provider.
|
||||
* @package
|
||||
* @alias Blockly.geras.HighlightConstantProvider
|
||||
*/
|
||||
constructor(constants) {
|
||||
/**
|
||||
|
||||
@@ -48,13 +48,13 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* position of each part of the block. The resulting paths are not continuous
|
||||
* or closed paths. The highlights for tabs and notches are loosely based on
|
||||
* tab and notch shapes, but are not exactly the same.
|
||||
* @alias Blockly.geras.Highlighter
|
||||
*/
|
||||
class Highlighter {
|
||||
/**
|
||||
* @param {!RenderInfo} info An object containing all
|
||||
* information needed to render this block.
|
||||
* @package
|
||||
* @alias Blockly.geras.Highlighter
|
||||
*/
|
||||
constructor(info) {
|
||||
this.info_ = info;
|
||||
|
||||
@@ -47,13 +47,13 @@ const {inputTypes} = goog.require('Blockly.inputTypes');
|
||||
* may choose to rerender when getSize() is called). However, calling it
|
||||
* repeatedly may be expensive.
|
||||
* @extends {BaseRenderInfo}
|
||||
* @alias Blockly.geras.RenderInfo
|
||||
*/
|
||||
class RenderInfo extends BaseRenderInfo {
|
||||
/**
|
||||
* @param {!Renderer} renderer The renderer in use.
|
||||
* @param {!BlockSvg} block The block to measure.
|
||||
* @package
|
||||
* @alias Blockly.geras.RenderInfo
|
||||
*/
|
||||
constructor(renderer, block) {
|
||||
super(renderer, block);
|
||||
|
||||
@@ -30,6 +30,7 @@ const {Input} = goog.requireType('Blockly.Input');
|
||||
* An object containing information about the space an inline input takes up
|
||||
* during rendering.
|
||||
* @extends {BaseInlineInput}
|
||||
* @alias Blockly.geras.InlineInput
|
||||
*/
|
||||
class InlineInput extends BaseInlineInput {
|
||||
/**
|
||||
@@ -38,7 +39,6 @@ class InlineInput extends BaseInlineInput {
|
||||
* @param {!Input} input The inline input to measure and store
|
||||
* information for.
|
||||
* @package
|
||||
* @alias Blockly.geras.InlineInput
|
||||
*/
|
||||
constructor(constants, input) {
|
||||
super(constants, input);
|
||||
|
||||
@@ -30,6 +30,7 @@ const {StatementInput: BaseStatementInput} = goog.require('Blockly.blockRenderin
|
||||
* An object containing information about the space a statement input takes up
|
||||
* during rendering.
|
||||
* @extends {BaseStatementInput}
|
||||
* @alias Blockly.geras.StatementInput
|
||||
*/
|
||||
class StatementInput extends BaseStatementInput {
|
||||
/**
|
||||
@@ -38,7 +39,6 @@ class StatementInput extends BaseStatementInput {
|
||||
* @param {!Input} input The statement input to measure and store
|
||||
* information for.
|
||||
* @package
|
||||
* @alias Blockly.geras.StatementInput
|
||||
*/
|
||||
constructor(constants, input) {
|
||||
super(constants, input);
|
||||
|
||||
@@ -29,6 +29,7 @@ const {Theme} = goog.requireType('Blockly.Theme');
|
||||
/**
|
||||
* An object that handles creating and setting each of the SVG elements
|
||||
* used by the renderer.
|
||||
* @alias Blockly.geras.PathObject
|
||||
*/
|
||||
class PathObject extends BasePathObject {
|
||||
/**
|
||||
@@ -36,7 +37,6 @@ class PathObject extends BasePathObject {
|
||||
* @param {!Theme.BlockStyle} style The style object to use for
|
||||
* colouring.
|
||||
* @param {!ConstantProvider} constants The renderer's constants.
|
||||
* @alias Blockly.geras.PathObject
|
||||
* @package
|
||||
*/
|
||||
constructor(root, style, constants) {
|
||||
|
||||
@@ -35,12 +35,12 @@ const {Theme} = goog.requireType('Blockly.Theme');
|
||||
/**
|
||||
* The geras renderer.
|
||||
* @extends {BaseRenderer}
|
||||
* @alias Blockly.geras.Renderer
|
||||
*/
|
||||
class Renderer extends BaseRenderer {
|
||||
/**
|
||||
* @param {string} name The renderer name.
|
||||
* @package
|
||||
* @alias Blockly.geras.Renderer
|
||||
*/
|
||||
constructor(name) {
|
||||
super(name);
|
||||
|
||||
@@ -25,13 +25,13 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* The base class to represent a part of a block that takes up space during
|
||||
* rendering. The constructor for each non-spacer Measurable records the size
|
||||
* of the block element (e.g. field, statement input).
|
||||
* @alias Blockly.blockRendering.Measurable
|
||||
*/
|
||||
class Measurable {
|
||||
/**
|
||||
* @param {!ConstantProvider} constants The rendering
|
||||
* constants provider.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Measurable
|
||||
*/
|
||||
constructor(constants) {
|
||||
/** @type {number} */
|
||||
|
||||
@@ -33,13 +33,13 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* connections.
|
||||
* @extends {Row}
|
||||
* @struct
|
||||
* @alias Blockly.blockRendering.BottomRow
|
||||
*/
|
||||
class BottomRow extends Row {
|
||||
/**
|
||||
* @param {!ConstantProvider} constants The rendering
|
||||
* constants provider.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.BottomRow
|
||||
*/
|
||||
constructor(constants) {
|
||||
super(constants);
|
||||
|
||||
@@ -28,6 +28,7 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* The base class to represent a connection and the space that it takes up on
|
||||
* the block.
|
||||
* @extends {Measurable}
|
||||
* @alias Blockly.blockRendering.Connection
|
||||
*/
|
||||
class Connection extends Measurable {
|
||||
/**
|
||||
@@ -36,7 +37,6 @@ class Connection extends Measurable {
|
||||
* @param {!RenderedConnection} connectionModel The connection object on
|
||||
* the block that this represents.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Connection
|
||||
*/
|
||||
constructor(constants, connectionModel) {
|
||||
super(constants);
|
||||
|
||||
@@ -29,6 +29,7 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* takes up during rendering
|
||||
* @struct
|
||||
* @extends {InputConnection}
|
||||
* @alias Blockly.blockRendering.ExternalValueInput
|
||||
*/
|
||||
class ExternalValueInput extends InputConnection {
|
||||
/**
|
||||
@@ -37,7 +38,6 @@ class ExternalValueInput extends InputConnection {
|
||||
* @param {!Input} input The external value input to measure and store
|
||||
* information for.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.ExternalValueInput
|
||||
*/
|
||||
constructor(constants, input) {
|
||||
super(constants, input);
|
||||
|
||||
@@ -31,6 +31,7 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* rendering
|
||||
* @struct
|
||||
* @extends {Measurable}
|
||||
* @alias Blockly.blockRendering.Field
|
||||
*/
|
||||
class Field extends Measurable {
|
||||
/**
|
||||
@@ -40,7 +41,6 @@ class Field extends Measurable {
|
||||
* for.
|
||||
* @param {!Input} parentInput The parent input for the field.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Field
|
||||
*/
|
||||
constructor(constants, field, parentInput) {
|
||||
super(constants);
|
||||
|
||||
@@ -27,13 +27,13 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
|
||||
* rendering.
|
||||
* @struct
|
||||
* @extends {Measurable}
|
||||
* @alias Blockly.blockRendering.Hat
|
||||
*/
|
||||
class Hat extends Measurable {
|
||||
/**
|
||||
* @param {!ConstantProvider} constants The rendering
|
||||
* constants provider.
|
||||
* @package
|
||||
* @alias Blockly.blockRendering.Hat
|
||||
*/
|
||||
constructor(constants) {
|
||||
super(constants);
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user