Class: VarBase

Constructor

VarBase

new VarBase(opt_variable)

Abstract class for a variable event.

Parameter
opt_variable	Optional Blockly.VariableModel The variable this event corresponds to. Undefined for a blank event. Value must not be null.

Parameter

opt_variable

Optional

Blockly.VariableModel

The variable this event corresponds to. Undefined for a blank event.

Value must not be null.

Extends: Blockly.Events.Abstract

Properties

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.Abstract#isBlank

isUiEvent

unknown

Whether or not the event is a ui event.

Inherited from: Blockly.Events.Abstract#isUiEvent

recordUndo

unknown

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

Inherited from: Blockly.Events.Abstract#recordUndo

varId

string

The variable id for the variable this event pertains to.

workspaceId

string

The workspace identifier for this event.

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.