Blockly.Events. Change
Constructor
Change
new Change(opt_block, opt_element, opt_name, opt_oldValue, opt_newValue)
Class for a block change event.
Parameter |
|
---|---|
opt_block |
Optional The changed block. Undefined for a blank event. Value must not be null. |
opt_element |
Optional string One of 'field', 'comment', 'disabled', etc. |
opt_name |
Optional string Name of input or field affected, or null. Value may be null. |
opt_oldValue |
Optional any type Previous value of element. |
opt_newValue |
Optional any type New value of element. |
- Extends
- Blockly.Events.BlockBase
Properties
blockId
unknown
The block id for the block this event pertains to
- Inherited from
- Blockly.Events.BlockBase#blockId
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.
workspaceId
unknown
The workspace identifier for this event.
- Inherited from
- Blockly.Events.BlockBase#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?
- Returns
-
boolean
False if something changed.
run
run(forward)
Run a change 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.