Class: FioriToolbarProxy¶
FioriToolbarProxy is a developer-facing class that provides access to a fiori toolbar control for application specific customizations.
Hierarchy¶
-
FioriToolbarProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
Methods¶
Class Methods¶
- getDataSubscriptions
- getHelperText
- getItem
- getItems
- getOverflowIcon
- getVisible
- isContainer
- reset
- setDataSubscriptions
- setHelperText
- setOverflowIcon
- setVisible
Inherited Methods¶
Constructors¶
constructor¶
+ new FioriToolbarProxy(context: IContext): FioriToolbarProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
context |
IContext |
Returns: FioriToolbarProxy
Methods¶
getDataSubscriptions¶
▸ getDataSubscriptions(): string[]
Implementation of IFioriToolbarProxy
Returns the DataSubscriptions property value defined for the toolbar control.
Returns: string[]
getHelperText¶
▸ getHelperText(): string
Implementation of IFioriToolbarProxy
Returns the HelperText property value defined for the toolbar control.
Returns: string
getItem¶
▸ getItem(itemName: string): IFioriToolbarItemProxy
Implementation of IFioriToolbarProxy
Parameters:
| Name | Type | Description |
|---|---|---|
itemName |
string | takes in _Name property of the toolbar item |
Returns: IFioriToolbarItemProxy
returns the ToolbarItemProxy instance of the item by the name
getItems¶
▸ getItems(): IFioriToolbarItemProxy[]
Implementation of IFioriToolbarProxy
This method returns the top-level controls of Toolbar Items for this container
Returns: IFioriToolbarItemProxy[]
The toolbar items controls for this container
getOverflowIcon¶
▸ getOverflowIcon(): string
Implementation of IFioriToolbarProxy
Returns the Image property value defined for the control.
Returns: string
getVisible¶
▸ getVisible(): boolean
Implementation of IFioriToolbarProxy
Returns: boolean
true/false
isContainer¶
▸ isContainer(): boolean
Implementation of IFioriToolbarProxy
Overrides ControlProxy.isContainer
Determine if the toolbar control is a container.
Returns: boolean
true/false.
reset¶
▸ reset(): Promise‹any›
Implementation of IFioriToolbarProxy
Reset Toolbar and its items
Returns: Promise‹any›
setDataSubscriptions¶
▸ setDataSubscriptions(dataSubscriptions: string[]): void
Implementation of IFioriToolbarProxy
Sets the DataSubscriptions property of the toolbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
dataSubscriptions |
string[] | value to set. |
Returns: void
setHelperText¶
▸ setHelperText(helperText: string): void
Implementation of IFioriToolbarProxy
Sets the HelperText property of the toolbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
helperText |
string | value to set. |
Returns: void
setOverflowIcon¶
▸ setOverflowIcon(overflowIcon: string): void
Implementation of IFioriToolbarProxy
Sets the OverflowIcon property of the fiori toolbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
overflowIcon |
string | value to set. |
Returns: void
setVisible¶
▸ setVisible(value: boolean, redraw: boolean): this
Implementation of IFioriToolbarProxy
Overrides ControlProxy.setVisible
Sets the toolbar's visible state with / without redraw
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
value |
boolean | - | visible state |
redraw |
boolean | true | true if redraw after setting the visible state |
Returns: this