mirror of
https://github.com/google/blockly.git
synced 2025-12-16 06:10:12 +01:00
1d1a927628
* chore: remove alias comments * chore: format * chore: remove extra newlines * chore: fix bad replaces
78 lines
2.1 KiB
TypeScript
78 lines
2.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The interface for a component that has a handler for when a
|
|
* block is dropped on top of it.
|
|
*
|
|
* @namespace Blockly.IDragTarget
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
import {Rect} from '../utils/rect.js';
|
|
|
|
import {IDraggable} from './i_draggable.js';
|
|
|
|
goog.declareModuleId('Blockly.IDragTarget');
|
|
|
|
import type {IComponent} from './i_component.js';
|
|
|
|
|
|
/**
|
|
* Interface for a component with custom behaviour when a block or bubble is
|
|
* dragged over or dropped on top of it.
|
|
*/
|
|
export interface IDragTarget extends IComponent {
|
|
/**
|
|
* Returns the bounding rectangle of the drag target area in pixel units
|
|
* relative to viewport.
|
|
*
|
|
* @returns The component's bounding box. Null if drag target area should be
|
|
* ignored.
|
|
*/
|
|
getClientRect(): Rect|null;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble enters this drag target.
|
|
*
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDragEnter(dragElement: IDraggable): void;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble is dragged over this drag
|
|
* target.
|
|
*
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDragOver(dragElement: IDraggable): void;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble exits this drag target.
|
|
*
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDragExit(dragElement: IDraggable): void;
|
|
|
|
/**
|
|
* Handles when a block or bubble is dropped on this component.
|
|
* Should not handle delete here.
|
|
*
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDrop(dragElement: IDraggable): void;
|
|
|
|
/**
|
|
* 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 dragElement The block or bubble currently being dragged.
|
|
* @returns Whether the block or bubble provided should be returned to drag
|
|
* start.
|
|
*/
|
|
shouldPreventMove(dragElement: IDraggable): boolean;
|
|
}
|