Class: CommentCollapse
Defined in: packages/blockly/core/events/events_comment_collapse.ts:14
Abstract class for a comment event.
Extends
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. |
| 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. |
| type | Type of this event. |
| newCollapsed | - |
Methods index
| Method | Description |
|---|---|
| isNull | Does this event record any change of state? |
| getEventWorkspace_ | Get workspace the event belongs to. |
| CommentCreateDeleteHelper | Helper function for Comment[Create |
| toJson | Encode the event as JSON. |
| run | Run a collapse event. |
Constructors
Constructor
new CommentCollapse(comment?, newCollapsed?): CommentCollapse;
Defined in: packages/blockly/core/events/events_comment_collapse.ts:17
Parameters
| Parameter | Type |
|---|---|
comment? | WorkspaceComment |
newCollapsed? | boolean |
Returns
CommentCollapse
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
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).
Inherited from
commentId?
optional commentId?: string;
Defined in: packages/blockly/core/events/events_comment_base.ts:30
The ID of the comment that this event references.
Inherited from
type
type: EventType = EventType.COMMENT_COLLAPSE;
Defined in: packages/blockly/core/events/events_comment_collapse.ts:15
Type of this event.
Overrides
newCollapsed?
optional newCollapsed?: boolean;
Defined in: packages/blockly/core/events/events_comment_collapse.ts:19
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
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
CommentBase.getEventWorkspace_
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
Inherited from
CommentBase.CommentCreateDeleteHelper
toJson()
toJson(): CommentCollapseJson;
Defined in: packages/blockly/core/events/events_comment_collapse.ts:33
Encode the event as JSON.
Returns
JSON representation.
Overrides
run()
run(forward): void;
Defined in: packages/blockly/core/events/events_comment_collapse.ts:73
Run a collapse event.
Parameters
| Parameter | Type | Description |
|---|---|---|
forward | boolean | True if run forward, false if run backward (undo). |
Returns
void