Class: CommentChange

Defined in: packages/blockly/core/events/events_comment_change.ts:24

Notifies listeners that the contents of a workspace comment has changed.

Extends

• CommentBase

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.
oldContents_	The previous contents of the comment.
newContents_	The new contents of the comment.

Methods index

Method	Description
getEventWorkspace_	Get workspace the event belongs to.
CommentCreateDeleteHelper	Helper function for Comment[Create
toJson	Encode the event as JSON.
isNull	Does this event record any change of state?
run	Run a change event.

Constructors

Constructor

new CommentChange(
   opt_comment?, 
   opt_oldContents?, 
   opt_newContents?
): CommentChange;

Defined in: packages/blockly/core/events/events_comment_change.ts:40

Parameters

Parameter	Type	Description
opt_comment?	WorkspaceComment	The comment that is being changed. Undefined for a blank event.
opt_oldContents?	string	Previous contents of the comment.
opt_newContents?	string	New contents of the comment.

Returns

CommentChange

Overrides

CommentBase.constructor

Properties

workspaceId?

optional workspaceId?: string = undefined;

Defined in: packages/blockly/core/events/events_abstract.ts:30

The workspace identifier for this event.

Inherited from

CommentBase.workspaceId

---

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

CommentBase.group

---

recordUndo

recordUndo: boolean;

Defined in: packages/blockly/core/events/events_abstract.ts:41

Whether this event is undoable or not.

Inherited from

CommentBase.recordUndo

---

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

CommentBase.isUiEvent

---

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

CommentBase.isBlank

---

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

CommentBase.commentId

---

type

type: EventType = EventType.COMMENT_CHANGE;

Defined in: packages/blockly/core/events/events_comment_change.ts:25

Type of this event.

Overrides

CommentBase.type

---

oldContents_?

optional oldContents_?: string;

Defined in: packages/blockly/core/events/events_comment_change.ts:29

The previous contents of the comment.

---

newContents_?

optional newContents_?: string;

Defined in: packages/blockly/core/events/events_comment_change.ts:32

The new contents of the comment.

Methods

getEventWorkspace_()

getEventWorkspace_(): Workspace;

Defined in: packages/blockly/core/events/events_abstract.ts:111

Get workspace the event belongs to.

Returns

Workspace

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(): CommentChangeJson;

Defined in: packages/blockly/core/events/events_comment_change.ts:62

Encode the event as JSON.

Returns

CommentChangeJson

JSON representation.

Overrides

CommentBase.toJson

---

isNull()

isNull(): boolean;

Defined in: packages/blockly/core/events/events_comment_change.ts:110

Does this event record any change of state?

Returns

boolean

False if something changed.

Overrides

CommentBase.isNull

---

run()

run(forward): void;

Defined in: packages/blockly/core/events/events_comment_change.ts:119

Run a change event.

Parameters

Parameter	Type	Description
forward	boolean	True if run forward, false if run backward (undo).

Returns

void

Overrides

CommentBase.run