sesaparcours
    Preparing search index...

    Interface IToolbox

    interface IToolbox {
        clearSelection(): void;
        dispose(): void;
        getFlyout(): IFlyout;
        getHeight(): number;
        getSelectedItem(): IToolboxItem;
        getWidth(): number;
        getWorkspace(): WorkspaceSvg;
        handleToolboxItemResize(): void;
        init(): void;
        isHorizontal(): boolean;
        position(): void;
        refreshSelection(): void;
        refreshTheme(): void;
        render(toolboxDef: ToolboxInfo): void;
        selectItemByPosition(position: number): void;
        setVisible(isVisible: boolean): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    clearSelection dispose getFlyout getHeight getSelectedItem getWidth getWorkspace handleToolboxItemResize init isHorizontal position refreshSelection refreshTheme render selectItemByPosition setVisible

    Methods

    • Unhighlights any previously selected item.

      Returns void

    • Disposes of this toolbox.

      Returns void

    • Gets the toolbox flyout.

      Returns IFlyout

      The toolbox flyout.

    • Gets the height of the toolbox.

      Returns number

      The width of the toolbox.

    • Gets the selected item.

      Returns IToolboxItem

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

    • Gets the width of the toolbox.

      Returns number

      The width of the toolbox.

    • Gets the workspace for the toolbox.

      Returns WorkspaceSvg

      The parent workspace for the toolbox.

    • Handles resizing the toolbox when a toolbox item resizes.

      Returns void

    • Initializes the toolbox.

      Returns void

    • Gets whether or not the toolbox is horizontal.

      Returns boolean

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

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

      Returns 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

    • Updates the category colours and background colour of selected categories.

      Returns 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

    • Selects the toolbox item by it's position in the list of toolbox items.

      Parameters

      • position: number

        The position of the item to select.

      Returns void

    • Sets the visibility of the toolbox.

      Parameters

      • isVisible: boolean

        True if toolbox should be visible.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods