Events

Classes

Class	Description
Abstract	Abstract class for an event.
BlockBase	Abstract class for any event related to blocks.
BlockChange	Notifies listeners when some element of a block has changed (e.g. field values, comments, etc).
BlockCreate	Notifies listeners when a block (or connected stack of blocks) is created.
BlockDelete	Notifies listeners when a block (or connected stack of blocks) is deleted.
BlockDrag	Notifies listeners when a block is being manually dragged/dropped.
BlockFieldIntermediateChange	Notifies listeners when the value of a block's field has changed but the change is not yet complete, and is expected to be followed by a block change event.
BlockMove	Notifies listeners when a block is moved. This could be from one connection to another, or from one location on the workspace to another.
BubbleOpen	Class for a bubble open event.
Click	Notifies listeners that some blockly element was clicked.
CommentBase	Abstract class for a comment event.
CommentChange	Notifies listeners that the contents of a workspace comment has changed.
CommentCollapse	Abstract class for a comment event.
CommentCreate	Notifies listeners that a workspace comment was created.
CommentDelete	Notifies listeners that a workspace comment has been deleted.
CommentDrag	Notifies listeners when a comment is being manually dragged/dropped.
CommentMove	Notifies listeners that a workspace comment has moved.
CommentResize	Notifies listeners that a workspace comment has resized.
Selected	Class for a selected event. Notifies listeners that a new element has been selected.
ThemeChange	Notifies listeners that the workspace theme has changed.
ToolboxItemSelect	Notifies listeners that a toolbox item has been selected.
TrashcanOpen	Notifies listeners when the trashcan is opening or closing.
UiBase	Base class for a UI event. UI events are events that don't need to be sent over the wire for multi-user editing to work (e.g. scrolling the workspace, zooming, opening toolbox categories). UI events do not undo or redo.
VarBase	Abstract class for a variable event.
VarCreate	Notifies listeners that a variable model has been created.
VarDelete	Notifies listeners that a variable model has been deleted.
VarRename	Notifies listeners that a variable model was renamed.
VarTypeChange	Notifies listeners that a variable's type has changed.
ViewportChange	Notifies listeners that the workspace surface's position or scale has changed.
FinishedLoading	Notifies listeners when the workspace has finished deserializing from JSON/XML.

Enumerations

Enumeration	Description
BubbleType	-
ClickTarget	-

Functions

Function	Description
setRecordUndo	Sets whether events should be added to the undo stack.
getRecordUndo	Returns whether or not events will be added to the undo stack.
fire	Enqueue an event to be dispatched to change listeners.
filter	Filter the queued events by merging duplicates, removing null events and reording BlockChange events.
clearPendingUndo	Modify pending undo events so that when they are fired they don't land in the undo stack. Called by Workspace.clearUndo.
disable	Stop sending events. Every call to this function MUST also call enable.
enable	Start sending events. Unless events were already disabled when the corresponding call to disable was made.
isEnabled	Returns whether events may be fired or not.
getGroup	Current group.
setGroup	Start or stop a group.
fromJson	Decode the JSON into an event.
get	Gets the class for a specific event type from the registry.
disableOrphans	Set if a block is disabled depending on whether it is properly connected. Use this on applications where all blocks should be connected to a top block.

Interfaces

Interface	Description
AbstractEventJson	-
BlockBaseJson	-
BlockChangeJson	-
BlockCreateJson	-
BlockDeleteJson	-
BlockDragJson	-
BlockFieldIntermediateChangeJson	-
BlockMoveJson	-
BubbleOpenJson	-
ClickJson	-
CommentBaseJson	-
CommentChangeJson	-
CommentCollapseJson	-
CommentCreateJson	-
CommentDragJson	-
CommentMoveJson	-
CommentResizeJson	-
SelectedJson	-
ThemeChangeJson	-
ToolboxItemSelectJson	-
TrashcanOpenJson	-
VarBaseJson	-
VarCreateJson	-
VarDeleteJson	-
VarRenameJson	-
VarTypeChangeJson	-
ViewportChangeJson	-

Variables

Variable	Description
BLOCK_CHANGE	-
BLOCK_CREATE	-
BLOCK_DELETE	-
BLOCK_DRAG	-
BLOCK_MOVE	-
BLOCK_FIELD_INTERMEDIATE_CHANGE	-
BUBBLE_OPEN	-
CHANGE	-
CLICK	-
COMMENT_CHANGE	-
COMMENT_CREATE	-
COMMENT_DELETE	-
COMMENT_MOVE	-
COMMENT_RESIZE	-
COMMENT_DRAG	-
CREATE	-
DELETE	-
FINISHED_LOADING	-
MOVE	-
SELECTED	-
THEME_CHANGE	-
TOOLBOX_ITEM_SELECT	-
TRASHCAN_OPEN	-
UI	-
VAR_CREATE	-
VAR_DELETE	-
VAR_RENAME	-
VIEWPORT_CHANGE	-
BUMP_EVENTS	List of events that cause objects to be bumped back into the visible portion of the workspace.

Type Aliases

Type Alias	Description
BumpEvent	Type of events that cause objects to be bumped back into the visible portion of the workspace.