mirror of
https://github.com/google/blockly.git
synced 2026-01-06 16:40:07 +01:00
89 lines
2.4 KiB
TypeScript
89 lines
2.4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The interface for a component that has a handler for when a
|
|
* block is dropped on top of it.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
/**
|
|
* The interface for a component that has a handler for when a
|
|
* block is dropped on top of it.
|
|
* @namespace Blockly.IDragTarget
|
|
*/
|
|
goog.module('Blockly.IDragTarget');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {IComponent} = goog.require('Blockly.IComponent');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {IDraggable} = goog.requireType('Blockly.IDraggable');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {Rect} = goog.requireType('Blockly.utils.Rect');
|
|
|
|
|
|
/**
|
|
* Interface for a component with custom behaviour when a block or bubble is
|
|
* dragged over or dropped on top of it.
|
|
* @extends {IComponent}
|
|
* @interface
|
|
* @alias Blockly.IDragTarget
|
|
*/
|
|
const IDragTarget = function() {};
|
|
|
|
/**
|
|
* Returns the bounding rectangle of the drag target area in pixel units
|
|
* relative to viewport.
|
|
* @return {?Rect} The component's bounding box. Null if drag
|
|
* target area should be ignored.
|
|
*/
|
|
IDragTarget.prototype.getClientRect;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble enters this drag target.
|
|
* @param {!IDraggable} dragElement The block or bubble currently being
|
|
* dragged.
|
|
*/
|
|
IDragTarget.prototype.onDragEnter;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble is dragged over this drag
|
|
* target.
|
|
* @param {!IDraggable} dragElement The block or bubble currently being
|
|
* dragged.
|
|
*/
|
|
IDragTarget.prototype.onDragOver;
|
|
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble exits this drag target.
|
|
* @param {!IDraggable} dragElement The block or bubble currently being
|
|
* dragged.
|
|
*/
|
|
IDragTarget.prototype.onDragExit;
|
|
|
|
/**
|
|
* Handles when a block or bubble is dropped on this component.
|
|
* Should not handle delete here.
|
|
* @param {!IDraggable} dragElement The block or bubble currently being
|
|
* dragged.
|
|
*/
|
|
IDragTarget.prototype.onDrop;
|
|
|
|
/**
|
|
* Returns whether the provided block or bubble should not be moved after being
|
|
* dropped on this component. If true, the element will return to where it was
|
|
* when the drag started.
|
|
* @param {!IDraggable} dragElement The block or bubble currently being
|
|
* dragged.
|
|
* @return {boolean} Whether the block or bubble provided should be returned to
|
|
* drag start.
|
|
*/
|
|
IDragTarget.prototype.shouldPreventMove;
|
|
|
|
exports.IDragTarget = IDragTarget;
|