sesaparcours
    Preparing search index...

    Class ToolboxCategory

    Fake class which should be extended to avoid inheriting static properties

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    dispose getClickTarget getContents getDiv getId getLevel getName getParent hide init isCollapsible isSelectable isVisible onClick refreshTheme setDisabled setSelected show updateFlyoutContents

    Constructors

    Methods

    • Dispose of this toolbox item. No-op by default.

      Returns void

    • Gets the HTML element that is clickable. The parent toolbox element receives clicks. The parent toolbox will add an ID to this element so it can pass the onClick event to the correct toolboxItem.

      Returns Element

      The HTML element that receives clicks.

    • Gets the contents of the category. These are items that are meant to be displayed in the flyout.

      Returns string | FlyoutItemInfoArray

      The definition of items to be displayed in the flyout.

    • Gets the div for the toolbox item.

      Returns Element

      The div for the toolbox item.

    • Gets a unique identifier for this toolbox item.

      Returns string

      The ID for the toolbox item.

    • Gets the nested level of the category.

      Returns number

      The nested level of the category.

    • Gets the name of the category. Used for emitting events.

      Returns string

      The name of the toolbox item.

    • Gets the parent if the toolbox item is nested.

      Returns IToolboxItem

      The parent toolbox item, or null if this toolbox item is not nested.

    • Hide the category.

      Returns void

    • Initializes the toolbox item. This includes creating the DOM and updating the state of any items based on the info object.

      Returns void

    • Whether the toolbox item is collapsible.

      Returns boolean

      True if the toolbox item is collapsible.

    • Whether the toolbox item is selectable.

      Returns boolean

      True if the toolbox item can be selected.

    • Whether the category is visible. A category is only visible if all of its ancestors are expanded and isHidden_ is false.

      Returns boolean

      True if the category is visible, false otherwise.

    • Handles when the toolbox item is clicked.

      Parameters

      • _e: Event

        Click event to handle.

      Returns void

    • Updates the colour for this category.

      Returns void

    • Sets whether the category is disabled.

      Parameters

      • isDisabled: boolean

        True to disable the category, false otherwise.

      Returns void

    • Sets the current category as selected.

      Parameters

      • isSelected: boolean

        True if this category is selected, false otherwise.

      Returns void

    • Show the category. Category will only appear if its parent category is also expanded.

      Returns void

    • Updates the contents to be displayed in the flyout. If the flyout is open when the contents are updated, refreshSelection on the toolbox must also be called.

      Parameters

      • contents: string | FlyoutDefinition

        The contents to be displayed in the flyout. A string can be supplied to create a dynamic category.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods