Class DeleteArea__Class

Fake class which should be extended to avoid inheriting static properties

Hierarchy (View Summary)

DragTarget__Class
- DeleteArea__Class

Implements

IDeleteArea

Index

Constructors

Methods

getClientRect onDragEnter onDragExit onDragOver onDrop shouldPreventMove wouldDelete

Constructors

constructor

new DeleteArea__Class(): DeleteArea__Class
Abstract class for a component that can delete a block or bubble that is dropped on top of it.

Returns DeleteArea__Class
Implements
Overrides DragTarget__Class.constructor
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3562

Methods

getClientRect

getClientRect(): Blockly.utils.Rect
Returns the bounding rectangle of the drag target area in pixel units relative to the Blockly injection div.

Returns Blockly.utils.Rect
The component's bounding box. Null if drag target area should be ignored.
Implementation of IDeleteArea.getClientRect
Inherited from DragTarget__Class.getClientRect
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3618

onDragEnter

onDragEnter(_dragElement: IDraggable): void
Handles when a cursor with a block or bubble enters this drag target.
Parameters
- _dragElement: IDraggable
  The block or bubble currently being dragged.
Returns void
Implementation of IDeleteArea.onDragEnter
Inherited from DragTarget__Class.onDragEnter
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3625

onDragExit

onDragExit(_dragElement: IDraggable): void
Handles when a cursor with a block or bubble exits this drag target.
Parameters
- _dragElement: IDraggable
  The block or bubble currently being dragged.
Returns void
Implementation of IDeleteArea.onDragExit
Inherited from DragTarget__Class.onDragExit
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3640

onDragOver

onDragOver(_dragElement: IDraggable): void
Handles when a cursor with a block or bubble is dragged over this drag target.
Parameters
- _dragElement: IDraggable
  The block or bubble currently being dragged.
Returns void
Implementation of IDeleteArea.onDragOver
Inherited from DragTarget__Class.onDragOver
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3633

onDrop

onDrop(_dragElement: IDraggable): void
Handles when a block or bubble is dropped on this component. Should not handle delete here.
Parameters
- _dragElement: IDraggable
  The block or bubble currently being dragged.
Returns void
Implementation of IDeleteArea.onDrop
Inherited from DragTarget__Class.onDrop
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3648

shouldPreventMove

shouldPreventMove(_dragElement: IDraggable): boolean
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.
Parameters
- _dragElement: IDraggable
  The block or bubble currently being dragged.
Returns boolean
Whether the block or bubble provided should be returned to drag start.
Implementation of IDeleteArea.shouldPreventMove
Inherited from DragTarget__Class.shouldPreventMove
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3659

wouldDelete

wouldDelete(element: IDraggable, couldConnect: boolean): boolean
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.
Parameters
- element: IDraggable
  The block or bubble currently being dragged.
- couldConnect: boolean
  Whether the element could could connect to another.
Returns boolean
Whether the element provided would be deleted if dropped on this area.
Implementation of IDeleteArea.wouldDelete
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3585