mirror of
https://github.com/google/blockly.git
synced 2026-01-04 23:50:12 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
82 lines
2.3 KiB
TypeScript
82 lines
2.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The abstract class for a component that can delete a block or
|
|
* bubble that is dropped on top of it.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.DeleteArea');
|
|
|
|
import {BlockSvg} from './block_svg.js';
|
|
import {DragTarget} from './drag_target.js';
|
|
import type {IDeleteArea} from './interfaces/i_delete_area.js';
|
|
import type {IDraggable} from './interfaces/i_draggable.js';
|
|
|
|
|
|
/**
|
|
* Abstract class for a component that can delete a block or bubble that is
|
|
* dropped on top of it.
|
|
*
|
|
* @alias Blockly.DeleteArea
|
|
*/
|
|
export class DeleteArea extends DragTarget implements IDeleteArea {
|
|
/**
|
|
* Whether the last block or bubble dragged over this delete area would be
|
|
* deleted if dropped on this component.
|
|
* This property is not updated after the block or bubble is deleted.
|
|
*/
|
|
protected wouldDelete_ = false;
|
|
|
|
/**
|
|
* The unique id for this component that is used to register with the
|
|
* ComponentManager.
|
|
*/
|
|
// TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
|
|
override id!: string;
|
|
|
|
/**
|
|
* Constructor for DeleteArea. Should not be called directly, only by a
|
|
* subclass.
|
|
*/
|
|
constructor() {
|
|
super();
|
|
}
|
|
|
|
/**
|
|
* Returns whether the provided block or bubble would be deleted if dropped on
|
|
* this area.
|
|
* This method should check if the element is deletable and is always called
|
|
* before onDragEnter/onDragOver/onDragExit.
|
|
*
|
|
* @param element The block or bubble currently being dragged.
|
|
* @param couldConnect Whether the element could could connect to another.
|
|
* @returns Whether the element provided would be deleted if dropped on this
|
|
* area.
|
|
*/
|
|
wouldDelete(element: IDraggable, couldConnect: boolean): boolean {
|
|
if (element instanceof BlockSvg) {
|
|
const block = (element);
|
|
const couldDeleteBlock = !block.getParent() && block.isDeletable();
|
|
this.updateWouldDelete_(couldDeleteBlock && !couldConnect);
|
|
} else {
|
|
this.updateWouldDelete_(element.isDeletable());
|
|
}
|
|
return this.wouldDelete_;
|
|
}
|
|
|
|
/**
|
|
* Updates the internal wouldDelete_ state.
|
|
*
|
|
* @param wouldDelete The new value for the wouldDelete state.
|
|
*/
|
|
protected updateWouldDelete_(wouldDelete: boolean) {
|
|
this.wouldDelete_ = wouldDelete;
|
|
}
|
|
}
|