Blockly.Events. VarRename
Class for a variable rename event.
Constructor
VarRename
new VarRename(opt_variable, newName)
Parameter |
|
---|---|
opt_variable |
Optional The renamed variable. Undefined for a blank event. Value must not be null. |
newName |
Optional 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
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
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.VarBase#workspaceId
Methods
fromJson
fromJson(json)
Decode the JSON event.
Parameter |
|
---|---|
json |
Object JSON representation. Value must not be null. |
getEventWorkspace_
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.