GroupItemDef Class
An Item that opens a group of items.
Extends
Methods
Name | Description | |
---|---|---|
constructor(groupItemProps: GroupItemProps, onItemExecuted?: OnItemExecutedFunc): GroupItemDef | ||
execute(): void | ||
getItemById(id: string): ItemDefBase | undefined | ||
getItemByIndex(index: number): ItemDefBase | undefined | ||
resolveItems(force?: false | true): void | ||
setPanelLabel(v: string | StringGetter): void | Set the panelLabel. | |
toolbarReactNode(index?: number): React.ReactNode |
Inherited methods
Name | Inherited from | Description |
---|---|---|
getDimension(orientation: Orientation): number | ActionButtonItemDef | |
handleSizeKnown(size: SizeProps): void | ActionButtonItemDef | |
setDescription(v: string | StringGetter): void | ItemDefBase | Set the description. |
setLabel(v: string | StringGetter): void | ItemDefBase | Set the label. |
setTooltip(v: string | StringGetter): void | ItemDefBase | Set the tooltip. |
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static | ItemDefBase |
Properties
Name | Type | Description | |
---|---|---|---|
defaultActiveItemId | undefined | string | ||
direction | Direction | ||
directionExplicit | boolean | ||
groupId | string | ||
groupIdPrefix Static | string | ||
id Accessor ReadOnly | string | ||
itemCount Accessor ReadOnly | number | ||
items | AnyItemDef[] | ||
itemsInColumn | number | ||
panelLabel Accessor ReadOnly | string | Get the panelLabel string |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
_commandHandler Protected | undefined | CommandHandler | ActionButtonItemDef | |
applicationData | undefined | any | ItemDefBase | |
badgeType | undefined | BadgeType | ItemDefBase | |
betaBadge | boolean | ItemDefBase | |
defaultButtonSize Static | number | ActionButtonItemDef | |
description Accessor ReadOnly | string | ItemDefBase | Get the description string |
iconElement | undefined | React.ReactNode | ItemDefBase | |
iconSpec | string | React.ReactNode | ItemDefBase | |
isActive | boolean | ItemDefBase | |
isEnabled | boolean | ItemDefBase | |
isPressed | boolean | ItemDefBase | |
isVisible | boolean | ItemDefBase | |
label Accessor ReadOnly | string | ItemDefBase | Get the label string |
parameters | undefined | any | ActionButtonItemDef | |
size | undefined | SizeProps | ActionButtonItemDef | |
stateFunc | undefined | (state: Readonly<BaseItemState>) => BaseItemState | ItemDefBase | |
stateSyncIds | string[] | ItemDefBase | |
tooltip Accessor ReadOnly | string | ItemDefBase | Get the tooltip string |
trayId Accessor ReadOnly | undefined | ItemDefBase |
Defined in
Last Updated: 08 January, 2020