Class: BlockDrag

Constructor

BlockDrag

new BlockDrag(opt_block, opt_isStart, opt_blocks)

Class for a block drag event.

Parameter

opt_block

Optional

Blockly.Block

The top block in the stack that is being dragged. Undefined for a blank event.

Value must not be null.

opt_isStart

Optional

boolean

Whether this is the start of a block drag. Undefined for a blank event.

opt_blocks

Optional

Array of non-null Blockly.Block

The blocks affected by this drag. Undefined for a blank event.

Value must not be null.

Extends
Blockly.Events.UiBase

Properties

blocks

(non-null Array of non-null Blockly.Block or undefined)

The blocks affected by this drag event.

group

unknown

The event group id for the group this event belongs to. Groups define events that should be treated as an single action from the user's perspective, and should be undone together.

Inherited from
Blockly.Events.Abstract#group

isBlank

unknown

Whether or not the event is blank (to be populated by fromJson).

Inherited from
Blockly.Events.UiBase#isBlank

isStart

(boolean or undefined)

Whether this is the start of a block drag.

isUiEvent

unknown

Whether or not the event is a UI event.

Inherited from
Blockly.Events.UiBase#isUiEvent

recordUndo

unknown

Sets whether the event should be added to the undo stack.

Inherited from
Blockly.Events.Abstract#recordUndo

type

string

Type of this event.

workspaceId

unknown

The workspace identifier for this event.

Inherited from
Blockly.Events.UiBase#workspaceId

Methods

fromJson

fromJson(json)

Decode the JSON event.

Parameter

json

Object

JSON representation.

Value must not be null.

getEventWorkspace_

protected

getEventWorkspace_() returns Blockly.Workspace

Get workspace the event belongs to.

Inherited from
Blockly.Events.Abstract#getEventWorkspace_
Throws

if workspace is null.

Returns

The workspace the event belongs to.

isNull

isNull() returns boolean

Does this event record any change of state?

Inherited from
Blockly.Events.Abstract#isNull
Returns

True if null, false if something changed.

run

run(_forward)

Run an event.

Parameter

_forward

True if run forward, false if run backward (undo).

Inherited from
Blockly.Events.Abstract#run

toJson

toJson() returns Object

Encode the event as JSON.

Returns

non-null Object JSON representation.