Class: ActionBarProxy¶
ActionBarProxy is a developer-facing class that provides access to an actionbar control for application specific customizations.
Hierarchy¶
-
ActionBarProxy
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¶
- getCaption
- getCaptionAlignment
- getDataSubscriptions
- getItem
- getItems
- getLogo
- getOverflowIcon
- getPrefersLargeCaption
- getStyle
- getSubhead
- isContainer
- reset
- setCaption
- setCaptionAlignment
- setDataSubscriptions
- setLogo
- setOverflowIcon
- setPrefersLargeCaption
- setSubhead
Inherited Methods¶
Constructors¶
constructor¶
+ new ActionBarProxy(context: IContext): ActionBarProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
context |
IContext |
Returns: ActionBarProxy
Methods¶
getCaption¶
▸ getCaption(): string
Implementation of IActionBarProxy
Overrides ControlProxy.getCaption
Returns the Caption property value defined for the actionbar control.
Returns: string
getCaptionAlignment¶
▸ getCaptionAlignment(): string
Implementation of IActionBarProxy
Android only. Returns the captionAlignment property value defined for the actionbar control.
Returns: string
getDataSubscriptions¶
▸ getDataSubscriptions(): string[]
Implementation of IActionBarProxy
Returns the DataSubscriptions property value defined for the actionbar control.
Returns: string[]
getItem¶
▸ getItem(itemName: string): IActionBarItemProxy
Implementation of IActionBarProxy
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[]
Implementation of IActionBarProxy
This method returns the top-level controls of Toolbar Items for this container
Returns: IActionBarItemProxy[]
The toolbar items controls for this container
getLogo¶
▸ getLogo(): string
Implementation of IActionBarProxy
Returns the Logo property value defined for the control.
Returns: string
getOverflowIcon¶
▸ getOverflowIcon(): string
Implementation of IActionBarProxy
iOS only. Returns the Image property value defined for the control.
Returns: string
getPrefersLargeCaption¶
▸ getPrefersLargeCaption(): boolean
Implementation of IActionBarProxy
Returns the prefersLargeCaption property value defined for the actionbar control.
Returns: boolean
getStyle¶
▸ getStyle(): any
Implementation of IActionBarProxy
Returns the style property value defined for the actionbar control.
Returns: any
getSubhead¶
▸ getSubhead(): string
Implementation of IActionBarProxy
Returns the Subhead property value defined for the actionbar control.
Returns: string
isContainer¶
▸ isContainer(): boolean
Implementation of IActionBarProxy
Overrides ControlProxy.isContainer
Determine if the toolbar control is a container.
Returns: boolean
true/false.
reset¶
▸ reset(): Promise‹any›
Implementation of IActionBarProxy
Reset ActionBar and its items
Returns: Promise‹any›
setCaption¶
▸ setCaption(caption: string): void
Implementation of IActionBarProxy
Sets the caption property of the actionbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
caption |
string | value to set. |
Returns: void
setCaptionAlignment¶
▸ setCaptionAlignment(captionAlignment: string): void
Implementation of IActionBarProxy
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
Implementation of IActionBarProxy
Sets the DataSubscriptions property of the actionbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
dataSubscriptions |
string[] | value to set. |
Returns: void
setLogo¶
▸ setLogo(logo: string): void
Implementation of IActionBarProxy
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
Implementation of IActionBarProxy
iOS only. Sets the OverflowIcon property of the fiori toolbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
overflowIcon |
string | value to set. |
Returns: void
setPrefersLargeCaption¶
▸ setPrefersLargeCaption(prefersLargeCaption: boolean): void
Implementation of IActionBarProxy
Sets the prefersLargeCaption property of the actionbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
prefersLargeCaption |
boolean | value to set. |
Returns: void
setSubhead¶
▸ setSubhead(subhead: string): void
Implementation of IActionBarProxy
Sets the subhead property of the actionbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
subhead |
string | value to set. |
Returns: void