mirror of
https://github.com/google/blockly.git
synced 2026-01-09 01:50:11 +01:00
90b3f75d82
Our files are up to a decade old, and have churned so much, that the initial author of the file no longer has much meaning. Furthermore, this will encourage developers to post to the developer group, rather than emailing Googlers (usually me) directly.
100 lines
2.5 KiB
JavaScript
100 lines
2.5 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Class for a finished loading workspace event.
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* Class for a finished loading workspace event.
|
|
* @class
|
|
*/
|
|
goog.module('Blockly.Events.FinishedLoading');
|
|
|
|
const Abstract = goog.require('Blockly.Events.Abstract');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const Workspace = goog.requireType('Blockly.Workspace');
|
|
const eventUtils = goog.require('Blockly.Events.utils');
|
|
const object = goog.require('Blockly.utils.object');
|
|
const registry = goog.require('Blockly.registry');
|
|
|
|
|
|
/**
|
|
* Class for a finished loading event.
|
|
* Used to notify the developer when the workspace has finished loading (i.e
|
|
* domToWorkspace).
|
|
* Finished loading events do not record undo or redo.
|
|
* @param {!Workspace=} opt_workspace The workspace that has finished
|
|
* loading. Undefined for a blank event.
|
|
* @extends {Abstract}
|
|
* @constructor
|
|
* @alias Blockly.Events.FinishedLoading
|
|
*/
|
|
const FinishedLoading = function(opt_workspace) {
|
|
/**
|
|
* Whether or not the event is blank (to be populated by fromJson).
|
|
* @type {boolean}
|
|
*/
|
|
this.isBlank = typeof opt_workspace === 'undefined';
|
|
|
|
/**
|
|
* The workspace identifier for this event.
|
|
* @type {string}
|
|
*/
|
|
this.workspaceId = opt_workspace ? opt_workspace.id : '';
|
|
|
|
/**
|
|
* The event group ID for the group this event belongs to. Groups define
|
|
* events that should be treated as an single action from the user's
|
|
* perspective, and should be undone together.
|
|
* @type {string}
|
|
*/
|
|
this.group = eventUtils.getGroup();
|
|
|
|
// Workspace events do not undo or redo.
|
|
this.recordUndo = false;
|
|
};
|
|
object.inherits(FinishedLoading, Abstract);
|
|
|
|
/**
|
|
* Type of this event.
|
|
* @type {string}
|
|
*/
|
|
FinishedLoading.prototype.type = eventUtils.FINISHED_LOADING;
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
* @return {!Object} JSON representation.
|
|
*/
|
|
FinishedLoading.prototype.toJson = function() {
|
|
const json = {
|
|
'type': this.type,
|
|
};
|
|
if (this.group) {
|
|
json['group'] = this.group;
|
|
}
|
|
if (this.workspaceId) {
|
|
json['workspaceId'] = this.workspaceId;
|
|
}
|
|
return json;
|
|
};
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
* @param {!Object} json JSON representation.
|
|
*/
|
|
FinishedLoading.prototype.fromJson = function(json) {
|
|
this.isBlank = false;
|
|
this.workspaceId = json['workspaceId'];
|
|
this.group = json['group'];
|
|
};
|
|
|
|
registry.register(
|
|
registry.Type.EVENT, eventUtils.FINISHED_LOADING, FinishedLoading);
|
|
|
|
exports = FinishedLoading;
|