Constructor

VarRename

new VarRename(variable, newName)

Class for a variable rename event.

Parameter

variable

Blockly.VariableModel

The renamed variable. Null for a blank event.

newName

string

The new name the variable will be changed to.

Extends
Blockly.Events.VarBase

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

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.

varId

unknown

The variable id for the variable this event pertains to.

Inherited from
Blockly.Events.VarBase#varId

workspaceId

unknown

The workspace identifier for this event.

Inherited from
Blockly.Events.Abstract#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 a variable rename event.

Parameter

forward

boolean

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

toJson

toJson() returns Object

Encode the event as JSON.

Returns

non-null Object JSON representation.