API Reference › appui-react› Item › ActionButtonItemDef

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 Called when the action button is invoked by a click or touch  
getDimension(orientation: Orientation): number Determines the dimension in a given orientation  
handleSizeKnown(size: SizeProps): void Called when the size of the action button is initialized and the size is known  

Inherited methods

Name Inherited from Description
setDescription(v: string | StringGetter | ConditionalStringValue): void ItemDefBase Set the description.
setLabel(v: string | StringGetter | ConditionalStringValue): void ItemDefBase Set the label.
setTooltip(v: string | StringGetter | ConditionalStringValue): void ItemDefBase Set the tooltip.
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static ItemDefBase  

Properties

Name Type Description
_commandHandler Protected CommandHandler | undefined Command Handler for the action button  
defaultButtonSize Static number The default button size for all action buttons  
parameters any | undefined Parameters passed to the Command Handler  
size SizeProps | undefined Size of the action button, as set by handleSizeKnown  

Inherited properties

Name Type Inherited from Description
applicationData any | undefined ItemDefBase  
badgeType BadgeType | undefined ItemDefBase  
description Accessor ReadOnly string ItemDefBase Get the description string
iconElement ReactNode | undefined ItemDefBase  
iconSpec IconSpec | undefined ItemDefBase  
id Accessor Abstract ReadOnly string ItemDefBase  
isActive Accessor boolean ItemDefBase  
isDisabled boolean | ConditionalBooleanValue ItemDefBase  
isHidden boolean | ConditionalBooleanValue ItemDefBase  
isPressed boolean ItemDefBase  
label Accessor ReadOnly string ItemDefBase Get the label string
rawLabel Accessor ReadOnly string | StringGetter | ConditionalStringValue ItemDefBase Get the label string
tooltip Accessor ReadOnly string ItemDefBase Get the tooltip string
trayId Accessor ReadOnly undefined ItemDefBase  

Defined in

Last Updated: 01 May, 2024