Class: BlockDelete
Defined in: packages/blockly/core/events/events_block_delete.ts:27
Notifies listeners when a block (or connected stack of blocks) is deleted.
Extends
Properties index
| Property | Description |
|---|---|
| workspaceId | The workspace identifier for this event. |
| group | An ID for the group of events this block is associated with. |
| recordUndo | Whether this event is undoable or not. |
| isUiEvent | Whether or not the event is a UI event. |
| isBlank | Whether or not the event was constructed without necessary parameters (to be populated by fromJson). |
| blockId | The ID of the block associated with this event. |
| oldJson | The JSON respresentation of the deleted block(s). |
| ids | All of the IDs of deleted blocks. |
| wasShadow | True if the deleted block was a shadow block, false otherwise. |
| type | Type of this event. |
Methods index
| Method | Description |
|---|---|
| isNull | Does this event record any change of state? |
| getEventWorkspace_ | Get workspace the event belongs to. |
| toJson | Encode the event as JSON. |
| run | Run a deletion event. |
Constructors
Constructor
new BlockDelete(opt_block?): BlockDelete;
Defined in: packages/blockly/core/events/events_block_delete.ts:40
Parameters
| Parameter | Type | Description |
|---|---|---|
opt_block? | Block | The deleted block. Undefined for a blank event. |
Returns
BlockDelete
Overrides
Properties
workspaceId?
optional workspaceId?: string = undefined;
Defined in: packages/blockly/core/events/events_abstract.ts:30
The workspace identifier for this event.
Inherited from
group
group: string;
Defined in: packages/blockly/core/events/events_abstract.ts:38
An ID for the group of events this block is associated with.
Groups define events that should be treated as an single action from the user's perspective, and should be undone together.
Inherited from
recordUndo
recordUndo: boolean;
Defined in: packages/blockly/core/events/events_abstract.ts:41
Whether this event is undoable or not.
Inherited from
isUiEvent
isUiEvent: boolean = false;
Defined in: packages/blockly/core/events/events_abstract.ts:44
Whether or not the event is a UI event.
Inherited from
isBlank
isBlank: boolean = true;
Defined in: packages/blockly/core/events/events_block_base.ts:23
Whether or not the event was constructed without necessary parameters (to be populated by fromJson).
Inherited from
blockId?
optional blockId?: string;
Defined in: packages/blockly/core/events/events_block_base.ts:26
The ID of the block associated with this event.
Inherited from
oldJson?
optional oldJson?: State;
Defined in: packages/blockly/core/events/events_block_delete.ts:29
The JSON respresentation of the deleted block(s).
ids?
optional ids?: string[];
Defined in: packages/blockly/core/events/events_block_delete.ts:32
All of the IDs of deleted blocks.
wasShadow?
optional wasShadow?: boolean;
Defined in: packages/blockly/core/events/events_block_delete.ts:35
True if the deleted block was a shadow block, false otherwise.
type
type: EventType = EventType.BLOCK_DELETE;
Defined in: packages/blockly/core/events/events_block_delete.ts:37
Type of this event.
Overrides
Methods
isNull()
isNull(): boolean;
Defined in: packages/blockly/core/events/events_abstract.ts:91
Does this event record any change of state?
Returns
boolean
True if null, false if something changed.
Inherited from
getEventWorkspace_()
getEventWorkspace_(): Workspace;
Defined in: packages/blockly/core/events/events_abstract.ts:111
Get workspace the event belongs to.
Returns
The workspace the event belongs to.
Throws
if workspace is null.
Inherited from
toJson()
toJson(): BlockDeleteJson;
Defined in: packages/blockly/core/events/events_block_delete.ts:67
Encode the event as JSON.
Returns
JSON representation.
Overrides
run()
run(forward): void;
Defined in: packages/blockly/core/events/events_block_delete.ts:129
Run a deletion event.
Parameters
| Parameter | Type | Description |
|---|---|---|
forward | boolean | True if run forward, false if run backward (undo). |
Returns
void