mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
90 lines
2.1 KiB
TypeScript
90 lines
2.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Classes for all types of variable events.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.VarDelete');
|
|
|
|
import * as registry from '../registry.js';
|
|
import type {VariableModel} from '../variable_model.js';
|
|
|
|
import {VarBase} from './events_var_base.js';
|
|
import * as eventUtils from './utils.js';
|
|
|
|
|
|
/**
|
|
* Class for a variable deletion event.
|
|
*
|
|
* @alias Blockly.Events.VarDelete
|
|
*/
|
|
export class VarDelete extends VarBase {
|
|
override type: string;
|
|
|
|
// TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
|
|
varType!: string;
|
|
// TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
|
|
varName!: string;
|
|
|
|
/**
|
|
* @param opt_variable The deleted variable. Undefined for a blank event.
|
|
*/
|
|
constructor(opt_variable?: VariableModel) {
|
|
super(opt_variable);
|
|
|
|
/** Type of this event. */
|
|
this.type = eventUtils.VAR_DELETE;
|
|
|
|
if (!opt_variable) {
|
|
return; // Blank event to be populated by fromJson.
|
|
}
|
|
this.varType = opt_variable.type;
|
|
this.varName = opt_variable.name;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): AnyDuringMigration {
|
|
const json = super.toJson();
|
|
json['varType'] = this.varType;
|
|
json['varName'] = this.varName;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
*
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: AnyDuringMigration) {
|
|
super.fromJson(json);
|
|
this.varType = json['varType'];
|
|
this.varName = json['varName'];
|
|
}
|
|
|
|
/**
|
|
* Run a variable deletion event.
|
|
*
|
|
* @param forward True if run forward, false if run backward (undo).
|
|
*/
|
|
override run(forward: boolean) {
|
|
const workspace = this.getEventWorkspace_();
|
|
if (forward) {
|
|
workspace.deleteVariableById(this.varId);
|
|
} else {
|
|
workspace.createVariable(this.varName, this.varType, this.varId);
|
|
}
|
|
}
|
|
}
|
|
|
|
registry.register(registry.Type.EVENT, eventUtils.VAR_DELETE, VarDelete);
|