mirror of
https://github.com/google/blockly.git
synced 2026-01-10 18:37:09 +01:00
1647a3299a
* fix: Move @alias onto classes instead of constructors * fix: Fix JSDoc for constructors.
64 lines
1.4 KiB
JavaScript
64 lines
1.4 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Base class for events fired as a result of UI actions in
|
|
* Blockly's editor.
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* Base class for events fired as a result of UI actions in
|
|
* Blockly's editor.
|
|
* @class
|
|
*/
|
|
goog.module('Blockly.Events.UiBase');
|
|
|
|
const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
|
|
|
|
|
|
/**
|
|
* Base class for a UI event.
|
|
* UI events are events that don't need to be sent over the wire for multi-user
|
|
* editing to work (e.g. scrolling the workspace, zooming, opening toolbox
|
|
* categories).
|
|
* UI events do not undo or redo.
|
|
* @extends {AbstractEvent}
|
|
* @alias Blockly.Events.UiBase
|
|
*/
|
|
class UiBase extends AbstractEvent {
|
|
/**
|
|
* @param {string=} opt_workspaceId The workspace identifier for this event.
|
|
* Undefined for a blank event.
|
|
*/
|
|
constructor(opt_workspaceId) {
|
|
super();
|
|
|
|
/**
|
|
* Whether or not the event is blank (to be populated by fromJson).
|
|
* @type {boolean}
|
|
*/
|
|
this.isBlank = typeof opt_workspaceId === 'undefined';
|
|
|
|
/**
|
|
* The workspace identifier for this event.
|
|
* @type {string}
|
|
*/
|
|
this.workspaceId = opt_workspaceId ? opt_workspaceId : '';
|
|
|
|
// UI events do not undo or redo.
|
|
this.recordUndo = false;
|
|
|
|
/**
|
|
* Whether or not the event is a UI event.
|
|
* @type {boolean}
|
|
*/
|
|
this.isUiEvent = true;
|
|
}
|
|
}
|
|
|
|
exports.UiBase = UiBase;
|