mirror of
https://github.com/google/blockly.git
synced 2026-01-04 15:40:08 +01:00
88ff901a72
* chore: add and configure prettier * chore: remove clang-format * chore: remove clang-format config * chore: lint additional ts files * chore: fix lint errors in blocks * chore: add prettier-ignore where needed * chore: ignore js blocks when formatting * chore: fix playground html syntax * chore: fix yaml spacing from merge * chore: convert text blocks to use arrow functions * chore: format everything with prettier * chore: fix lint unused imports in blocks
124 lines
3.0 KiB
TypeScript
124 lines
3.0 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Class for comment creation event.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.CommentCreate');
|
|
|
|
import * as deprecation from '../utils/deprecation.js';
|
|
import * as registry from '../registry.js';
|
|
import type {WorkspaceComment} from '../workspace_comment.js';
|
|
import * as utilsXml from '../utils/xml.js';
|
|
import * as Xml from '../xml.js';
|
|
|
|
import {CommentBase, CommentBaseJson} from './events_comment_base.js';
|
|
import * as eventUtils from './utils.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
|
|
/**
|
|
* Notifies listeners that a workspace comment was created.
|
|
*/
|
|
export class CommentCreate extends CommentBase {
|
|
override type = eventUtils.COMMENT_CREATE;
|
|
|
|
/** The XML representation of the created workspace comment. */
|
|
xml?: Element | DocumentFragment;
|
|
|
|
/**
|
|
* @param opt_comment The created 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();
|
|
}
|
|
|
|
// TODO (#1266): "Full" and "minimal" serialization.
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): CommentCreateJson {
|
|
const json = super.toJson() as CommentCreateJson;
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
*
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: CommentCreateJson) {
|
|
deprecation.warn(
|
|
'Blockly.Events.CommentCreate.prototype.fromJson',
|
|
'version 9',
|
|
'version 10',
|
|
'Blockly.Events.fromJson'
|
|
);
|
|
super.fromJson(json);
|
|
this.xml = utilsXml.textToDom(json['xml']);
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @param event The event to append new properties to. Should be a subclass
|
|
* of CommentCreate, 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: CommentCreateJson,
|
|
workspace: Workspace,
|
|
event?: any
|
|
): CommentCreate {
|
|
const newEvent = super.fromJson(
|
|
json,
|
|
workspace,
|
|
event ?? new CommentCreate()
|
|
) as CommentCreate;
|
|
newEvent.xml = utilsXml.textToDom(json['xml']);
|
|
return newEvent;
|
|
}
|
|
|
|
/**
|
|
* Run a creation event.
|
|
*
|
|
* @param forward True if run forward, false if run backward (undo).
|
|
*/
|
|
override run(forward: boolean) {
|
|
CommentBase.CommentCreateDeleteHelper(this, forward);
|
|
}
|
|
}
|
|
|
|
export interface CommentCreateJson extends CommentBaseJson {
|
|
xml: string;
|
|
}
|
|
|
|
registry.register(
|
|
registry.Type.EVENT,
|
|
eventUtils.COMMENT_CREATE,
|
|
CommentCreate
|
|
);
|