Interface: IActionBarProxy

A designer-facing interface that provides access to a actionbar control.

It is passed to rules to provide access to a actionbar control for application specific customizations.

In addition it provides access to the IControlProxy interface.

Hierarchy

• IControlProxy

• IActionBarProxy

Implemented by

• ActionBarProxy

Summary

Properties

Class Properties

Currently none in this class.

Inherited Properties

• actionResults

• binding

• currentPage

• filterTypeEnum

Methods

Class Methods

• getCaption
• getCaptionAlignment
• getDataSubscriptions
• getItem
• getItems
• getLogo
• getOverflowIcon
• getPrefersLargeCaption
• getStyle
• getSubhead
• isContainer
• reset
• setCaption
• setCaptionAlignment
• setDataSubscriptions
• setLogo
• setOverflowIcon
• setPrefersLargeCaption
• setSubhead

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

• getAppEventData

• getAppName

• getAppearanceMode

• getAvailableThemes

• getBindingObject

• getCircularImage

• getClientData

• getDefinitionValue

• getGlobalDefinition

• getIconTextImage

• getLanguage

• getLogger

• getMobileServiceAppId

• getMobileServiceEndpointUrl

• getName

• getODataCacheImagePath

• getODataProvider

• getPageDefinition

• getPageProxy

• getPasscodeSource

• getPendingDownload

• getReadLink

• getRegion

• getRegions

• getSAPPassportHeaderValue

• getSupportedLanguages

• getTheme

• getType

• getValue

• getVersionInfo

• initializeLogger

• isAppInMultiUserMode

• isCurrentPage

• isDemoMode

• isMediaLocal

• localizeText

• read

• redraw

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setDebugSettings

• setEditable

• setLanguage

• setRegion

• setStyle

• setTheme

• setValidationProperty

• setValue

• setVisible

• showActivityIndicator

• updateProgressBanner

Methods

getCaption

▸ getCaption(): string

Overrides IControlProxy.getCaption

Returns the Caption property value defined for the actionbar control.

Returns: string

---

getCaptionAlignment

▸ getCaptionAlignment(): string

Android only. Returns the captionAlignment property value defined for the actionbar control.

Returns: string

---

getDataSubscriptions

▸ getDataSubscriptions(): string[]

Returns the DataSubscriptions property value defined for the toolbar control.

Returns: string[]

---

getItem

▸ getItem(itemName: string): IActionBarItemProxy

Parameters:

Name	Type	Description
itemName	string	takes in _Name property of the actionbar item

Returns: IActionBarItemProxy

returns the ActionBarItemProxy instance of the item by the name

---

getItems

▸ getItems(): IActionBarItemProxy[]

This method returns the top-level controls of ActionBar Items for this container

Returns: IActionBarItemProxy[]

The actionbar items controls for this container

---

getLogo

▸ getLogo(): string

Returns the Logo property value defined for the control.

Returns: string

---

getOverflowIcon

▸ getOverflowIcon(): string

iOS only. Returns the Image property value defined for the control.

Returns: string

---

getPrefersLargeCaption

▸ getPrefersLargeCaption(): boolean

Returns the prefersLargeCaption property value defined for the actionbar control.

Returns: boolean

---

getStyle

▸ getStyle(): any

Returns the style property value defined for the actionbar control.

Returns: any

---

getSubhead

▸ getSubhead(): string

Returns the Subhead property value defined for the actionbar control.

Returns: string

---

isContainer

▸ isContainer(): boolean

Overrides IControlProxy.isContainer

Determine if the actionbar control is a container.

Returns: boolean

true/false.

---

reset

▸ reset(): Promise‹any›

Reset ActionBar and its items

Returns: Promise‹any›

---

setCaption

▸ setCaption(caption: string): void

Sets the caption property of the actionbar control.

Parameters:

Name	Type	Description
caption	string	value to set.

Returns: void

---

setCaptionAlignment

▸ setCaptionAlignment(captionAlignment: string): void

Android only. Sets the captionAlignment property of the actionbar control. Accepted values are: "Left", "Center".

Parameters:

Name	Type	Description
captionAlignment	string	value to set.

Returns: void

---

setDataSubscriptions

▸ setDataSubscriptions(dataSubscriptions: string[]): void

Sets the DataSubscriptions property of the toolbar control.

Parameters:

Name	Type	Description
dataSubscriptions	string[]	value to set.

Returns: void

---

setLogo

▸ setLogo(logo: string): void

Sets the logo property of the fiori toolbar control.

Parameters:

Name	Type	Description
logo	string	value to set.

Returns: void

---

setOverflowIcon

▸ setOverflowIcon(overflowIcon: string): void

iOS only. Sets the OverflowIcon property of the fiori actionbar control.

Parameters:

Name	Type	Description
overflowIcon	string	value to set.

Returns: void

---

setPrefersLargeCaption

▸ setPrefersLargeCaption(prefersLargeCaption: boolean): void

Sets the prefersLargeCaption property of the actionbar control.

Parameters:

Name	Type	Description
prefersLargeCaption	boolean	value to set.

Returns: void

---

setSubhead

▸ setSubhead(subhead: string): void

Sets the subhead property of the actionbar control.

Parameters:

Name	Type	Description
subhead	string	value to set.

Returns: void

---