Interface: IFioriToolbarProxy¶
A designer-facing interface that provides access to a toolbar control.
It is passed to rules to provide access to a toolbar control for application specific customizations.
In addition it provides access to the IControlProxy interface.
Hierarchy¶
-
IFioriToolbarProxy
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Methods¶
Class Methods¶
- getDataSubscriptions
- getHelperText
- getItem
- getItems
- getOverflowIcon
- getVisible
- isContainer
- reset
- setDataSubscriptions
- setHelperText
- setOverflowIcon
- setVisible
Inherited Methods¶
- applyValidation
- base64StringToBinary
- binaryToBase64String
- callFunction
- clearValidation
- clearValidationOnValueChange
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createFilterCriteria
- createLinkSpecifierProxy
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getValue
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCrashReportingEnabled
- isCurrentCrashConsentAllowed
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setEditable
- setLanguage
- setRegion
- setStyle
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- showCrashConsentDialog
- updateProgressBanner
Methods¶
getDataSubscriptions¶
▸ getDataSubscriptions(): string[]
Returns the DataSubscriptions property value defined for the toolbar control.
Returns: string[]
getHelperText¶
▸ getHelperText(): string
Returns the HelperText property value defined for the toolbar control.
Returns: string
getItem¶
▸ getItem(itemName: string): IFioriToolbarItemProxy
Parameters:
| Name | Type | Description |
|---|---|---|
| itemName | string | takes in _Name property of the toolbar item |
Returns: IFioriToolbarItemProxy
returns the FioriToolbarItemProxy instance of the item by the name
getItems¶
▸ getItems(): IFioriToolbarItemProxy[]
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
Returns the Image property value defined for the control.
Returns: string
getVisible¶
▸ getVisible(): boolean
Returns: boolean
true/false
isContainer¶
▸ isContainer(): boolean
Determine if the toolbar control is a container.
Overrides IControlProxy.isContainer
Returns: boolean
true/false.
reset¶
▸ reset(): Promise<any>
Reset FioriToolbar and its items
Returns: Promise<any>
setDataSubscriptions¶
▸ setDataSubscriptions(dataSubscriptions: string[]): void
Sets the DataSubscriptions property of the toolbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
| dataSubscriptions | string[] | value to set. |
Returns: void
setHelperText¶
▸ setHelperText(helperText: string): void
Sets the HelperText property of the toolbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
| helperText | string | value to set. |
Returns: void
setOverflowIcon¶
▸ setOverflowIcon(overflowIcon: string): void
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 = true): any
Sets the toolbar's visible state with / without redraw
Overrides IControlProxy.setVisible
Parameters:
| Name | Type | Description |
|---|---|---|
| value | boolean | visible state |
| redraw? | boolean = true | true if redraw after setting the visible state |
Returns: any