Class: CommentBase
Defined in: packages/blockly/core/events/events_comment_base.ts:26
Abstract class for a comment event.
Extends
Extended by
Properties index
| Property | Description |
|---|---|
| workspaceId | The workspace identifier for this event. |
| group | An ID for the group of events this block is associated with. |
| recordUndo | Whether this event is undoable or not. |
| isUiEvent | Whether or not the event is a UI event. |
| type | Type of this event. |
| isBlank | Whether or not the event was constructed without necessary parameters (to be populated by fromJson). |
| commentId | The ID of the comment that this event references. |
Methods index
| Method | Description |
|---|---|
| isNull | Does this event record any change of state? |
| run | Run an event. |
| getEventWorkspace_ | Get workspace the event belongs to. |
| toJson | Encode the event as JSON. |
| CommentCreateDeleteHelper | Helper function for Comment[Create |
Constructors
Constructor
new CommentBase(opt_comment?): CommentBase;
Defined in: packages/blockly/core/events/events_comment_base.ts:36
Parameters
| Parameter | Type | Description |
|---|---|---|
opt_comment? | WorkspaceComment | The comment this event corresponds to. Undefined for a blank event. |
Returns
CommentBase
Overrides
Properties
workspaceId?
optional workspaceId?: string = undefined;
Defined in: packages/blockly/core/events/events_abstract.ts:30
The workspace identifier for this event.
Inherited from
group
group: string;
Defined in: packages/blockly/core/events/events_abstract.ts:38
An ID for the group of events this block is associated with.
Groups define events that should be treated as an single action from the user's perspective, and should be undone together.
Inherited from
recordUndo
recordUndo: boolean;
Defined in: packages/blockly/core/events/events_abstract.ts:41
Whether this event is undoable or not.
Inherited from
isUiEvent
isUiEvent: boolean = false;
Defined in: packages/blockly/core/events/events_abstract.ts:44
Whether or not the event is a UI event.
Inherited from
type
type: string = '';
Defined in: packages/blockly/core/events/events_abstract.ts:47
Type of this event.
Inherited from
isBlank
isBlank: boolean = true;
Defined in: packages/blockly/core/events/events_comment_base.ts:27
Whether or not the event was constructed without necessary parameters (to be populated by fromJson).
Overrides
commentId?
optional commentId?: string;
Defined in: packages/blockly/core/events/events_comment_base.ts:30
The ID of the comment that this event references.
Methods
isNull()
isNull(): boolean;
Defined in: packages/blockly/core/events/events_abstract.ts:91
Does this event record any change of state?
Returns
boolean
True if null, false if something changed.
Inherited from
run()
run(_forward): void;
Defined in: packages/blockly/core/events/events_abstract.ts:100
Run an event.
Parameters
| Parameter | Type | Description |
|---|---|---|
_forward | boolean | True if run forward, false if run backward (undo). |
Returns
void
Inherited from
getEventWorkspace_()
getEventWorkspace_(): Workspace;
Defined in: packages/blockly/core/events/events_abstract.ts:111
Get workspace the event belongs to.
Returns
The workspace the event belongs to.
Throws
if workspace is null.
Inherited from
toJson()
toJson(): CommentBaseJson;
Defined in: packages/blockly/core/events/events_comment_base.ts:54
Encode the event as JSON.
Returns
JSON representation.
Overrides
CommentCreateDeleteHelper()
static CommentCreateDeleteHelper(event, create): void;
Defined in: packages/blockly/core/events/events_comment_base.ts:95
Helper function for Comment[Create|Delete]
Parameters
| Parameter | Type | Description |
|---|---|---|
event | CommentCreate | CommentDelete | The event to run. |
create | boolean | if True then Create, if False then Delete |
Returns
void