Class sap.m.PageModule: sap/m/Page

extends Control

A container control that holds one whole screen of an application.

Overview

The sap.m.Page is a container control that holds one whole screen of an application. The page has three distinct areas that can hold content - a header, content area and a footer.

Structure

Header

The top most area of the page is occupied by the header. The standard header includes a navigation button and a title. Alternatively, you can create your own custom header, which is defined in the customHeader aggregation.

Content

The content occupies the main part of the page. Only the content area is scrollable by default. This can be prevented by setting enableScrolling to false.

Footer

The footer is optional and occupies the fixed bottom part of the page. Alternatively, the footer can be floating above the bottom part of the content. This is enabled with the floatingFooter property.

Note: All accessibility information for the different areas and their corresponding ARIA roles is set in the aggregation landmarkInfo of type sap.m.PageAccessibleLandmarkInfo

Constructor Summary
new sap.m.Page(sId?, mSettings?)Constructor for a new Page.
Event Summary
navButtonPress(oControlEvent)this event is fired when Nav Button is pressed
navButtonTap(oControlEvent)this event is fired when Nav Button is tapped
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.Page.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.Page with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.Page.getMetadata()Returns a metadata object for class sap.m.Page.
addContent(oContent)Adds some content to the aggregation content.
addHeaderContent(oHeaderContent)Adds some headerContent to the aggregation headerContent.
attachNavButtonPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the navButtonPress event of this sap.m.Page.
destroyContent()Destroys all the content in the aggregation content.
destroyCustomHeader()Destroys the customHeader in the aggregation customHeader.
destroyFooter()Destroys the footer in the aggregation footer.
destroyHeaderContent()Destroys all the headerContent in the aggregation headerContent.
destroyLandmarkInfo()Destroys the landmarkInfo in the aggregation landmarkInfo.
destroySubHeader()Destroys the subHeader in the aggregation subHeader.
detachNavButtonPress(fnFunction, oListener)Detaches event handler fnFunction from the navButtonPress event of this sap.m.Page.
fireNavButtonPress(mParameters?)Fires event navButtonPress to attached listeners.
getBackgroundDesign()Gets current value of property backgroundDesign.
getContent()Gets content of aggregation content.
getContentOnlyBusy()Gets current value of property contentOnlyBusy.
getCustomHeader()Gets content of aggregation customHeader.
getEnableScrolling()Gets current value of property enableScrolling.
getFloatingFooter()Gets current value of property floatingFooter.
getFooter()Gets content of aggregation footer.
getHeaderContent()Gets content of aggregation headerContent.
getLandmarkInfo()Gets content of aggregation landmarkInfo.
getNavButtonTooltip()Gets current value of property navButtonTooltip.
getShowFooter()Gets current value of property showFooter.
getShowHeader()Gets current value of property showHeader.
getShowNavButton()Gets current value of property showNavButton.
getShowSubHeader()Gets current value of property showSubHeader.
getSubHeader()Gets content of aggregation subHeader.
getTitle()Gets current value of property title.
getTitleLevel()Gets current value of property titleLevel.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
indexOfHeaderContent(oHeaderContent)Checks for the provided sap.ui.core.Control in the aggregation headerContent.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
insertHeaderContent(oHeaderContent, iIndex)Inserts a headerContent into the aggregation headerContent.
removeAllContent()Removes all the controls from the aggregation content.
removeAllHeaderContent()Removes all the controls from the aggregation headerContent.
removeContent(vContent)Removes a content from the aggregation content.
removeHeaderContent(vHeaderContent)Removes a headerContent from the aggregation headerContent.
scrollTo(y, time)Scrolls to the given position.
scrollToElement(oElement, iTime?)Scrolls to an element(DOM or sap.ui.core.Element) within the page if the element is rendered.
setBackgroundDesign(sBackgroundDesign)Sets a new value for property backgroundDesign.
setContentOnlyBusy(bContentOnlyBusy)Sets a new value for property contentOnlyBusy.
setEnableScrolling(bEnableScrolling)Sets a new value for property enableScrolling.
setFloatingFooter(bFloatingFooter)Sets a new value for property floatingFooter.
setFooter(oFooter)Sets the aggregated footer.
setLandmarkInfo(oLandmarkInfo)Sets the aggregated landmarkInfo.
setNavButtonTooltip(sNavButtonTooltip)Sets a new value for property navButtonTooltip.
setShowFooter(bShowFooter)Sets a new value for property showFooter.
setShowHeader(bShowHeader)Sets a new value for property showHeader.
setShowNavButton(bShowNavButton)Sets a new value for property showNavButton.
setShowSubHeader(bShowSubHeader)Sets a new value for property showSubHeader.
setSubHeader(oSubHeader)Sets the aggregated subHeader.
setTitle(sTitle)Sets a new value for property title.
setTitleLevel(sTitleLevel)Sets a new value for property titleLevel.
attachNavButtonTap(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the navButtonTap event of this sap.m.Page.
detachNavButtonTap(fnFunction, oListener)Detaches event handler fnFunction from the navButtonTap event of this sap.m.Page.
fireNavButtonTap(mParameters?)Fires event navButtonTap to attached listeners.
getIcon()Gets current value of property icon.
getNavButtonText()Gets current value of property navButtonText.
getNavButtonType()Gets current value of property navButtonType.
setIcon(sIcon)Sets a new value for property icon.
setNavButtonText(sNavButtonText)Sets a new value for property navButtonText.
setNavButtonType(sNavButtonType)Sets a new value for property navButtonType.
Constructor Detail
new sap.m.Page(sId?, mSettings?)

Constructor for a new Page.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Event Detail
navButtonPress(oControlEvent)
this event is fired when Nav Button is pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Since:
1.12.2
navButtonTap(oControlEvent)
this event is fired when Nav Button is tapped
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Deprecated API:
Since version 1.12.2. the navButtonPress event is replacing this event
Method Detail
sap.m.Page.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.Page with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.Page.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.Page.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addContent(oContent): sap.m.Page
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to add; if empty, nothing is inserted
Returns:
sap.m.PageReference to this in order to allow method chaining
addHeaderContent(oHeaderContent): sap.m.Page
Adds some headerContent to the aggregation headerContent.
Parameters:
sap.ui.core.ControloHeaderContentthe headerContent to add; if empty, nothing is inserted
Returns:
sap.m.PageReference to this in order to allow method chaining
attachNavButtonPress(oData?, fnFunction, oListener?): sap.m.Page

Attaches event handler fnFunction to the navButtonPress event of this sap.m.Page.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.Page itself.

this event is fired when Nav Button is pressed

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.Page itself
Returns:
sap.m.PageReference to this in order to allow method chaining
Since:
1.12.2
destroyContent(): sap.m.Page
Destroys all the content in the aggregation content.
Returns:
sap.m.PageReference to this in order to allow method chaining
destroyCustomHeader(): sap.m.Page
Destroys the customHeader in the aggregation customHeader.
Returns:
sap.m.PageReference to this in order to allow method chaining
destroyFooter(): sap.m.Page
Destroys the footer in the aggregation footer.
Returns:
sap.m.PageReference to this in order to allow method chaining
destroyHeaderContent(): sap.m.Page
Destroys all the headerContent in the aggregation headerContent.
Returns:
sap.m.PageReference to this in order to allow method chaining
destroyLandmarkInfo(): sap.m.Page
Destroys the landmarkInfo in the aggregation landmarkInfo.
Returns:
sap.m.PageReference to this in order to allow method chaining
destroySubHeader(): sap.m.Page
Destroys the subHeader in the aggregation subHeader.
Returns:
sap.m.PageReference to this in order to allow method chaining
detachNavButtonPress(fnFunction, oListener): sap.m.Page

Detaches event handler fnFunction from the navButtonPress event of this sap.m.Page.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.PageReference to this in order to allow method chaining
Since:
1.12.2
fireNavButtonPress(mParameters?): sap.m.Page
Fires event navButtonPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.PageReference to this in order to allow method chaining
Since:
1.12.2
getBackgroundDesign(): sap.m.PageBackgroundDesign

Gets current value of property backgroundDesign.

This property is used to set the background color of a page. When a list is placed inside a page, the value "List" should be used to display a gray background. "Standard", with the value white, is used as default if not specified.

Default value is Standard.

Returns:
sap.m.PageBackgroundDesignValue of property backgroundDesign
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The content of this page

Returns:
sap.ui.core.Control[]
getContentOnlyBusy(): boolean

Gets current value of property contentOnlyBusy.

Decides which area is covered by the local BusyIndicator when page.setBusy() is called. By default the entire page is covered, including headers and footer. When this property is set to "true", only the content area is covered (not header/sub header and footer), which is useful e.g. when there is a SearchField in the sub header and live search continuously updates the content area while the user is still able to type.

Default value is false.

Returns:
booleanValue of property contentOnlyBusy
Since:
1.29.0
getCustomHeader(): sap.m.IBar

Gets content of aggregation customHeader.

The (optional) custom header of this page. Use this aggregation only when a custom header is constructed where the default header consisting of title text + nav button is not sufficient. If this aggregation is set, the simple properties "title", "showNavButton", "NavButtonText" and "icon" are not used.

Returns:
sap.m.IBar
getEnableScrolling(): boolean

Gets current value of property enableScrolling.

Enable vertical scrolling of page contents. Page headers and footers are fixed and do not scroll. If set to false, there will be no scrolling at all.

The Page only allows vertical scrolling because horizontal scrolling is discouraged in general for full-page content. If it still needs to be achieved, disable the Page scrolling and use a ScrollContainer as full-page content of the Page. This allows you to freely configure scrolling. It can also be used to create horizontally-scrolling sub-areas of (vertically-scrolling) Pages.

Default value is true.

Returns:
booleanValue of property enableScrolling
getFloatingFooter(): boolean

Gets current value of property floatingFooter.

Decides whether the floating footer behavior should be enabled. When the floating footer behavior is used, the content is visible when it's underneath the footer.

Default value is false.

Returns:
booleanValue of property floatingFooter
getFooter(): sap.m.IBar

Gets content of aggregation footer.

The (optional) footer of this page. It is always located at the bottom of the page

Returns:
sap.m.IBar
getHeaderContent(): sap.ui.core.Control[]

Gets content of aggregation headerContent.

Controls to be added to the right side of the page header. Usually an application would use Button controls and limit the number to one when the application needs to run on smartphones. There is no automatic overflow handling when the space is insufficient. When a customHeader is used, this aggregation will be ignored.

Returns:
sap.ui.core.Control[]

Gets content of aggregation landmarkInfo.

Accessible landmark settings to be applied on the containers of the sap.m.Page control.

If not set, no landmarks will be written.

Returns:
sap.m.PageAccessibleLandmarkInfo
getNavButtonTooltip(): string

Gets current value of property navButtonTooltip.

The tooltip of the nav button

Since version 1.34

Returns:
stringValue of property navButtonTooltip
getShowFooter(): boolean

Gets current value of property showFooter.

Whether this page shall have a footer

Default value is true.

Returns:
booleanValue of property showFooter
Since:
1.13.1
getShowHeader(): boolean

Gets current value of property showHeader.

Whether this page shall have a header. If set to true, either the control under the "customHeader" aggregation is used, or if there is no such control, a Header control is constructed from the properties "title", "showNavButton", "navButtonText" and "icon" depending on the platform.

Default value is true.

Returns:
booleanValue of property showHeader
getShowNavButton(): boolean

Gets current value of property showNavButton.

A nav button will be rendered on the left area of header bar if this property is set to true.

Default value is false.

Returns:
booleanValue of property showNavButton
getShowSubHeader(): boolean

Gets current value of property showSubHeader.

Whether this page shall show the subheader.

Default value is true.

Returns:
booleanValue of property showSubHeader
Since:
1.28
getSubHeader(): sap.m.IBar

Gets content of aggregation subHeader.

a subHeader will be rendered directly under the header

Returns:
sap.m.IBar
getTitle(): string

Gets current value of property title.

The title text appearing in the page header bar.

Returns:
stringValue of property title
getTitleLevel(): sap.ui.core.TitleLevel

Gets current value of property titleLevel.

Defines the semantic level of the title. Using "Auto" no explicit level information is written. Used for accessibility purposes only.

Default value is Auto.

Returns:
sap.ui.core.TitleLevelValue of property titleLevel
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloContentThe content whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfHeaderContent(oHeaderContent): int
Checks for the provided sap.ui.core.Control in the aggregation headerContent. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloHeaderContentThe headerContent whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.m.Page
Inserts a content into the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
sap.m.PageReference to this in order to allow method chaining
insertHeaderContent(oHeaderContent, iIndex): sap.m.Page
Inserts a headerContent into the aggregation headerContent.
Parameters:
sap.ui.core.ControloHeaderContentthe headerContent to insert; if empty, nothing is inserted
intiIndexthe 0-based index the headerContent should be inserted at; for a negative value of iIndex, the headerContent is inserted at position 0; for a value greater than the current size of the aggregation, the headerContent is inserted at the last position
Returns:
sap.m.PageReference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAllHeaderContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation headerContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
int|string|sap.ui.core.ControlvContentThe content to remove or its index or id
Returns:
sap.ui.core.ControlThe removed content or null
removeHeaderContent(vHeaderContent): sap.ui.core.Control
Removes a headerContent from the aggregation headerContent.
Parameters:
int|string|sap.ui.core.ControlvHeaderContentThe headerContent to remove or its index or id
Returns:
sap.ui.core.ControlThe removed headerContent or null
scrollTo(y, time): sap.m.Page
Scrolls to the given position. Only available if enableScrolling is set to "true".
Parameters:
intyThe vertical pixel position to scroll to. Scrolling down happens with positive values.
inttimeThe duration of animated scrolling. To scroll immediately without animation, give 0 as value. 0 is also the default value, when this optional parameter is omitted.
Returns:
sap.m.Page
scrollToElement(oElement, iTime?): sap.m.Page
Scrolls to an element(DOM or sap.ui.core.Element) within the page if the element is rendered.
Parameters:
HTMLElement|sap.ui.core.ElementoElementThe element to which should be scrolled.
intiTime?, Default: 0The duration of animated scrolling. To scroll immediately without animation, give 0 as value or leave it default.
Returns:
sap.m.Pagethis to facilitate method chaining.
Since:
1.30
setBackgroundDesign(sBackgroundDesign): sap.m.Page

Sets a new value for property backgroundDesign.

This property is used to set the background color of a page. When a list is placed inside a page, the value "List" should be used to display a gray background. "Standard", with the value white, is used as default if not specified.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Standard.

Parameters:
sap.m.PageBackgroundDesignsBackgroundDesignNew value for property backgroundDesign
Returns:
sap.m.PageReference to this in order to allow method chaining
setContentOnlyBusy(bContentOnlyBusy): sap.m.Page

Sets a new value for property contentOnlyBusy.

Decides which area is covered by the local BusyIndicator when page.setBusy() is called. By default the entire page is covered, including headers and footer. When this property is set to "true", only the content area is covered (not header/sub header and footer), which is useful e.g. when there is a SearchField in the sub header and live search continuously updates the content area while the user is still able to type.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
booleanbContentOnlyBusyNew value for property contentOnlyBusy
Returns:
sap.m.PageReference to this in order to allow method chaining
Since:
1.29.0
setEnableScrolling(bEnableScrolling): sap.m.Page

Sets a new value for property enableScrolling.

Enable vertical scrolling of page contents. Page headers and footers are fixed and do not scroll. If set to false, there will be no scrolling at all.

The Page only allows vertical scrolling because horizontal scrolling is discouraged in general for full-page content. If it still needs to be achieved, disable the Page scrolling and use a ScrollContainer as full-page content of the Page. This allows you to freely configure scrolling. It can also be used to create horizontally-scrolling sub-areas of (vertically-scrolling) Pages.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbEnableScrollingNew value for property enableScrolling
Returns:
sap.m.PageReference to this in order to allow method chaining
setFloatingFooter(bFloatingFooter): sap.m.Page

Sets a new value for property floatingFooter.

Decides whether the floating footer behavior should be enabled. When the floating footer behavior is used, the content is visible when it's underneath the footer.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
booleanbFloatingFooterNew value for property floatingFooter
Returns:
sap.m.PageReference to this in order to allow method chaining
setFooter(oFooter): sap.m.Page
Sets the aggregated footer.
Parameters:
sap.m.IBaroFooterThe footer to set
Returns:
sap.m.PageReference to this in order to allow method chaining
setLandmarkInfo(oLandmarkInfo): sap.m.Page
Sets the aggregated landmarkInfo.
Parameters:
sap.m.PageAccessibleLandmarkInfooLandmarkInfoThe landmarkInfo to set
Returns:
sap.m.PageReference to this in order to allow method chaining
setNavButtonTooltip(sNavButtonTooltip): sap.m.Page

Sets a new value for property navButtonTooltip.

The tooltip of the nav button

Since version 1.34

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsNavButtonTooltipNew value for property navButtonTooltip
Returns:
sap.m.PageReference to this in order to allow method chaining
setShowFooter(bShowFooter): sap.m.Page

Sets a new value for property showFooter.

Whether this page shall have a footer

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbShowFooterNew value for property showFooter
Returns:
sap.m.PageReference to this in order to allow method chaining
Since:
1.13.1
setShowHeader(bShowHeader): sap.m.Page

Sets a new value for property showHeader.

Whether this page shall have a header. If set to true, either the control under the "customHeader" aggregation is used, or if there is no such control, a Header control is constructed from the properties "title", "showNavButton", "navButtonText" and "icon" depending on the platform.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbShowHeaderNew value for property showHeader
Returns:
sap.m.PageReference to this in order to allow method chaining
setShowNavButton(bShowNavButton): sap.m.Page

Sets a new value for property showNavButton.

A nav button will be rendered on the left area of header bar if this property is set to true.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
booleanbShowNavButtonNew value for property showNavButton
Returns:
sap.m.PageReference to this in order to allow method chaining
setShowSubHeader(bShowSubHeader): sap.m.Page

Sets a new value for property showSubHeader.

Whether this page shall show the subheader.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbShowSubHeaderNew value for property showSubHeader
Returns:
sap.m.PageReference to this in order to allow method chaining
Since:
1.28
setSubHeader(oSubHeader): sap.m.Page
Sets the aggregated subHeader.
Parameters:
sap.m.IBaroSubHeaderThe subHeader to set
Returns:
sap.m.PageReference to this in order to allow method chaining
setTitle(sTitle): sap.m.Page

Sets a new value for property title.

The title text appearing in the page header bar.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsTitleNew value for property title
Returns:
sap.m.PageReference to this in order to allow method chaining
setTitleLevel(sTitleLevel): sap.m.Page

Sets a new value for property titleLevel.

Defines the semantic level of the title. Using "Auto" no explicit level information is written. Used for accessibility purposes only.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Auto.

Parameters:
sap.ui.core.TitleLevelsTitleLevelNew value for property titleLevel
Returns:
sap.m.PageReference to this in order to allow method chaining
attachNavButtonTap(oData?, fnFunction, oListener?): sap.m.Page

Attaches event handler fnFunction to the navButtonTap event of this sap.m.Page.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.Page itself.

this event is fired when Nav Button is tapped

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.Page itself
Returns:
sap.m.PageReference to this in order to allow method chaining
Deprecated API:
Since version 1.12.2. the navButtonPress event is replacing this event
detachNavButtonTap(fnFunction, oListener): sap.m.Page

Detaches event handler fnFunction from the navButtonTap event of this sap.m.Page.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.PageReference to this in order to allow method chaining
Deprecated API:
Since version 1.12.2. the navButtonPress event is replacing this event
fireNavButtonTap(mParameters?): sap.m.Page
Fires event navButtonTap to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.PageReference to this in order to allow method chaining
Deprecated API:
Since version 1.12.2. the navButtonPress event is replacing this event
getIcon(): sap.ui.core.URI

Gets current value of property icon.

the icon that is rendered in the page header bar in non-iOS phone/tablet platforms. This property is theme-dependent and only has an effect in the MVI theme.

Returns:
sap.ui.core.URIValue of property icon
Deprecated API:
Since version 1.20. Deprecated since the MVI theme is removed now. This property only affected the NavButton in that theme.
getNavButtonText(): string

Gets current value of property navButtonText.

The text of the nav button when running in iOS (if shown) in case it deviates from the default, which is "Back". This property is mvi-theme-dependent and will not have any effect in other themes.

Returns:
stringValue of property navButtonText
Deprecated API:
Since version 1.20. Deprecated since the MVI theme is removed now. This property only affected the NavButton in that theme.
getNavButtonType(): sap.m.ButtonType

Gets current value of property navButtonType.

This property is used to set the appearance of the NavButton. By default when showNavButton is set to true, a back button will be shown in iOS and an up button in other platforms. In case you want to show a normal button in the left header area, you can set the value to "Default".

Default value is Back.

Returns:
sap.m.ButtonTypeValue of property navButtonType
Deprecated API:
Since version 1.20. Deprecated since the MVI theme is removed now. This property is only usable with a Button text in that theme.
Since:
1.12
setIcon(sIcon): sap.m.Page

Sets a new value for property icon.

the icon that is rendered in the page header bar in non-iOS phone/tablet platforms. This property is theme-dependent and only has an effect in the MVI theme.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
sap.ui.core.URIsIconNew value for property icon
Returns:
sap.m.PageReference to this in order to allow method chaining
Deprecated API:
Since version 1.20. Deprecated since the MVI theme is removed now. This property only affected the NavButton in that theme.
setNavButtonText(sNavButtonText): sap.m.Page

Sets a new value for property navButtonText.

The text of the nav button when running in iOS (if shown) in case it deviates from the default, which is "Back". This property is mvi-theme-dependent and will not have any effect in other themes.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsNavButtonTextNew value for property navButtonText
Returns:
sap.m.PageReference to this in order to allow method chaining
Deprecated API:
Since version 1.20. Deprecated since the MVI theme is removed now. This property only affected the NavButton in that theme.
setNavButtonType(sNavButtonType): sap.m.Page

Sets a new value for property navButtonType.

This property is used to set the appearance of the NavButton. By default when showNavButton is set to true, a back button will be shown in iOS and an up button in other platforms. In case you want to show a normal button in the left header area, you can set the value to "Default".

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Back.

Parameters:
sap.m.ButtonTypesNavButtonTypeNew value for property navButtonType
Returns:
sap.m.PageReference to this in order to allow method chaining
Deprecated API:
Since version 1.20. Deprecated since the MVI theme is removed now. This property is only usable with a Button text in that theme.
Since:
1.12