mirror of
https://github.com/google/blockly.git
synced 2026-01-08 01:20:12 +01:00
f64c934f04
* feat: add new path for deserialization of events * chore: add tests for round-tripping events * chore: add static fromJson methods to all events * chore: add inline docs to new static methods * chore: add deprecation warnings * chore: cleanup * chore: add deprecation and docs to abstract * chore: format * chore: cleanup from rebase * chore: update docs comment
97 lines
2.4 KiB
TypeScript
97 lines
2.4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Class for comment deletion event.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.CommentDelete');
|
|
|
|
import * as registry from '../registry.js';
|
|
import type {WorkspaceComment} from '../workspace_comment.js';
|
|
|
|
import {CommentBase, CommentBaseJson} from './events_comment_base.js';
|
|
import * as eventUtils from './utils.js';
|
|
import * as Xml from '../xml.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
|
|
|
|
/**
|
|
* Class for a comment deletion event.
|
|
*
|
|
* @alias Blockly.Events.CommentDelete
|
|
*/
|
|
export class CommentDelete extends CommentBase {
|
|
override type = eventUtils.COMMENT_DELETE;
|
|
xml?: Element;
|
|
|
|
/**
|
|
* @param opt_comment The deleted comment.
|
|
* Undefined for a blank event.
|
|
*/
|
|
constructor(opt_comment?: WorkspaceComment) {
|
|
super(opt_comment);
|
|
|
|
if (!opt_comment) {
|
|
return; // Blank event to be populated by fromJson.
|
|
}
|
|
|
|
this.xml = opt_comment.toXmlWithXY();
|
|
}
|
|
|
|
/**
|
|
* Run a creation event.
|
|
*
|
|
* @param forward True if run forward, false if run backward (undo).
|
|
*/
|
|
override run(forward: boolean) {
|
|
CommentBase.CommentCreateDeleteHelper(this, !forward);
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): CommentDeleteJson {
|
|
const json = super.toJson() as CommentDeleteJson;
|
|
if (!this.xml) {
|
|
throw new Error(
|
|
'The comment XML is undefined. Either pass a comment to ' +
|
|
'the constructor, or call fromJson');
|
|
}
|
|
json['xml'] = Xml.domToText(this.xml);
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @param event The event to append new properties to. Should be a subclass
|
|
* of CommentDelete, but we can't specify that due to the fact that
|
|
* parameters to static methods in subclasses must be supertypes of
|
|
* parameters to static methods in superclasses.
|
|
* @internal
|
|
*/
|
|
static fromJson(json: CommentDeleteJson, workspace: Workspace, event?: any):
|
|
CommentDelete {
|
|
const newEvent =
|
|
super.fromJson(json, workspace, event ?? new CommentDelete()) as
|
|
CommentDelete;
|
|
newEvent.xml = Xml.textToDom(json['xml']);
|
|
return newEvent;
|
|
}
|
|
}
|
|
|
|
export interface CommentDeleteJson extends CommentBaseJson {
|
|
xml: string;
|
|
}
|
|
|
|
registry.register(
|
|
registry.Type.EVENT, eventUtils.COMMENT_DELETE, CommentDelete);
|