API Reference > appui-react > Widget > ToolWidgetDef

ToolWidgetDef Class

Deprecated  in 3.6. Use ToolWidgetComposer instead

Definition of a Tool Widget normally displayed in the top left zone in the 9-Zone Layout system.

Extends

Methods

Name Description
constructor(props: ToolWidgetProps): ToolWidgetDef    
renderCornerItem(): ReactNode    

Inherited methods

Name Inherited from Description
canOpen(): boolean ToolbarWidgetDefBase  
getWidgetControl(type: ConfigurableUiControlType): undefined | WidgetControl ToolbarWidgetDefBase  
onWidgetStateChanged(): void ToolbarWidgetDefBase  
renderHorizontalToolbar(): ReactNode ToolbarWidgetDefBase  
renderVerticalToolbar(): ReactNode ToolbarWidgetDefBase  
restoreTransientState(): boolean ToolbarWidgetDefBase Overwrite to restore transient DOM state.
saveTransientState(): void ToolbarWidgetDefBase Overwrite to save transient DOM state (i.e.
setCanPopout(value: undefined | boolean): void ToolbarWidgetDefBase  
setFloatingContainerId(value: undefined | string): void ToolbarWidgetDefBase  
setLabel(v: string | ConditionalStringValue | StringGetter): void ToolbarWidgetDefBase Set the label.
setTooltip(v: string | ConditionalStringValue | StringGetter): void ToolbarWidgetDefBase Set the tooltip.
setUpSyncSupport(props: WidgetProps): void ToolbarWidgetDefBase  
setWidgetState(newState: WidgetState): void ToolbarWidgetDefBase  
createWidgetPropsFromAbstractProps(abstractWidgetProps: AbstractWidgetProps): WidgetProps Static ToolbarWidgetDefBase  
initializeFromWidgetProps(widgetProps: WidgetProps, me: WidgetDef): void Static ToolbarWidgetDefBase  

Properties

Name Type Description
reactNode Accessor ReadOnly ReactNode    

Inherited properties

Name Type Inherited from Description
activeState Accessor ReadOnly WidgetState ToolbarWidgetDefBase  
allowedPanelTargets Accessor undefined | ToolbarWidgetDefBase  
applicationData Accessor ReadOnly any ToolbarWidgetDefBase  
badgeType Accessor ReadOnly undefined | BadgeType ToolbarWidgetDefBase  
canPopout Accessor ReadOnly undefined | boolean ToolbarWidgetDefBase  
classId Accessor ReadOnly undefined | string | ConfigurableUiControlConstructor ToolbarWidgetDefBase  
fillZone Accessor ReadOnly boolean ToolbarWidgetDefBase  
floatingContainerId Accessor ReadOnly undefined | string ToolbarWidgetDefBase  
hideWithUiWhenFloating Accessor boolean ToolbarWidgetDefBase  
horizontalDirection Direction ToolbarWidgetDefBase  
horizontalItems undefined | ItemList ToolbarWidgetDefBase  
horizontalPanelAlignment ToolbarPanelAlignment ToolbarWidgetDefBase  
iconSpec Accessor IconSpec ToolbarWidgetDefBase  
id Accessor ReadOnly string ToolbarWidgetDefBase  
initialProps Accessor ReadOnly undefined | WidgetProps ToolbarWidgetDefBase  
isActive Accessor ReadOnly boolean ToolbarWidgetDefBase  
isFloating Accessor ReadOnly boolean ToolbarWidgetDefBase  
isFloatingStateSupported Accessor ReadOnly boolean ToolbarWidgetDefBase  
isFloatingStateWindowResizable Accessor ReadOnly boolean ToolbarWidgetDefBase  
isFreeform Accessor ReadOnly boolean ToolbarWidgetDefBase  
isStatusBar Accessor ReadOnly boolean ToolbarWidgetDefBase  
isToolSettings Accessor ReadOnly boolean ToolbarWidgetDefBase  
isVisible Accessor ReadOnly boolean ToolbarWidgetDefBase  
label Accessor ReadOnly string ToolbarWidgetDefBase Get the label string
priority Accessor ReadOnly number ToolbarWidgetDefBase  
state Accessor ReadOnly WidgetState ToolbarWidgetDefBase  
stateChanged Accessor ReadOnly boolean ToolbarWidgetDefBase  
stateFunc Accessor ReadOnly undefined | WidgetStateFunc ToolbarWidgetDefBase  
syncEventIds Accessor ReadOnly string[] ToolbarWidgetDefBase  
tooltip Accessor ReadOnly string ToolbarWidgetDefBase Get the tooltip string
verticalDirection Direction ToolbarWidgetDefBase  
verticalItems undefined | ItemList ToolbarWidgetDefBase  
verticalPanelAlignment ToolbarPanelAlignment ToolbarWidgetDefBase  
widgetBaseName Accessor string ToolbarWidgetDefBase  
widgetControl Accessor ReadOnly undefined | WidgetControl ToolbarWidgetDefBase  
widgetType Accessor WidgetType ToolbarWidgetDefBase  

Defined in

Last Updated: 20 June, 2023