mirror of
https://github.com/google/blockly.git
synced 2026-06-17 08:35:12 +02:00
Aaron Dodson
42 lines
1.2 KiB
TypeScript
42 lines
1.2 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
// Former goog.module ID: Blockly.ISelectable
|
|
|
|
import type {WorkspaceSvg} from '../workspace_svg.js';
|
|
import {IFocusableNode, isFocusableNode} from './i_focusable_node.js';
|
|
|
|
/**
|
|
* The interface for an object that is selectable.
|
|
*
|
|
* Implementations are generally expected to use their implementations of
|
|
* onNodeFocus() and onNodeBlur() to call setSelected() with themselves and
|
|
* null, respectively, in order to ensure that selections are correctly updated
|
|
* and the selection change event is fired.
|
|
*/
|
|
export interface ISelectable extends IFocusableNode {
|
|
id: string;
|
|
|
|
workspace: WorkspaceSvg;
|
|
|
|
/** Select this. Highlight it visually. */
|
|
select(): void;
|
|
|
|
/** Unselect this. Unhighlight it visually. */
|
|
unselect(): void;
|
|
}
|
|
|
|
/** Checks whether the given object is an ISelectable. */
|
|
export function isSelectable(obj: any): obj is ISelectable {
|
|
return (
|
|
isFocusableNode(obj) &&
|
|
typeof (obj as ISelectable).id === 'string' &&
|
|
typeof (obj as ISelectable).workspace === 'object' &&
|
|
typeof (obj as ISelectable).select === 'function' &&
|
|
typeof (obj as ISelectable).unselect === 'function'
|
|
);
|
|
}
|