mirror of
https://github.com/google/blockly.git
synced 2026-01-08 09:30:06 +01:00
1647a3299a
* fix: Move @alias onto classes instead of constructors * fix: Fix JSDoc for constructors.
99 lines
2.6 KiB
JavaScript
99 lines
2.6 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The abstract class for a component with custom behaviour when a
|
|
* block or bubble is dragged over or dropped on top of it.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
/**
|
|
* The abstract class for a component with custom behaviour when a
|
|
* block or bubble is dragged over or dropped on top of it.
|
|
* @class
|
|
*/
|
|
goog.module('Blockly.DragTarget');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {IDragTarget} = goog.require('Blockly.IDragTarget');
|
|
/* 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');
|
|
|
|
|
|
/**
|
|
* Abstract class for a component with custom behaviour when a block or bubble
|
|
* is dragged over or dropped on top of it.
|
|
* @implements {IDragTarget}
|
|
* @alias Blockly.DragTarget
|
|
*/
|
|
class DragTarget {
|
|
/**
|
|
* Handles when a cursor with a block or bubble enters this drag target.
|
|
* @param {!IDraggable} _dragElement The block or bubble currently being
|
|
* dragged.
|
|
*/
|
|
onDragEnter(_dragElement) {
|
|
// no-op
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
onDragOver(_dragElement) {
|
|
// no-op
|
|
}
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble exits this drag target.
|
|
* @param {!IDraggable} _dragElement The block or bubble currently being
|
|
* dragged.
|
|
*/
|
|
onDragExit(_dragElement) {
|
|
// no-op
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
onDrop(_dragElement) {
|
|
// no-op
|
|
}
|
|
|
|
/**
|
|
* Returns the bounding rectangle of the drag target area in pixel units
|
|
* relative to the Blockly injection div.
|
|
* @return {?Rect} The component's bounding box. Null if drag
|
|
* target area should be ignored.
|
|
*/
|
|
getClientRect() {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
shouldPreventMove(_dragElement) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
exports.DragTarget = DragTarget;
|