Class Trashcan__Class

Fake class which should be extended to avoid inheriting static properties

Hierarchy (View Summary)

DeleteArea__Class
- Trashcan__Class
  - Trashcan

Implements

Index

Constructors

constructor

new Trashcan__Class(workspace: WorkspaceSvg): Trashcan__Class
Class for a trash can.
Parameters
- workspace: WorkspaceSvg
  The workspace to sit in.
Returns Trashcan__Class
Implements
Implements
Overrides DeleteArea__Class.constructor
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10359

Properties

flyout: IFlyout

The trashcan flyout.

Package

id

id: string

The unique id for this component that is used to register with the ComponentManager.

isLidOpen

isLidOpen: boolean

Current open/close state of the lid.

Methods

autoHide

autoHide(onlyClosePopups: boolean): void
Hides the component. Called in Blockly.hideChaff.
Parameters
- onlyClosePopups: boolean
  Whether only popups should be closed. Flyouts should not be closed if this is true.
Returns void
Implementation of IAutoHideable.autoHide
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10420

click

click(): void
Inspect the contents of the trash.

Returns void
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10470

closeFlyout

closeFlyout(): void
Closes the trashcan flyout.

Returns void
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10413

closeLid

closeLid(): void
Flip the lid shut. Called externally after a drag.

Returns void
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10465

contentsIsOpen

contentsIsOpen(): boolean
Returns true if the trashcan contents-flyout is currently open.

Returns boolean
True if the trashcan contents-flyout is currently open.
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10403

createDom

createDom(): SVGElement
Create the trash can elements.

Returns SVGElement
The trash can's SVG group.
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10385

dispose

dispose(): void
Dispose of this trash can. Unlink from all DOM elements to prevent memory leaks.

Returns void
Suppress
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10397

emptyContents

emptyContents(): void
Empties the trashcan's contents. If the contents-flyout is currently open it will be closed.

Returns void
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10426

getBoundingRectangle

getBoundingRectangle(): Blockly.utils.Rect
Returns the bounding rectangle of the UI element in pixel units relative to the Blockly injection div.

Returns Blockly.utils.Rect
The UI elements’s bounding box. Null if bounding box should be ignored by other UI elements.
Implementation of IPositionable.getBoundingRectangle
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10444

getClientRect

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

Returns Blockly.utils.Rect
The component's bounding box. Null if drag target area should be ignored.
Overrides DeleteArea__Class.getClientRect
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10452

init

init(): void
Initializes the trash can.

Returns void
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10390

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
Inherited from DeleteArea__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
Inherited from DeleteArea__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
Inherited from DeleteArea__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
Inherited from DeleteArea__Class.onDrop
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3648

openFlyout

openFlyout(): void
Opens the trashcan flyout.

Returns void
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10408

position

position(metrics: UiMetrics, savedPositions: Blockly.utils.Rect[]): void
Positions the trashcan. It is positioned in the opposite corner to the corner the categories/toolbox starts at.
Parameters
- metrics: UiMetrics
  The workspace metrics.
- savedPositions: Blockly.utils.Rect[]
  List of rectangles that are already on the workspace.
Returns void
Implementation of IPositionable.position
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10436

setLidOpen

setLidOpen(state: boolean): void
Flip the lid open or shut.
Parameters
- state: boolean
  True if open.
Returns void
Package
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10459

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.
Inherited from DeleteArea__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.
Inherited from DeleteArea__Class.wouldDelete
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:3585

Class Trashcan__Class

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Trashcan__Class

Implements

Implements

Properties

flyout

Package

id

isLidOpen

Methods

autoHide

Parameters

Returns void

click

Returns void

closeFlyout

Returns void

closeLid

Returns void

contentsIsOpen

Returns boolean

createDom

Returns SVGElement

dispose

Returns void

Suppress

emptyContents

Returns void

getBoundingRectangle

Returns Blockly.utils.Rect

getClientRect

Returns Blockly.utils.Rect

init

Returns void

onDragEnter

Parameters

Returns void

onDragExit

Parameters

Returns void

onDragOver

Parameters

Returns void

onDrop

Parameters

Returns void

openFlyout

Returns void

position

Parameters

Returns void

setLidOpen

Parameters

Returns void

Package

shouldPreventMove

Parameters

Returns boolean

wouldDelete

Parameters

Returns boolean

Settings

On This Page