Interface ICollectionTreeEntryDropdownItem

interface ICollectionTreeEntryDropdownItem {
    enabled: boolean;
    parentEntry: ICollectionTreeEntry;
    type: CollectionTreeEntryItemType;
    value: string;
    visible: boolean;
    setEnabled(enabled: boolean): void;
    setTitle(title: LocalizedString): void;
    setTooltip(title: BasicTooltipContent): void;
    setVisible(visible: boolean): void;
    updateMenuOptions(
        menuOptions: ICollectionTreeEntryDropdownItemMenuOption[],
        newValue?: string,
    ): void;
}

Hierarchy (View Summary)

ICollectionTreeEntryItem
- ICollectionTreeEntryDropdownItem

Index

Properties

enabled parentEntry type value visible

Methods

setEnabled setTitle setTooltip setVisible updateMenuOptions

Properties

`Readonly`enabled

enabled: boolean

Remarks

Enabled state of the entry.

`Readonly`parentEntry

parentEntry: ICollectionTreeEntry

Remarks

Tree entry that owns the item.

`Readonly`type

type: CollectionTreeEntryItemType

Remarks

Type of the item.

`Readonly`value

value: string

Remarks

Value of the entry item.

`Readonly`visible

visible: boolean

Remarks

Visibility state of the entry.

Methods

setEnabled

setEnabled(enabled: boolean): void
Parameters
- enabled: boolean
  New value.
Returns void
Remarks
Updates enabled state of the item.

Inherited from ICollectionTreeEntryItem.setEnabled

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New title.
Returns void
Remarks
Updates title of the item.

Inherited from ICollectionTreeEntryItem.setTitle

setTooltip

setTooltip(title: BasicTooltipContent): void
Parameters
- title: BasicTooltipContent
Returns void
Remarks
Updates tooltip of the item.

Inherited from ICollectionTreeEntryItem.setTooltip

setVisible

setVisible(visible: boolean): void
Parameters
- visible: boolean
  New value.
Returns void
Remarks
Updates visibility of the item.

Inherited from ICollectionTreeEntryItem.setVisible

updateMenuOptions

updateMenuOptions(
menuOptions: ICollectionTreeEntryDropdownItemMenuOption[],
newValue?: string,
): void
Parameters
- menuOptions: ICollectionTreeEntryDropdownItemMenuOption[]
  New list of updated menu options
- OptionalnewValue: string
  New value value to use for the dropdown
Returns void
Remarks
Update list of dropdown menu options.