ToolItemDef Class
An Item that starts the execution of a Tool.
Extends
Methods
Name | Description | |
---|---|---|
constructor(toolItemProps: ToolItemProps, onItemExecuted?: OnItemExecutedFunc): ToolItemDef | ||
getItemDefForTool(tool: Tool, iconSpec?: string, args?: any[]): ToolItemDef Static | Create a ToolItemDef that will run a registered tool. |
Inherited methods
Name | Inherited from | Description |
---|---|---|
execute(): void | ActionButtonItemDef | |
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. |
toolbarReactNode(index?: number): React.ReactNode | ActionButtonItemDef | |
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static | ItemDefBase |
Properties
Name | Type | Description | |
---|---|---|---|
id Accessor ReadOnly | string | ||
toolId | 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