mirror of
https://github.com/google/blockly.git
synced 2026-05-12 23:20:10 +02:00
Beka Westberg
f85304f0ae
* chore: automatically change imports to import types * chore: revert changes that actually need to be imports * chore: format * chore: add more import type statements based on importsNotUsedAsValues * chore: fix tsconfig * chore: add link to compiler issue
109 lines
2.8 KiB
TypeScript
109 lines
2.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Class for comment change event.
|
|
*/
|
|
|
|
/**
|
|
* Class for comment change event.
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.CommentChange');
|
|
|
|
import * as registry from '../registry.js';
|
|
import type {WorkspaceComment} from '../workspace_comment.js';
|
|
|
|
import {CommentBase} from './events_comment_base.js';
|
|
import * as eventUtils from './utils.js';
|
|
|
|
|
|
/**
|
|
* Class for a comment change event.
|
|
* @alias Blockly.Events.CommentChange
|
|
*/
|
|
export class CommentChange extends CommentBase {
|
|
override type: string;
|
|
|
|
// TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
|
|
oldContents_!: string;
|
|
// TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
|
|
newContents_!: string;
|
|
|
|
/**
|
|
* @param opt_comment The comment that is being changed. Undefined for a
|
|
* blank event.
|
|
* @param opt_oldContents Previous contents of the comment.
|
|
* @param opt_newContents New contents of the comment.
|
|
*/
|
|
constructor(
|
|
opt_comment?: WorkspaceComment, opt_oldContents?: string,
|
|
opt_newContents?: string) {
|
|
super(opt_comment);
|
|
|
|
/** Type of this event. */
|
|
this.type = eventUtils.COMMENT_CHANGE;
|
|
|
|
if (!opt_comment) {
|
|
return; // Blank event to be populated by fromJson.
|
|
}
|
|
|
|
this.oldContents_ =
|
|
typeof opt_oldContents === 'undefined' ? '' : opt_oldContents;
|
|
this.newContents_ =
|
|
typeof opt_newContents === 'undefined' ? '' : opt_newContents;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
* @return JSON representation.
|
|
*/
|
|
override toJson(): AnyDuringMigration {
|
|
const json = super.toJson();
|
|
json['oldContents'] = this.oldContents_;
|
|
json['newContents'] = this.newContents_;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: AnyDuringMigration) {
|
|
super.fromJson(json);
|
|
this.oldContents_ = json['oldContents'];
|
|
this.newContents_ = json['newContents'];
|
|
}
|
|
|
|
/**
|
|
* Does this event record any change of state?
|
|
* @return False if something changed.
|
|
*/
|
|
override isNull(): boolean {
|
|
return this.oldContents_ === this.newContents_;
|
|
}
|
|
|
|
/**
|
|
* Run a change event.
|
|
* @param forward True if run forward, false if run backward (undo).
|
|
*/
|
|
override run(forward: boolean) {
|
|
const workspace = this.getEventWorkspace_();
|
|
const comment = workspace.getCommentById(this.commentId);
|
|
if (!comment) {
|
|
console.warn('Can\'t change non-existent comment: ' + this.commentId);
|
|
return;
|
|
}
|
|
const contents = forward ? this.newContents_ : this.oldContents_;
|
|
|
|
comment.setContent(contents);
|
|
}
|
|
}
|
|
|
|
registry.register(
|
|
registry.Type.EVENT, eventUtils.COMMENT_CHANGE, CommentChange);
|