ActionButtonItemDef Class

Abstract base class that is used by classes to execute an action when pressed.

Extends

Extended by

Methods

Name Description
constructor(itemProps: ItemProps, onItemExecuted?: OnItemExecutedFunc): ActionButtonItemDef    
execute(): void    
getDimension(orientation: Orientation): number    
handleSizeKnown(size: SizeProps): void    
toolbarReactNode(index?: number): React.ReactNode    

Inherited methods

Name Inherited from Description
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
_commandHandler Protected undefined | CommandHandler    
defaultButtonSize Static number    
parameters undefined | any    
size undefined | SizeProps    

Inherited properties

Name Type Inherited from Description
applicationData undefined | any ItemDefBase  
badgeType undefined | BadgeType ItemDefBase  
betaBadge boolean ItemDefBase  
description Accessor ReadOnly string ItemDefBase Get the description string
iconElement undefined | React.ReactNode ItemDefBase  
iconSpec string | React.ReactNode ItemDefBase  
id Accessor ReadOnly string ItemDefBase  
isActive boolean ItemDefBase  
isEnabled boolean ItemDefBase  
isPressed boolean ItemDefBase  
isVisible boolean ItemDefBase  
label Accessor ReadOnly string ItemDefBase Get the label string
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: 13 June, 2024