mirror of
https://github.com/google/blockly.git
synced 2026-01-07 17:10:11 +01:00
b0a7c004a9
* fix(build): Restore erroneously-deleted filter function This was deleted in PR #7406 as it was mainly being used to filter core/ vs. test/mocha/ deps into separate deps files - but it turns out also to be used for filtering error messages too. Oops. * refactor(tests): Migrate advanced compilation test to ES Modules * refactor(build): Migrate main.js to TypeScript This turns out to be pretty straight forward, even if it would cause crashing if one actually tried to import this module instead of just feeding it to Closure Compiler. * chore(build): Remove goog.declareModuleId calls Replace goog.declareModuleId calls with a comment recording the former module ID for posterity (or at least until we decide how to reformat the renamings file. * chore(tests): Delete closure/goog/* For the moment we still need something to serve as base.js for the benefit of closure-make-deps, so we keep a vestigial base.js around, containing only the @provideGoog declaration. * refactor(build): Remove vestigial base.js By changing slightly the command line arguments to closure-make-deps and closure-calculate-chunks the need to have any base.js is eliminated. * chore: Typo fix for PR #7415
106 lines
2.6 KiB
TypeScript
106 lines
2.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Class for comment creation event.
|
|
*
|
|
* @class
|
|
*/
|
|
// Former goog.module ID: Blockly.Events.CommentCreate
|
|
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* 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,
|
|
);
|