sesaparcours
    Preparing search index...

    Interface ICollapsibleToolboxItem

    interface ICollapsibleToolboxItem {
        dispose: any;
        toggleExpanded: any;
        getChildToolboxItems(): IToolboxItem[];
        getClickTarget(): Element;
        getContents(): string | FlyoutItemInfoArray;
        getDiv(): Element;
        getId(): string;
        getLevel(): number;
        getName(): string;
        getParent(): IToolboxItem;
        init(): void;
        isCollapsible(): boolean;
        isExpanded(): boolean;
        isSelectable(): boolean;
        onClick(_e: Event): void;
        setSelected(_isSelected: boolean): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    dispose toggleExpanded

    Methods

    getChildToolboxItems getClickTarget getContents getDiv getId getLevel getName getParent init isCollapsible isExpanded isSelectable onClick setSelected

    Properties

    dispose: any

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

    toggleExpanded: any

    Toggles whether or not the toolbox item is expanded.

    Methods

    • Gets any children toolbox items. (ex. Gets the subcategories)

      Returns IToolboxItem[]

      The child toolbox items.

    • 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 toolbox item. 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 toolbox item. 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.

    • 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 expanded to show its child subcategories.

      Returns boolean

      True if the toolbox item shows its children, false if it is collapsed.

    • Whether the toolbox item is selectable.

      Returns boolean

      True if the toolbox item can be selected.

    • Handles when the toolbox item is clicked.

      Parameters

      • _e: Event

        Click event to handle.

      Returns void

    • Sets the current toolbox item as selected.

      Parameters

      • _isSelected: boolean

        True if this category is selected, false otherwise.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods