Interface: IPageProxy¶
Hierarchy¶
-
IPageProxy
Implemented by¶
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Methods¶
Class Methods¶
- executeCustomEvent
- getActionBinding
- getExecutedContextMenuItem
- getFioriToolbar
- getGlobalSideDrawerControlProxy
- getMissingRequiredControls
- getPageProxy
- getPressedItem
- getToolbar
- redraw
- setActionBarItemVisible
- setActionBinding
- setCaption
- setStyle
- setToolbarItemCaption
Inherited Methods¶
Methods¶
executeCustomEvent¶
▸ executeCustomEvent(eventType: string, eventData: any): any
Parameters:
| Name | Type | Description |
|---|---|---|
eventType |
string | can be used to describe the current event. |
eventData |
any | Data that is passed to the associated rule. |
Returns: any
getActionBinding¶
▸ getActionBinding(): any
Returns: any
getExecutedContextMenuItem¶
▸ getExecutedContextMenuItem(): ContextItem
Returns: ContextItem
getFioriToolbar¶
▸ getFioriToolbar(): IFioriToolbarProxy
Returns: IFioriToolbarProxy
return the ToolbarProxy instance of the associated toolbar of that page
getGlobalSideDrawerControlProxy¶
▸ getGlobalSideDrawerControlProxy(): ISideDrawerControlProxy
Returns: ISideDrawerControlProxy
getMissingRequiredControls¶
▸ getMissingRequiredControls(): Object[]
Returns: Object[]
getPageProxy¶
▸ getPageProxy(): IPageProxy
Returns: IPageProxy
the Page self
getPressedItem¶
▸ getPressedItem(): PressedItem
Returns: PressedItem
getToolbar¶
▸ getToolbar(): IToolbarProxy
Returns: IToolbarProxy
return the ToolbarProxy instance of the associated toolbar of that page
redraw¶
▸ redraw(): any
Returns: any
setActionBarItemVisible¶
▸ setActionBarItemVisible(item: any, visibleFlag: boolean): any
Parameters:
| Name | Type | Description |
|---|---|---|
item |
any | either an number or a string the number is the position of the item.(zero based, first item on actionBar is 0 and second is 1 etc.) the string is the _Name parameter of the action item |
visibleFlag |
boolean | if true set item to visible else hidden. |
Returns: any
setActionBinding¶
▸ setActionBinding(binding: Object): any
Parameters:
| Name | Type |
|---|---|
binding |
Object |
Returns: any
setCaption¶
▸ setCaption(caption: string): any
Parameters:
| Name | Type | Description |
|---|---|---|
caption |
string | new caption value |
Returns: any
setStyle¶
▸ setStyle(styleClass: string, subControl: string): any
Parameters:
| Name | Type | Description |
|---|---|---|
styleClass |
string | The name of the style class to be applied |
subControl |
string | The name of the control to apply the style to. It could be either 'ActionBar' or 'ToolBar'. If this is '', the style is applied to the entire page. |
Returns: any
this for chaining
See Styles/ docs for details.
setToolbarItemCaption¶
▸ setToolbarItemCaption(toolbarItemName: string, newCaption: string): Promise‹any›
Parameters:
| Name | Type | Description |
|---|---|---|
toolbarItemName |
string | the name of the item to modify caption |
newCaption |
string | the new caption |
Returns: Promise‹any›