Class: PageProxy¶
Hierarchy¶
-
PageProxy
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¶
- _getExecuteSource
- executeCustomEvent
- getActionBinding
- getCaption
- getControl
- getControls
- getExecutedContextMenuItem
- getFilter
- getFioriToolbar
- getMissingRequiredControls
- getPageProxy
- getPressedItem
- getToolbar
- redraw
- setActionBarItemVisible
- setActionBinding
- setCaption
- setStyle
- setToolbarItemCaption
Inherited Methods¶
Constructors¶
constructor¶
+ new PageProxy(context
: IContext): PageProxy
Overrides ClientAPI.constructor
Parameters:
Name | Type |
---|---|
context |
IContext |
Returns: PageProxy
Methods¶
Protected
_getExecuteSource¶
▸ _getExecuteSource(): ExecuteSource
Overrides ClientAPI._getExecuteSource
Returns: ExecuteSource
executeCustomEvent¶
▸ executeCustomEvent(eventType
: string, eventData
: any): Promise‹void›
Implementation of IPageProxy
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: Promise‹void›
getActionBinding¶
▸ getActionBinding(): any
Implementation of IPageProxy
Returns: any
getCaption¶
▸ getCaption(): string
Implementation of IPageProxy
Returns: string
the caption of the page. If the caption is not defined, returns empty string
getControl¶
▸ getControl(name
: string): IControlProxy
Implementation of IPageProxy
Parameters:
Name | Type | Description |
---|---|---|
name |
string | the name of the control to match |
Returns: IControlProxy
getControls¶
▸ getControls(): IControlProxy[]
Implementation of IPageProxy
Returns: IControlProxy[]
getExecutedContextMenuItem¶
▸ getExecutedContextMenuItem(): ContextItem
Implementation of IPageProxy
Returns: ContextItem
getFilter¶
▸ getFilter(): IFilterable
Returns: IFilterable
getFioriToolbar¶
▸ getFioriToolbar(): IFioriToolbarProxy
Implementation of IPageProxy
Returns: IFioriToolbarProxy
return the FioriToolbarProxy instance of the associated fiori toolbar of that page
getMissingRequiredControls¶
▸ getMissingRequiredControls(): Object[]
Implementation of IPageProxy
Returns: Object[]
getPageProxy¶
▸ getPageProxy(): IPageProxy
Implementation of IPageProxy
Returns: IPageProxy
the Page self
getPressedItem¶
▸ getPressedItem(): PressedItem
Implementation of IPageProxy
Returns: PressedItem
getToolbar¶
▸ getToolbar(): IToolbarProxy
Implementation of IPageProxy
Returns: IToolbarProxy
return the ToolbarProxy instance of the associated toolbar of that page
redraw¶
▸ redraw(): void
Implementation of IPageProxy
Returns: void
setActionBarItemVisible¶
▸ setActionBarItemVisible(item
: any, visibleFlag
: boolean): void
Implementation of IPageProxy
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: void
setActionBinding¶
▸ setActionBinding(binding
: Object): this
Implementation of IPageProxy
Parameters:
Name | Type |
---|---|
binding |
Object |
Returns: this
setCaption¶
▸ setCaption(caption
: string): void
Implementation of IPageProxy
Parameters:
Name | Type | Description |
---|---|---|
caption |
string | the caption of the page |
Returns: void
setStyle¶
▸ setStyle(styleClass
: string, subControl
: string): this
Implementation of IPageProxy
Parameters:
Name | Type | Default | 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: this
this for chaining
See Styles/ docs for details.
setToolbarItemCaption¶
▸ setToolbarItemCaption(toolbarItemName
: string, newCaption
: string): Promise‹any›
Implementation of IPageProxy
Parameters:
Name | Type | Description |
---|---|---|
toolbarItemName |
string | the name of the item to modify caption |
newCaption |
string | the new caption |
Returns: Promise‹any›