mirror of
https://github.com/google/blockly.git
synced 2026-05-12 15:10:11 +02:00
Christopher Allen
b0475b0c68
* fix: Remove spurious blank lines Remove extraneous blank lines introduced by deletion of 'use strict'; pragmas. Also fix the location of the goog.declareModuleId call in core/utils/array.ts. * fix: Add missing double-blank-line before body of modules Our convention is to have two blank lines between the imports (or module ID, if there are no imports) and the beginning of the body of the module. Enforce this. * fix: one addition format error for PR #6243
98 lines
2.9 KiB
TypeScript
98 lines
2.9 KiB
TypeScript
/**
|
|
* @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.
|
|
*/
|
|
|
|
/**
|
|
* The abstract class for a component with custom behaviour when a
|
|
* block or bubble is dragged over or dropped on top of it.
|
|
* @class
|
|
*/
|
|
import * as goog from '../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.DragTarget');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
import {IDragTarget} from './interfaces/i_drag_target.js';
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
import {IDraggable} from './interfaces/i_draggable.js';
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
import {Rect} from './utils/rect.js';
|
|
|
|
|
|
/**
|
|
* Abstract class for a component with custom behaviour when a block or bubble
|
|
* is dragged over or dropped on top of it.
|
|
* @alias Blockly.DragTarget
|
|
*/
|
|
export class DragTarget implements IDragTarget {
|
|
/**
|
|
* The unique id for this component that is used to register with the
|
|
* ComponentManager.
|
|
*/
|
|
// TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
|
|
id!: string;
|
|
|
|
/**
|
|
* Constructor for DragTarget. It exists to add the id property and should not
|
|
* be called directly, only by a subclass.
|
|
*/
|
|
constructor() {}
|
|
|
|
/**
|
|
* 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) {}
|
|
// no-op
|
|
|
|
/**
|
|
* 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) {}
|
|
// no-op
|
|
|
|
/**
|
|
* 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) {}
|
|
// no-op
|
|
/**
|
|
* 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) {}
|
|
// no-op
|
|
|
|
/**
|
|
* Returns the bounding rectangle of the drag target area in pixel units
|
|
* relative to the Blockly injection div.
|
|
* @return The component's bounding box. Null if drag target area should be
|
|
* ignored.
|
|
*/
|
|
getClientRect(): Rect|null {
|
|
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 _dragElement The block or bubble currently being dragged.
|
|
* @return Whether the block or bubble provided should be returned to drag
|
|
* start.
|
|
*/
|
|
shouldPreventMove(_dragElement: IDraggable): boolean {
|
|
return false;
|
|
}
|
|
}
|