mirror of
https://github.com/google/blockly.git
synced 2026-01-07 00:50:27 +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
83 lines
2.1 KiB
TypeScript
83 lines
2.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Events fired as a result of bubble open.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.BubbleOpen');
|
|
|
|
import type {BlockSvg} from '../block_svg.js';
|
|
import * as registry from '../registry.js';
|
|
|
|
import {UiBase} from './events_ui_base.js';
|
|
import * as eventUtils from './utils.js';
|
|
|
|
|
|
/**
|
|
* Class for a bubble open event.
|
|
*
|
|
* @alias Blockly.Events.BubbleOpen
|
|
*/
|
|
export class BubbleOpen extends UiBase {
|
|
blockId: string|null;
|
|
isOpen?: boolean;
|
|
bubbleType?: string;
|
|
override type: string;
|
|
|
|
/**
|
|
* @param opt_block The associated block. Undefined for a blank event.
|
|
* @param opt_isOpen Whether the bubble is opening (false if closing).
|
|
* Undefined for a blank event.
|
|
* @param opt_bubbleType The type of bubble. One of 'mutator', 'comment' or
|
|
* 'warning'. Undefined for a blank event.
|
|
*/
|
|
constructor(
|
|
opt_block: BlockSvg, opt_isOpen?: boolean, opt_bubbleType?: string) {
|
|
const workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
|
super(workspaceId);
|
|
this.blockId = opt_block ? opt_block.id : null;
|
|
|
|
/** Whether the bubble is opening (false if closing). */
|
|
this.isOpen = opt_isOpen;
|
|
|
|
/** The type of bubble. One of 'mutator', 'comment', or 'warning'. */
|
|
this.bubbleType = opt_bubbleType;
|
|
|
|
/** Type of this event. */
|
|
this.type = eventUtils.BUBBLE_OPEN;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): AnyDuringMigration {
|
|
const json = super.toJson();
|
|
json['isOpen'] = this.isOpen;
|
|
json['bubbleType'] = this.bubbleType;
|
|
json['blockId'] = this.blockId;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
*
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: AnyDuringMigration) {
|
|
super.fromJson(json);
|
|
this.isOpen = json['isOpen'];
|
|
this.bubbleType = json['bubbleType'];
|
|
this.blockId = json['blockId'];
|
|
}
|
|
}
|
|
|
|
registry.register(registry.Type.EVENT, eventUtils.BUBBLE_OPEN, BubbleOpen);
|