Blockly.Events. CommentDelete
Class for a comment deletion event.
Constructor
CommentDelete
new CommentDelete(opt_comment)
Parameter |
|
|---|---|
|
opt_comment |
Optional The deleted comment. Undefined for a blank event. Value must not be null. |
- Extends
- Blockly.Events.CommentBase
Properties
commentId
unknown
The ID of the comment this event pertains to.
- Inherited from
- Blockly.Events.CommentBase#commentId
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.CommentBase#group
isBlank
unknown
Whether or not an event is blank.
- Inherited from
- Blockly.Events.CommentBase#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.CommentBase#recordUndo
type
string
Type of this event.
workspaceId
unknown
The workspace identifier for this event.
- Inherited from
- Blockly.Events.CommentBase#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 creation 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 ObjectJSON representation.