ToolbarWidgetDefBase Class

A Toolbar Widget normally displayed in the top left & top right zones in the 9-Zone Layout system.


Extended by


Name Description
constructor(def: ToolbarWidgetProps): ToolbarWidgetDefBase    
createCachedHorizontalItemList(toolbarId: string): void Protected    
createCachedVerticalItemList(toolbarId: string): void Protected    
createMergedItemList(originalItemList: ItemList | undefined, insertSpecs: ToolbarItemInsertSpec[]): ItemList Protected Create a Merged ItemList leaving the original ItemList untouched.  
generateMergedItemLists(): void    
getItemHierarchy(parentNode: UiItemNode, items: ItemDefBase[]): void Protected Build item hierarchy that will be passed to Plugins so they can add their UI button into toolboxes supported in ninezone widgets  
renderHorizontalToolbar(): React.ReactNode | null    
renderVerticalToolbar(): React.ReactNode | null    

Inherited methods

Name Inherited from Description
canOpen(): boolean WidgetDef  
getWidgetControl(type: ConfigurableUiControlType): WidgetControl | undefined WidgetDef  
setLabel(v: string | StringGetter): void WidgetDef Set the label.
setTooltip(v: string | StringGetter): void WidgetDef Set the tooltip.
setUpSyncSupport(props: WidgetProps): void WidgetDef  
setWidgetState(newState: WidgetState): void WidgetDef  
initializeFromWidgetProps(widgetProps: WidgetProps, me: WidgetDef): void Static WidgetDef  


Name Type Description
_cachedHorizontalItems Protected undefined | ItemList    
_cachedVerticalItems Protected undefined | ItemList    
horizontalDirection Direction    
horizontalItems undefined | ItemList    
horizontalPanelAlignment ToolbarPanelAlignment    
verticalDirection Direction    
verticalItems undefined | ItemList    
verticalPanelAlignment ToolbarPanelAlignment    
widgetBaseName Accessor string    

Inherited properties

Name Type Inherited from Description
activeState Accessor ReadOnly WidgetState WidgetDef  
applicationData undefined | any WidgetDef  
betaBadge undefined | false | true WidgetDef  
classId string | ConfigurableUiControlConstructor | undefined WidgetDef  
fillZone boolean WidgetDef  
iconSpec string | React.ReactNode WidgetDef  
id string WidgetDef  
isActive Accessor ReadOnly boolean WidgetDef  
isFloating boolean WidgetDef  
isFloatingStateSupported boolean WidgetDef  
isFloatingStateWindowResizable boolean WidgetDef  
isFreeform boolean WidgetDef  
isStatusBar boolean WidgetDef  
isToolSettings boolean WidgetDef  
isVisible Accessor ReadOnly boolean WidgetDef  
label Accessor ReadOnly string WidgetDef Get the label string
priority number WidgetDef  
reactElement Accessor React.ReactNode WidgetDef  
state WidgetState WidgetDef  
stateChanged boolean WidgetDef  
stateFunc undefined | (state: Readonly<WidgetState>) => WidgetState WidgetDef  
syncEventIds string[] WidgetDef  
tooltip Accessor ReadOnly string WidgetDef Get the tooltip string
widgetControl Accessor ReadOnly WidgetControl | undefined WidgetDef  
widgetType WidgetType WidgetDef  

Defined in

Last Updated: 20 September, 2019