mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +01:00
7ccdcc5cef
* refactor(events): Use "export ... from" where applicable
* refactor(events): Introduce EventType enum
Introduce an enum for the event .type values. We can't actually
use it as the type of the .type property on Abstract events,
because we want to allow developers to add their own custom
event types inheriting from this type, but at least this way we
can be reasonably sure that all of our own event subclasses have
distinct .type values—plus consistent use of enum syntax
(EventType.TYPE_NAME) is probably good for readability overall.
Put it in a separate module from the rest of events/utils.ts
because it would be helpful if event utils could use
event instanceof SomeEventType
for type narrowing but but at the moment most events are in
modules that depend on events/utils.ts for their .type
constant, and although circular ESM dependencies should work
in principle there are various restrictions and this
particular circularity causes issues at the moment.
A few of the event classes also depend on utils.ts for fire()
or other functions, which will be harder to deal with, but at
least this commit is win in terms of reducing the complexity
of our dependencies, making most of the Abstract event subclass
module dependent on type.ts, which has no imports, rather than
on utils.ts which has multiple imports.
114 lines
3.0 KiB
TypeScript
114 lines
3.0 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Class for comment deletion event.
|
|
*
|
|
* @class
|
|
*/
|
|
// Former goog.module ID: Blockly.Events.CommentDelete
|
|
|
|
import type {WorkspaceComment} from '../comments/workspace_comment.js';
|
|
import * as registry from '../registry.js';
|
|
import * as comments from '../serialization/workspace_comments.js';
|
|
import * as utilsXml from '../utils/xml.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
import * as Xml from '../xml.js';
|
|
import {CommentBase, CommentBaseJson} from './events_comment_base.js';
|
|
import {EventType} from './type.js';
|
|
|
|
/**
|
|
* Notifies listeners that a workspace comment has been deleted.
|
|
*/
|
|
export class CommentDelete extends CommentBase {
|
|
override type = EventType.COMMENT_DELETE;
|
|
|
|
/** The XML representation of the deleted workspace comment. */
|
|
xml?: Element;
|
|
|
|
/** The JSON representation of the created workspace comment. */
|
|
json?: comments.State;
|
|
|
|
/**
|
|
* @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 = Xml.saveWorkspaceComment(opt_comment);
|
|
this.json = comments.save(opt_comment, {addCoordinates: true});
|
|
}
|
|
|
|
/**
|
|
* 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',
|
|
);
|
|
}
|
|
if (!this.json) {
|
|
throw new Error(
|
|
'The comment JSON is undefined. Either pass a block to ' +
|
|
'the constructor, or call fromJson',
|
|
);
|
|
}
|
|
json['xml'] = Xml.domToText(this.xml);
|
|
json['json'] = this.json;
|
|
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 = utilsXml.textToDom(json['xml']);
|
|
newEvent.json = json['json'];
|
|
return newEvent;
|
|
}
|
|
}
|
|
|
|
export interface CommentDeleteJson extends CommentBaseJson {
|
|
xml: string;
|
|
json: object;
|
|
}
|
|
|
|
registry.register(registry.Type.EVENT, EventType.COMMENT_DELETE, CommentDelete);
|