mirror of
https://github.com/google/blockly.git
synced 2026-05-12 15:10:11 +02:00
Beka Westberg
107 lines
2.8 KiB
TypeScript
107 lines
2.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Base class for comment events.
|
|
*/
|
|
|
|
/**
|
|
* Base class for comment events.
|
|
* @class
|
|
*/
|
|
|
|
|
|
import * as utilsXml from '../utils/xml';
|
|
import type {WorkspaceComment} from '../workspace_comment';
|
|
import * as Xml from '../xml';
|
|
|
|
import {Abstract as AbstractEvent} from './events_abstract';
|
|
import type {CommentCreate} from './events_comment_create';
|
|
import type {CommentDelete} from './events_comment_delete';
|
|
import * as eventUtils from './utils';
|
|
|
|
|
|
/**
|
|
* Abstract class for a comment event.
|
|
* @alias Blockly.Events.CommentBase
|
|
*/
|
|
export class CommentBase extends AbstractEvent {
|
|
override isBlank: boolean;
|
|
commentId: string;
|
|
override workspaceId: string;
|
|
|
|
/**
|
|
* @param opt_comment The comment this event corresponds to. Undefined for a
|
|
* blank event.
|
|
*/
|
|
constructor(opt_comment?: WorkspaceComment) {
|
|
super();
|
|
/** Whether or not an event is blank. */
|
|
this.isBlank = typeof opt_comment === 'undefined';
|
|
|
|
/** The ID of the comment this event pertains to. */
|
|
this.commentId = this.isBlank ? '' : opt_comment!.id;
|
|
|
|
/** The workspace identifier for this event. */
|
|
this.workspaceId = this.isBlank ? '' : opt_comment!.workspace.id;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
this.group = eventUtils.getGroup();
|
|
|
|
/** Sets whether the event should be added to the undo stack. */
|
|
this.recordUndo = eventUtils.getRecordUndo();
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
* @return JSON representation.
|
|
*/
|
|
override toJson(): AnyDuringMigration {
|
|
const json = super.toJson();
|
|
if (this.commentId) {
|
|
json['commentId'] = this.commentId;
|
|
}
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: AnyDuringMigration) {
|
|
super.fromJson(json);
|
|
this.commentId = json['commentId'];
|
|
}
|
|
|
|
/**
|
|
* Helper function for Comment[Create|Delete]
|
|
* @param event The event to run.
|
|
* @param create if True then Create, if False then Delete
|
|
*/
|
|
static CommentCreateDeleteHelper(
|
|
event: CommentCreate|CommentDelete, create: boolean) {
|
|
const workspace = event.getEventWorkspace_();
|
|
if (create) {
|
|
const xmlElement = utilsXml.createElement('xml');
|
|
xmlElement.appendChild(event.xml);
|
|
Xml.domToWorkspace(xmlElement, workspace);
|
|
} else {
|
|
const comment = workspace.getCommentById(event.commentId);
|
|
if (comment) {
|
|
comment.dispose();
|
|
} else {
|
|
// Only complain about root-level block.
|
|
console.warn(
|
|
'Can\'t uncreate non-existent comment: ' + event.commentId);
|
|
}
|
|
}
|
|
}
|
|
}
|