mirror of
https://github.com/google/blockly.git
synced 2026-01-09 10:00:09 +01:00
52 lines
1.4 KiB
TypeScript
52 lines
1.4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The interface for a positionable UI element.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
/**
|
|
* The interface for a positionable UI element.
|
|
* @namespace Blockly.IPositionable
|
|
*/
|
|
goog.module('Blockly.IPositionable');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {IComponent} = goog.require('Blockly.IComponent');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {MetricsManager} = goog.requireType('Blockly.MetricsManager');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {Rect} = goog.requireType('Blockly.utils.Rect');
|
|
|
|
|
|
/**
|
|
* Interface for a component that is positioned on top of the workspace.
|
|
* @extends {IComponent}
|
|
* @interface
|
|
* @alias Blockly.IPositionable
|
|
*/
|
|
const IPositionable = function() {};
|
|
|
|
/**
|
|
* Positions the element. Called when the window is resized.
|
|
* @param {!MetricsManager.UiMetrics} metrics The workspace metrics.
|
|
* @param {!Array<!Rect>} savedPositions List of rectangles that
|
|
* are already on the workspace.
|
|
*/
|
|
IPositionable.prototype.position;
|
|
|
|
/**
|
|
* Returns the bounding rectangle of the UI element in pixel units relative to
|
|
* the Blockly injection div.
|
|
* @return {?Rect} The UI elements's bounding box. Null if
|
|
* bounding box should be ignored by other UI elements.
|
|
*/
|
|
IPositionable.prototype.getBoundingRectangle;
|
|
|
|
exports.IPositionable = IPositionable;
|