Class Toolbox

HtmlDiv

id

RTL

toolboxPosition

addStyle

• addStyle(style: string): void

  Adds a style on the toolbox. Usually used to change the cursor.

  Parameters

  • style: string

    The name of the class to add.

  Returns void

  Package

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

clearSelection

• clearSelection(): void

  Unhighlights any previously selected item.

  Returns void

dispose

• dispose(): void

  Disposes of this toolbox.

  Returns void

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.

getFlyout

• getFlyout(): IFlyout

  Gets the toolbox flyout.

  Returns IFlyout

  The toolbox flyout.

getHeight

• getHeight(): number

  Gets the height of the toolbox.

  Returns number

  The width of the toolbox.

getPreviouslySelectedItem

• getPreviouslySelectedItem(): ISelectableToolboxItem

  Gets the previously selected item.

  Returns ISelectableToolboxItem

  The previously selected item, or null if no item was previously selected.

getSelectedItem

• getSelectedItem(): ISelectableToolboxItem

  Gets the selected item.

  Returns ISelectableToolboxItem

  The selected item, or null if no item is currently selected.

getToolboxItemById

• getToolboxItemById(id: string): IToolboxItem

  Gets the toolbox item with the given ID.

  Parameters

  • id: string

    The ID of the toolbox item.

  Returns IToolboxItem

  The toolbox item with the given ID, or null if no item exists.

getToolboxItems

• getToolboxItems(): IToolboxItem[]

  Gets the items in the toolbox.

  Returns IToolboxItem[]

  The list of items in the toolbox.

getWidth

• getWidth(): number

  Gets the width of the toolbox.

  Returns number

  The width of the toolbox.

getWorkspace

• getWorkspace(): WorkspaceSvg

  Gets the workspace for the toolbox.

  Returns WorkspaceSvg

  The parent workspace for the toolbox.

handleToolboxItemResize

• handleToolboxItemResize(): void

  Handles resizing the toolbox when a toolbox item resizes.

  Returns void

  Package

init

• init(): void

  Initializes the toolbox

  Returns void

isHorizontal

• isHorizontal(): boolean

  Gets whether or not the toolbox is horizontal.

  Returns boolean

  True if the toolbox is horizontal, false if the toolbox is vertical.

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

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

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

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

onShortcut

• onShortcut(_shortcut: KeyboardShortcut): boolean

  Handles the given keyboard shortcut.

  Parameters

  • _shortcut: KeyboardShortcut

    The shortcut to be handled.

  Returns boolean

  True if the shortcut has been handled, false otherwise.

position

• position(): void

  Positions the toolbox based on whether it is a horizontal toolbox and whether the workspace is in rtl.

  Returns void

refreshSelection

• refreshSelection(): void

  Updates the flyout's content without closing it. Should be used in response to a change in one of the dynamic categories, such as variables or procedures.

  Returns void

refreshTheme

• refreshTheme(): void

  Updates the category colours and background colour of selected categories.

  Returns void

  Package

removeStyle

• removeStyle(style: string): void

  Removes a style from the toolbox. Usually used to change the cursor.

  Parameters

  • style: string

    The name of the class to remove.

  Returns void

  Package

render

• render(toolboxDef: ToolboxInfo): void

  Fills the toolbox with new toolbox items and removes any old contents.

  Parameters

  • toolboxDef: ToolboxInfo

    Object holding information for creating a toolbox.

  Returns void

  Package

selectItemByPosition

• selectItemByPosition(position: number): void

  Selects the toolbox item by its position in the list of toolbox items.

  Parameters

  • position: number

    The position of the item to select.

  Returns void

setSelectedItem

• setSelectedItem(newItem: IToolboxItem): void

  Sets the given item as selected. No-op if the item is not selectable.

  Parameters

  • newItem: IToolboxItem

    The toolbox item to select.

  Returns void

setVisible

• setVisible(isVisible: boolean): void

  Shows or hides the toolbox.

  Parameters

  • isVisible: boolean

    True if toolbox should be visible.

  Returns void

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.

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.