mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +01:00
7ccdcc5cef
* refactor(events): Use "export ... from" where applicable
* refactor(events): Introduce EventType enum
Introduce an enum for the event .type values. We can't actually
use it as the type of the .type property on Abstract events,
because we want to allow developers to add their own custom
event types inheriting from this type, but at least this way we
can be reasonably sure that all of our own event subclasses have
distinct .type values—plus consistent use of enum syntax
(EventType.TYPE_NAME) is probably good for readability overall.
Put it in a separate module from the rest of events/utils.ts
because it would be helpful if event utils could use
event instanceof SomeEventType
for type narrowing but but at the moment most events are in
modules that depend on events/utils.ts for their .type
constant, and although circular ESM dependencies should work
in principle there are various restrictions and this
particular circularity causes issues at the moment.
A few of the event classes also depend on utils.ts for fire()
or other functions, which will be harder to deal with, but at
least this commit is win in terms of reducing the complexity
of our dependencies, making most of the Abstract event subclass
module dependent on type.ts, which has no imports, rather than
on utils.ts which has multiple imports.
122 lines
3.2 KiB
TypeScript
122 lines
3.2 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Events fired as a result of bubble open.
|
|
*
|
|
* @class
|
|
*/
|
|
|
|
// Former goog.module ID: Blockly.Events.BubbleOpen
|
|
|
|
import type {BlockSvg} from '../block_svg.js';
|
|
import * as registry from '../registry.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
import type {AbstractEventJson} from './events_abstract.js';
|
|
import {UiBase} from './events_ui_base.js';
|
|
import {EventType} from './type.js';
|
|
|
|
/**
|
|
* Class for a bubble open event.
|
|
*/
|
|
export class BubbleOpen extends UiBase {
|
|
/** The ID of the block the bubble is attached to. */
|
|
blockId?: string;
|
|
|
|
/** True if the bubble is opening, false if closing. */
|
|
isOpen?: boolean;
|
|
|
|
/** The type of bubble; one of 'mutator', 'comment', or 'warning'. */
|
|
bubbleType?: BubbleType;
|
|
|
|
override type = EventType.BUBBLE_OPEN;
|
|
|
|
/**
|
|
* @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?: BubbleType,
|
|
) {
|
|
const workspaceId = opt_block ? opt_block.workspace.id : undefined;
|
|
super(workspaceId);
|
|
if (!opt_block) return;
|
|
|
|
this.blockId = opt_block.id;
|
|
this.isOpen = opt_isOpen;
|
|
this.bubbleType = opt_bubbleType;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): BubbleOpenJson {
|
|
const json = super.toJson() as BubbleOpenJson;
|
|
if (this.isOpen === undefined) {
|
|
throw new Error(
|
|
'Whether this event is for opening the bubble is undefined. ' +
|
|
'Either pass the value to the constructor, or call fromJson',
|
|
);
|
|
}
|
|
if (!this.bubbleType) {
|
|
throw new Error(
|
|
'The type of bubble is undefined. Either pass the ' +
|
|
'value to the constructor, or call fromJson',
|
|
);
|
|
}
|
|
json['isOpen'] = this.isOpen;
|
|
json['bubbleType'] = this.bubbleType;
|
|
json['blockId'] = this.blockId || '';
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @param event The event to append new properties to. Should be a subclass
|
|
* of BubbleOpen, but we can't specify that due to the fact that
|
|
* parameters to static methods in subclasses must be supertypes of
|
|
* parameters to static methods in superclasses.
|
|
* @internal
|
|
*/
|
|
static fromJson(
|
|
json: BubbleOpenJson,
|
|
workspace: Workspace,
|
|
event?: any,
|
|
): BubbleOpen {
|
|
const newEvent = super.fromJson(
|
|
json,
|
|
workspace,
|
|
event ?? new BubbleOpen(),
|
|
) as BubbleOpen;
|
|
newEvent.isOpen = json['isOpen'];
|
|
newEvent.bubbleType = json['bubbleType'];
|
|
newEvent.blockId = json['blockId'];
|
|
return newEvent;
|
|
}
|
|
}
|
|
|
|
export enum BubbleType {
|
|
MUTATOR = 'mutator',
|
|
COMMENT = 'comment',
|
|
WARNING = 'warning',
|
|
}
|
|
|
|
export interface BubbleOpenJson extends AbstractEventJson {
|
|
isOpen: boolean;
|
|
bubbleType: BubbleType;
|
|
blockId: string;
|
|
}
|
|
|
|
registry.register(registry.Type.EVENT, EventType.BUBBLE_OPEN, BubbleOpen);
|