mirror of
https://github.com/google/blockly.git
synced 2026-05-12 15:10:11 +02:00
Beka Westberg
89 lines
2.3 KiB
TypeScript
89 lines
2.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview (Deprecated) Events fired as a result of UI actions in
|
|
* Blockly's editor.
|
|
*/
|
|
|
|
/**
|
|
* (Deprecated) Events fired as a result of UI actions in
|
|
* Blockly's editor.
|
|
* @class
|
|
*/
|
|
|
|
|
|
import type {Block} from '../block';
|
|
import * as registry from '../registry';
|
|
|
|
import {UiBase} from './events_ui_base';
|
|
import * as eventUtils from './utils';
|
|
|
|
|
|
/**
|
|
* Class for a UI event.
|
|
* @deprecated December 2020. Instead use a more specific UI event.
|
|
* @alias Blockly.Events.Ui
|
|
*/
|
|
export class Ui extends UiBase {
|
|
blockId: AnyDuringMigration;
|
|
element: AnyDuringMigration;
|
|
oldValue: AnyDuringMigration;
|
|
newValue: AnyDuringMigration;
|
|
override type: string;
|
|
|
|
/**
|
|
* @param opt_block The affected block. Null for UI events that do not have
|
|
* an associated block. Undefined for a blank event.
|
|
* @param opt_element One of 'selected', 'comment', 'mutatorOpen', etc.
|
|
* @param opt_oldValue Previous value of element.
|
|
* @param opt_newValue New value of element.
|
|
*/
|
|
constructor(
|
|
opt_block?: Block|null, opt_element?: string,
|
|
opt_oldValue?: AnyDuringMigration, opt_newValue?: AnyDuringMigration) {
|
|
const workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
|
super(workspaceId);
|
|
|
|
this.blockId = opt_block ? opt_block.id : null;
|
|
this.element = typeof opt_element === 'undefined' ? '' : opt_element;
|
|
this.oldValue = typeof opt_oldValue === 'undefined' ? '' : opt_oldValue;
|
|
this.newValue = typeof opt_newValue === 'undefined' ? '' : opt_newValue;
|
|
|
|
/** Type of this event. */
|
|
this.type = eventUtils.UI;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
* @return JSON representation.
|
|
*/
|
|
override toJson(): AnyDuringMigration {
|
|
const json = super.toJson();
|
|
json['element'] = this.element;
|
|
if (this.newValue !== undefined) {
|
|
json['newValue'] = this.newValue;
|
|
}
|
|
if (this.blockId) {
|
|
json['blockId'] = this.blockId;
|
|
}
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: AnyDuringMigration) {
|
|
super.fromJson(json);
|
|
this.element = json['element'];
|
|
this.newValue = json['newValue'];
|
|
this.blockId = json['blockId'];
|
|
}
|
|
}
|
|
|
|
registry.register(registry.Type.EVENT, eventUtils.UI, Ui);
|