class sap.uxap.ObjectPageLayout

Control sample: sap.uxap.ObjectPageLayout
Visiblity: public
UX Guidelines: Object Page Layout
Implements:
Available since: N/A
Module: sap/uxap/ObjectPageLayout
Application Component: CA-UI5-CTR

A layout that allows apps to easily display information related to a business object.

Overview

The ObjectPageLayout layout is composed of a header (title and content), an optional anchor bar and block content wrapped in sections and subsections that structure the information.

Structure

An ObjectPageLayout control is used to put together all parts of an Object page - Header, optional Anchor Bar and Sections/Subsections.

Header

The ObjectPageLayout implements the snapping header concept. This means that the upper part of the header (Header Title) always stays visible, while the lower part (Header Content) can scroll out of view.

Header Title is displayed at the top of the header and always remains visible above the scrollable content of the page. It contains the title and most prominent details of the object.

The Header Content scrolls along with the content of the page until it disappears (collapsed header). When scrolled back to the top it becomes visible again (expanded header). It contains all the additional information of the object.

Anchor Bar

The Anchor Bar is an automatically generated internal menu that shows the titles of the sections and subsections and allows the user to scroll to the respective section and subsection content.

Sections, Subsections, Blocks

The content of the page that appears bellow the header is composed of blocks structured into sections and subsections.

Usage

Use the ObjectPageLayout if:

Responsive behavior

The ObjectPageLayout is responsive and adapts to all screen sizes.

Documentation links:

This control can be a drop target.

Constructor

Constructor for a new ObjectPageLayout.

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

new sap.uxap.ObjectPageLayout(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
alwaysShowContentHeader boolean false

Determines whether Header Content will always be expanded on desktop.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Since: 1.34.0.

Visibility: public
backgroundDesignAnchorBar sap.m.BackgroundDesign

Determines the background color of the AnchorBar.

Note: The default value of backgroundDesignAnchorBar property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

Since: 1.58.

Visibility: public
enableLazyLoading boolean false

Enable lazy loading for the Object page Subsections.

Visibility: public
flexEnabled boolean false

Specifies whether the object page enables flexibility features, such as hiding and adding sections.
For more information about SAPUI5 flexibility, refer to the Developer Guide.

Since: 1.34.0.

Visibility: public
headerContentPinnable boolean true

Determines whether the Header Content area can be pinned.

When set to true, a pin button is displayed within the Header Content area. The pin button allows the user to make the Header Content always visible at the top of the page above any scrollable content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

Since: 1.52.

Visibility: public
headerContentPinned boolean false

Determines whether the sap.uxap.ObjectPageDynamicHeaderContent is pinned.

The property can be changed explicitly with its setter or in the occurrence of the following user interactions:

  • Toggling the pin/unpin button of sap.uxap.ObjectPageDynamicHeaderContent
  • Snapping the sap.uxap.ObjectPageDynamicHeaderContent by explicitly clicking on the sap.uxap.ObjectPageDynamicHeaderTitle

Note: The property will only apply if the following rules are currently in use:

  • An instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.
  • The headerContentPinnable property is true
  • The sap.uxap.ObjectPageDynamicHeaderContent is expanded
  • The preserveHeaderStateOnScroll property or the rules for it to work are false


Since: 1.93.

Visibility: public
height sap.ui.core.CSSSize 100%

Determines the height of the ObjectPage.

Visibility: public
isChildPage boolean false

Determines whether the page is a child page and renders it with a different design. Child pages have an additional (darker/lighter) stripe on the left side of their header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Since: 1.34.0.

Visibility: public
preserveHeaderStateOnScroll boolean false

Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.

Notes:

  • This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.
  • Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the control`s title and header are with height larger than the given threshold.


Since: 1.52.

Visibility: public
sectionTitleLevel sap.ui.core.TitleLevel Auto

Determines the ARIA level of the ObjectPageSection and ObjectPageSubSection titles. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note:

  • Defining a sectionTitleLevel will add aria-level attribute from 1 to 6 instead of changing the titles` HTML tag from H1 to H6.
    For example: if sectionTitleLevel is TitleLevel.H1, it will result as aria-level of 1 added to the ObjectPageSection title.
  • The ObjectPageSubSection title would have aria-level one level lower than the defined. For example: if sectionTitleLevel is TitleLevel.H1, it will result as aria-level of 2 added to the ObjectPageSubSection title.
  • It is possible to define a titleLevel on ObjectPageSection or ObjectPageSubSection level. In this case the value of this property will be ignored.


Since: 1.44.0.

Visibility: public
showAnchorBar boolean true

Determines whether the Navigation bar (Anchor bar) is displayed.

Visibility: public
showAnchorBarPopover boolean true

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

Visibility: public
showEditHeaderButton boolean false

Determines whether an Edit button will be displayed in Header Content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Since: 1.34.0.

Visibility: public
showFooter boolean false

Determines whether the footer is visible.

Since: 1.40.

Visibility: public
showHeaderContent boolean true

Determines the visibility of the Header content (headerContent aggregation).

Visibility: public
showOnlyHighImportance boolean false

Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.

Since: 1.32.0.

Visibility: public
showTitleInHeaderContent boolean false

Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Visibility: public
subSectionLayout sap.uxap.ObjectPageSubSectionLayout TitleOnTop

Determines whether Subsection titles are displayed on top or to the left of the Subsection content.

Visibility: public
toggleHeaderOnTitleClick boolean true

Determines whether the user can switch between the expanded/collapsed states of the sap.uxap.ObjectPageDynamicHeaderContent by clicking on the sap.uxap.ObjectPageDynamicHeaderTitle. If set to false, the sap.uxap.ObjectPageDynamicHeaderTitle is not clickable and the application must provide other means for expanding/collapsing the sap.uxap.ObjectPageDynamicHeaderContent, if necessary.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

Since: 1.52.

Visibility: public
upperCaseAnchorBar boolean true

Determines whether the Anchor bar items are displayed in upper case.

Visibility: public
useIconTabBar boolean false

Determines whether the navigation mode is tab-based instead of the default anchor bar. If enabled, the sections are displayed separately on each tab rather than having all of them visible at the same time.

Note: Keep in mind that the sap.m.IconTabBar control is no longer used for the tab navigation mode.

Visibility: public
useTwoColumnsForLargeScreen boolean false

Determines whether the to use two column layout for the L screen size.

Visibility: public

Aggregations

Default Aggregation: sections

Name Cardinality Type Description
_anchorBar 0..1 sap.uxap.AnchorBar

Internal aggregation to hold the reference to the AnchorBar.

_customScrollBar 0..1 sap.ui.core.Control
_headerContent 0..1 sap.uxap.IHeaderContent

Internal aggregation to hold the reference to the IHeaderContent implementation.

_iconTabBar 0..1 sap.m.IconTabBar

Internal aggregation to hold the reference to the IconTabBar.

footer 0..1 sap.m.IBar

Object page floating footer.

Since: 1.40.

headerContent 0..n sap.ui.core.Control

Object page header content - the dynamic part of the Object page header.

headerTitle 0..1 sap.uxap.IHeaderTitle

Object page header title - the upper, always static, part of the Object page header.

landmarkInfo 0..1 sap.uxap.ObjectPageAccessibleLandmarkInfo

Accessible landmark settings to be applied on the containers of the sap.uxap.ObjectPageLayout control.

If not set, no landmarks will be written.

Since: 1.61.

sections (default) 0..n sap.uxap.ObjectPageSection

The sections that make up the Object page content area.


Associations

Name Cardinality Type Description
selectedSection 0..1 sap.uxap.ObjectPageSection

The section that is selected by default on load.

Since: 1.44.0.


Events Overview

Event Description
editHeaderButtonPress

The event is fired when the Edit Header button is pressed

headerContentPinnedStateChange

The event is fired when the headerContentPinned property is changed via user interaction.

Since: 1.93.

navigate

The event is fired when the selected section is changed using the navigation.

Since: 1.40.

sectionChange

Fired when the current section is changed by scrolling.

Since: 1.73.

subSectionVisibilityChange

Fired when the visibility of subsections is changed.

Since: 1.77.

toggleAnchorBar

The event is fired when the Anchor bar is switched from moving to fixed or the other way round.

editHeaderButtonPress

The event is fired when the Edit Header button is pressed

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

headerContentPinnedStateChange

The event is fired when the headerContentPinned property is changed via user interaction.

Since: 1.93.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
pinned boolean

False or True values indicate the new pinned property value.

navigate

The event is fired when the selected section is changed using the navigation.

Since: 1.40.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
section sap.uxap.ObjectPageSection

The selected section object.

subSection sap.uxap.ObjectPageSubSection

The selected subsection object.

sectionChange

Fired when the current section is changed by scrolling.

Since: 1.73.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
section sap.uxap.ObjectPageSection

The section which the layout is scrolled to.

subSection sap.uxap.ObjectPageSubSection

The subsection which the layout is scrolled to.

subSectionVisibilityChange

Fired when the visibility of subsections is changed.

Since: 1.77.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
visibleSubSections object

Object whose keys are the visible SubSection IDs and their values are the SubSection instances

toggleAnchorBar

The event is fired when the Anchor bar is switched from moving to fixed or the other way round.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
fixed boolean

False indicates that the Anchor bar has just detached from the Header and became part of the scrolling area. True means that the Anchor bar has just snapped to the Header.


Methods Overview

Method Description
_resumeScroll

Un-sets the flag that deactivates scrolling requested with the sap.uxap.ObjectPageLayout.prototype._scrollTo function This flag is used by RTA for the purpose of postponing/resuming the auto-scrolling of the ObjectPage to its selected section so that the scrolling does not start before RTA operation fully completed

_suppressScroll

Sets a flag to [temporarily] deactivate any scrolling requested with the sap.uxap.ObjectPageLayout.prototype._scrollTo function This flag is used by RTA for the purpose of postponing the auto-scrolling of the ObjectPage to its selected section so that the scrolling does not start before RTA operation fully completed

_triggerVisibleSubSectionsEvents

Resets the internal information of which subsections are in view and immediately calls the layout calculation so that an event subSectionEnteredViewPort is fired for the subsections that are actually in view. Use this method after a change in bindings to the existing object, since it's layout might have changed and the app needs to react to the new subsections in view.

addHeaderContent

Adds some headerContent to the aggregation headerContent.

addSection

Adds some section to the aggregation sections.

attachEditHeaderButtonPress

Attaches event handler fnFunction to the editHeaderButtonPress event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the Edit Header button is pressed

attachHeaderContentPinnedStateChange

Attaches event handler fnFunction to the headerContentPinnedStateChange event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the headerContentPinned property is changed via user interaction.

attachNavigate

Attaches event handler fnFunction to the navigate event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the selected section is changed using the navigation.

attachSectionChange

Attaches event handler fnFunction to the sectionChange event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

Fired when the current section is changed by scrolling.

attachSubSectionVisibilityChange

Attaches event handler fnFunction to the subSectionVisibilityChange event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

Fired when the visibility of subsections is changed.

attachToggleAnchorBar

Attaches event handler fnFunction to the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the Anchor bar is switched from moving to fixed or the other way round.

destroyFooter

Destroys the footer in the aggregation footer.

destroyHeaderContent

Destroys all the headerContent in the aggregation headerContent.

destroyHeaderTitle

Destroys the headerTitle in the aggregation headerTitle.

destroyLandmarkInfo

Destroys the landmarkInfo in the aggregation landmarkInfo.

destroySections

Destroys all the sections in the aggregation sections.

detachEditHeaderButtonPress

Detaches event handler fnFunction from the editHeaderButtonPress event of this sap.uxap.ObjectPageLayout.

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

detachHeaderContentPinnedStateChange

Detaches event handler fnFunction from the headerContentPinnedStateChange event of this sap.uxap.ObjectPageLayout.

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

detachNavigate

Detaches event handler fnFunction from the navigate event of this sap.uxap.ObjectPageLayout.

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

detachSectionChange

Detaches event handler fnFunction from the sectionChange event of this sap.uxap.ObjectPageLayout.

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

detachSubSectionVisibilityChange

Detaches event handler fnFunction from the subSectionVisibilityChange event of this sap.uxap.ObjectPageLayout.

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

detachToggleAnchorBar

Detaches event handler fnFunction from the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.

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

sap.uxap.ObjectPageLayout.extend

Creates a new subclass of class sap.uxap.ObjectPageLayout 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.

fireEditHeaderButtonPress

Fires event editHeaderButtonPress to attached listeners.

fireHeaderContentPinnedStateChange

Fires event headerContentPinnedStateChange to attached listeners.

fireNavigate

Fires event navigate to attached listeners.

fireSectionChange

Fires event sectionChange to attached listeners.

fireSubSectionVisibilityChange

Fires event subSectionVisibilityChange to attached listeners.

fireToggleAnchorBar

Fires event toggleAnchorBar to attached listeners.

getAlwaysShowContentHeader

Gets current value of property alwaysShowContentHeader.

Determines whether Header Content will always be expanded on desktop.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getBackgroundDesignAnchorBar

Gets current value of property backgroundDesignAnchorBar.

Determines the background color of the AnchorBar.

Note: The default value of backgroundDesignAnchorBar property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

getEnableLazyLoading

Gets current value of property enableLazyLoading.

Enable lazy loading for the Object page Subsections.

Default value is false.

getFlexEnabled

Gets current value of property flexEnabled.

Specifies whether the object page enables flexibility features, such as hiding and adding sections.
For more information about SAPUI5 flexibility, refer to the Developer Guide.

Default value is false.

getFooter

Gets content of aggregation footer.

Object page floating footer.

getHeaderContent

Gets content of aggregation headerContent.

Object page header content - the dynamic part of the Object page header.

getHeaderContentPinnable

Gets current value of property headerContentPinnable.

Determines whether the Header Content area can be pinned.

When set to true, a pin button is displayed within the Header Content area. The pin button allows the user to make the Header Content always visible at the top of the page above any scrollable content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

Default value is true.

getHeaderContentPinned

Gets current value of property headerContentPinned.

Determines whether the sap.uxap.ObjectPageDynamicHeaderContent is pinned.

The property can be changed explicitly with its setter or in the occurrence of the following user interactions:

  • Toggling the pin/unpin button of sap.uxap.ObjectPageDynamicHeaderContent
  • Snapping the sap.uxap.ObjectPageDynamicHeaderContent by explicitly clicking on the sap.uxap.ObjectPageDynamicHeaderTitle

Note: The property will only apply if the following rules are currently in use:

  • An instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.
  • The headerContentPinnable property is true
  • The sap.uxap.ObjectPageDynamicHeaderContent is expanded
  • The preserveHeaderStateOnScroll property or the rules for it to work are false

Default value is false.

getHeaderTitle

Gets content of aggregation headerTitle.

Object page header title - the upper, always static, part of the Object page header.

getHeight

Gets current value of property height.

Determines the height of the ObjectPage.

Default value is "100%".

getIsChildPage

Gets current value of property isChildPage.

Determines whether the page is a child page and renders it with a different design. Child pages have an additional (darker/lighter) stripe on the left side of their header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getLandmarkInfo

Gets content of aggregation landmarkInfo.

Accessible landmark settings to be applied on the containers of the sap.uxap.ObjectPageLayout control.

If not set, no landmarks will be written.

sap.uxap.ObjectPageLayout.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageLayout.

getPreserveHeaderStateOnScroll

Gets current value of property preserveHeaderStateOnScroll.

Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.

Notes:

  • This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.
  • Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the control`s title and header are with height larger than the given threshold.

Default value is false.

getScrollDelegate

Returns the sap.ui.core.ScrollEnablement delegate which is used with this control.

getScrollingSectionId

Returns the UI5 ID of the Section that is currently being scrolled.

getSections

Gets content of aggregation sections.

The sections that make up the Object page content area.

getSectionTitleLevel

Gets current value of property sectionTitleLevel.

Determines the ARIA level of the ObjectPageSection and ObjectPageSubSection titles. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note:

  • Defining a sectionTitleLevel will add aria-level attribute from 1 to 6 instead of changing the titles` HTML tag from H1 to H6.
    For example: if sectionTitleLevel is TitleLevel.H1, it will result as aria-level of 1 added to the ObjectPageSection title.
  • The ObjectPageSubSection title would have aria-level one level lower than the defined. For example: if sectionTitleLevel is TitleLevel.H1, it will result as aria-level of 2 added to the ObjectPageSubSection title.
  • It is possible to define a titleLevel on ObjectPageSection or ObjectPageSubSection level. In this case the value of this property will be ignored.

Default value is Auto.

getSelectedSection

ID of the element which is the current target of the association selectedSection, or null.

getShowAnchorBar

Gets current value of property showAnchorBar.

Determines whether the Navigation bar (Anchor bar) is displayed.

Default value is true.

getShowAnchorBarPopover

Gets current value of property showAnchorBarPopover.

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

Default value is true.

getShowEditHeaderButton

Gets current value of property showEditHeaderButton.

Determines whether an Edit button will be displayed in Header Content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getShowFooter

Gets current value of property showFooter.

Determines whether the footer is visible.

Default value is false.

getShowHeaderContent

Gets current value of property showHeaderContent.

Determines the visibility of the Header content (headerContent aggregation).

Default value is true.

getShowOnlyHighImportance

Gets current value of property showOnlyHighImportance.

Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.

Default value is false.

getShowTitleInHeaderContent

Gets current value of property showTitleInHeaderContent.

Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getSubSectionLayout

Gets current value of property subSectionLayout.

Determines whether Subsection titles are displayed on top or to the left of the Subsection content.

Default value is TitleOnTop.

getToggleHeaderOnTitleClick

Gets current value of property toggleHeaderOnTitleClick.

Determines whether the user can switch between the expanded/collapsed states of the sap.uxap.ObjectPageDynamicHeaderContent by clicking on the sap.uxap.ObjectPageDynamicHeaderTitle. If set to false, the sap.uxap.ObjectPageDynamicHeaderTitle is not clickable and the application must provide other means for expanding/collapsing the sap.uxap.ObjectPageDynamicHeaderContent, if necessary.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

Default value is true.

getUpperCaseAnchorBar

Gets current value of property upperCaseAnchorBar.

Determines whether the Anchor bar items are displayed in upper case.

Default value is true.

getUseIconTabBar

Gets current value of property useIconTabBar.

Determines whether the navigation mode is tab-based instead of the default anchor bar. If enabled, the sections are displayed separately on each tab rather than having all of them visible at the same time.

Note: Keep in mind that the sap.m.IconTabBar control is no longer used for the tab navigation mode.

Default value is false.

getUseTwoColumnsForLargeScreen

Gets current value of property useTwoColumnsForLargeScreen.

Determines whether the to use two column layout for the L screen size.

Default value is false.

indexOfHeaderContent

Checks for the provided sap.ui.core.Control in the aggregation headerContent. and returns its index if found or -1 otherwise.

indexOfSection

Checks for the provided sap.uxap.ObjectPageSection in the aggregation sections. and returns its index if found or -1 otherwise.

insertHeaderContent

Inserts a headerContent into the aggregation headerContent.

insertSection

Inserts a section into the aggregation sections.

invalidate

This triggers rerendering of itself and its children.

removeAllHeaderContent

Removes all the controls from the aggregation headerContent.

Additionally, it unregisters them from the hosting UIArea.

removeAllSections

Removes all the controls from the aggregation sections.

Additionally, it unregisters them from the hosting UIArea.

removeHeaderContent

Removes a headerContent from the aggregation headerContent.

removeSection

Removes a section from the aggregation sections.

scrollToSection

Scrolls the Object page to the given Section.

setAlwaysShowContentHeader

Sets a new value for property alwaysShowContentHeader.

Determines whether Header Content will always be expanded on desktop.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

setBackgroundDesignAnchorBar

Sets the value of the backgroundDesignAnchorBar property.

setEnableLazyLoading

Sets a new value for property enableLazyLoading.

Enable lazy loading for the Object page Subsections.

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

Default value is false.

setFlexEnabled

Sets a new value for property flexEnabled.

Specifies whether the object page enables flexibility features, such as hiding and adding sections.
For more information about SAPUI5 flexibility, refer to the Developer Guide.

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

Default value is false.

setFooter

Sets the aggregated footer.

setHeaderContentPinnable

Sets a new value for property headerContentPinnable.

Determines whether the Header Content area can be pinned.

When set to true, a pin button is displayed within the Header Content area. The pin button allows the user to make the Header Content always visible at the top of the page above any scrollable content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

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

Default value is true.

setHeaderContentPinned

Sets a new value for property headerContentPinned.

Determines whether the sap.uxap.ObjectPageDynamicHeaderContent is pinned.

The property can be changed explicitly with its setter or in the occurrence of the following user interactions:

  • Toggling the pin/unpin button of sap.uxap.ObjectPageDynamicHeaderContent
  • Snapping the sap.uxap.ObjectPageDynamicHeaderContent by explicitly clicking on the sap.uxap.ObjectPageDynamicHeaderTitle

Note: The property will only apply if the following rules are currently in use:

  • An instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.
  • The headerContentPinnable property is true
  • The sap.uxap.ObjectPageDynamicHeaderContent is expanded
  • The preserveHeaderStateOnScroll property or the rules for it to work are false

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

Default value is false.

setHeaderTitle

Sets the aggregated headerTitle.

setHeight

Sets a new value for property height.

Determines the height of the ObjectPage.

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

Default value is "100%".

setIsChildPage

Sets a new value for property isChildPage.

Determines whether the page is a child page and renders it with a different design. Child pages have an additional (darker/lighter) stripe on the left side of their header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

setLandmarkInfo

Sets the aggregated landmarkInfo.

setPreserveHeaderStateOnScroll

Sets a new value for property preserveHeaderStateOnScroll.

Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.

Notes:

  • This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.
  • Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the control`s title and header are with height larger than the given threshold.

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

Default value is false.

setSectionTitleLevel

Sets a new value for property sectionTitleLevel.

Determines the ARIA level of the ObjectPageSection and ObjectPageSubSection titles. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note:

  • Defining a sectionTitleLevel will add aria-level attribute from 1 to 6 instead of changing the titles` HTML tag from H1 to H6.
    For example: if sectionTitleLevel is TitleLevel.H1, it will result as aria-level of 1 added to the ObjectPageSection title.
  • The ObjectPageSubSection title would have aria-level one level lower than the defined. For example: if sectionTitleLevel is TitleLevel.H1, it will result as aria-level of 2 added to the ObjectPageSubSection title.
  • It is possible to define a titleLevel on ObjectPageSection or ObjectPageSubSection level. In this case the value of this property will be ignored.

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

Default value is Auto.

setSelectedSection

Sets the section that should be selected.

The section can either be given by itself or by its id.

Note that an argument of null will cause the first visible section be set as selectedSection. This is because the sap.uxap.ObjectPageLayout should always have one of its sections selected (unless it has 0 visible sections).

setShowAnchorBar

Sets a new value for property showAnchorBar.

Determines whether the Navigation bar (Anchor bar) is displayed.

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

Default value is true.

setShowAnchorBarPopover

Sets a new value for property showAnchorBarPopover.

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

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

Default value is true.

setShowEditHeaderButton

Sets a new value for property showEditHeaderButton.

Determines whether an Edit button will be displayed in Header Content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

setShowFooter

Sets a new value for property showFooter.

Determines whether the footer is visible.

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

Default value is false.

setShowHeaderContent

Sets a new value for property showHeaderContent.

Determines the visibility of the Header content (headerContent aggregation).

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

Default value is true.

setShowOnlyHighImportance

Sets a new value for property showOnlyHighImportance.

Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.

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

Default value is false.

setShowTitleInHeaderContent

Sets a new value for property showTitleInHeaderContent.

Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

setSubSectionLayout

Sets a new value for property subSectionLayout.

Determines whether Subsection titles are displayed on top or to the left of the Subsection content.

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

Default value is TitleOnTop.

setToggleHeaderOnTitleClick

Sets a new value for property toggleHeaderOnTitleClick.

Determines whether the user can switch between the expanded/collapsed states of the sap.uxap.ObjectPageDynamicHeaderContent by clicking on the sap.uxap.ObjectPageDynamicHeaderTitle. If set to false, the sap.uxap.ObjectPageDynamicHeaderTitle is not clickable and the application must provide other means for expanding/collapsing the sap.uxap.ObjectPageDynamicHeaderContent, if necessary.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

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

Default value is true.

setUpperCaseAnchorBar

Sets a new value for property upperCaseAnchorBar.

Determines whether the Anchor bar items are displayed in upper case.

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

Default value is true.

setUseIconTabBar

Sets a new value for property useIconTabBar.

Determines whether the navigation mode is tab-based instead of the default anchor bar. If enabled, the sections are displayed separately on each tab rather than having all of them visible at the same time.

Note: Keep in mind that the sap.m.IconTabBar control is no longer used for the tab navigation mode.

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

Default value is false.

setUseTwoColumnsForLargeScreen

Sets a new value for property useTwoColumnsForLargeScreen.

Determines whether the to use two column layout for the L screen size.

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

Default value is false.

_resumeScroll

Un-sets the flag that deactivates scrolling requested with the sap.uxap.ObjectPageLayout.prototype._scrollTo function This flag is used by RTA for the purpose of postponing/resuming the auto-scrolling of the ObjectPage to its selected section so that the scrolling does not start before RTA operation fully completed

_suppressScroll

Sets a flag to [temporarily] deactivate any scrolling requested with the sap.uxap.ObjectPageLayout.prototype._scrollTo function This flag is used by RTA for the purpose of postponing the auto-scrolling of the ObjectPage to its selected section so that the scrolling does not start before RTA operation fully completed

_triggerVisibleSubSectionsEvents

Resets the internal information of which subsections are in view and immediately calls the layout calculation so that an event subSectionEnteredViewPort is fired for the subsections that are actually in view. Use this method after a change in bindings to the existing object, since it's layout might have changed and the app needs to react to the new subsections in view.

addHeaderContent

Adds some headerContent to the aggregation headerContent.

Param Type DefaultValue Description
oHeaderContent sap.ui.core.Control

The headerContent to add; if empty, nothing is inserted

addSection

Adds some section to the aggregation sections.

Param Type DefaultValue Description
oSection sap.uxap.ObjectPageSection

The section to add; if empty, nothing is inserted

attachEditHeaderButtonPress

Attaches event handler fnFunction to the editHeaderButtonPress event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the Edit Header button is pressed

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout itself

attachHeaderContentPinnedStateChange

Attaches event handler fnFunction to the headerContentPinnedStateChange event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the headerContentPinned property is changed via user interaction.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout itself

attachNavigate

Attaches event handler fnFunction to the navigate event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the selected section is changed using the navigation.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout itself

attachSectionChange

Attaches event handler fnFunction to the sectionChange event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

Fired when the current section is changed by scrolling.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout itself

attachSubSectionVisibilityChange

Attaches event handler fnFunction to the subSectionVisibilityChange event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

Fired when the visibility of subsections is changed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout itself

attachToggleAnchorBar

Attaches event handler fnFunction to the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.

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.uxap.ObjectPageLayout itself.

The event is fired when the Anchor bar is switched from moving to fixed or the other way round.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageLayout itself

destroyFooter

Destroys the footer in the aggregation footer.

destroyHeaderContent

Destroys all the headerContent in the aggregation headerContent.

destroyHeaderTitle

Destroys the headerTitle in the aggregation headerTitle.

destroyLandmarkInfo

Destroys the landmarkInfo in the aggregation landmarkInfo.

destroySections

Destroys all the sections in the aggregation sections.

detachEditHeaderButtonPress

Detaches event handler fnFunction from the editHeaderButtonPress event of this sap.uxap.ObjectPageLayout.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachHeaderContentPinnedStateChange

Detaches event handler fnFunction from the headerContentPinnedStateChange event of this sap.uxap.ObjectPageLayout.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachNavigate

Detaches event handler fnFunction from the navigate event of this sap.uxap.ObjectPageLayout.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSectionChange

Detaches event handler fnFunction from the sectionChange event of this sap.uxap.ObjectPageLayout.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSubSectionVisibilityChange

Detaches event handler fnFunction from the subSectionVisibilityChange event of this sap.uxap.ObjectPageLayout.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachToggleAnchorBar

Detaches event handler fnFunction from the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.uxap.ObjectPageLayout.extend

Creates a new subclass of class sap.uxap.ObjectPageLayout 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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireEditHeaderButtonPress

Fires event editHeaderButtonPress to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireHeaderContentPinnedStateChange

Fires event headerContentPinnedStateChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

pinned boolean

False or True values indicate the new pinned property value.

fireNavigate

Fires event navigate to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

section sap.uxap.ObjectPageSection

The selected section object.

subSection sap.uxap.ObjectPageSubSection

The selected subsection object.

fireSectionChange

Fires event sectionChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

section sap.uxap.ObjectPageSection

The section which the layout is scrolled to.

subSection sap.uxap.ObjectPageSubSection

The subsection which the layout is scrolled to.

fireSubSectionVisibilityChange

Fires event subSectionVisibilityChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

visibleSubSections object

Object whose keys are the visible SubSection IDs and their values are the SubSection instances

fireToggleAnchorBar

Fires event toggleAnchorBar to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fixed boolean

False indicates that the Anchor bar has just detached from the Header and became part of the scrolling area. True means that the Anchor bar has just snapped to the Header.

getAlwaysShowContentHeader

Gets current value of property alwaysShowContentHeader.

Determines whether Header Content will always be expanded on desktop.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getBackgroundDesignAnchorBar

Gets current value of property backgroundDesignAnchorBar.

Determines the background color of the AnchorBar.

Note: The default value of backgroundDesignAnchorBar property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

getEnableLazyLoading

Gets current value of property enableLazyLoading.

Enable lazy loading for the Object page Subsections.

Default value is false.

getFlexEnabled

Gets current value of property flexEnabled.

Specifies whether the object page enables flexibility features, such as hiding and adding sections.
For more information about SAPUI5 flexibility, refer to the Developer Guide.

Default value is false.

getFooter

Gets content of aggregation footer.

Object page floating footer.

getHeaderContent

Gets content of aggregation headerContent.

Object page header content - the dynamic part of the Object page header.

getHeaderContentPinnable

Gets current value of property headerContentPinnable.

Determines whether the Header Content area can be pinned.

When set to true, a pin button is displayed within the Header Content area. The pin button allows the user to make the Header Content always visible at the top of the page above any scrollable content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

Default value is true.

getHeaderContentPinned

Gets current value of property headerContentPinned.

Determines whether the sap.uxap.ObjectPageDynamicHeaderContent is pinned.

The property can be changed explicitly with its setter or in the occurrence of the following user interactions:

Note: The property will only apply if the following rules are currently in use:

Default value is false.

getHeaderTitle

Gets content of aggregation headerTitle.

Object page header title - the upper, always static, part of the Object page header.

getHeight

Gets current value of property height.

Determines the height of the ObjectPage.

Default value is "100%".

getIsChildPage

Gets current value of property isChildPage.

Determines whether the page is a child page and renders it with a different design. Child pages have an additional (darker/lighter) stripe on the left side of their header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getLandmarkInfo

Gets content of aggregation landmarkInfo.

Accessible landmark settings to be applied on the containers of the sap.uxap.ObjectPageLayout control.

If not set, no landmarks will be written.

sap.uxap.ObjectPageLayout.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageLayout.

getPreserveHeaderStateOnScroll

Gets current value of property preserveHeaderStateOnScroll.

Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.

Notes:

Default value is false.

getScrollDelegate

Returns the sap.ui.core.ScrollEnablement delegate which is used with this control.

getScrollingSectionId

Returns the UI5 ID of the Section that is currently being scrolled.

getSections

Gets content of aggregation sections.

The sections that make up the Object page content area.

getSectionTitleLevel

Gets current value of property sectionTitleLevel.

Determines the ARIA level of the ObjectPageSection and ObjectPageSubSection titles. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note:

Default value is Auto.

getSelectedSection

ID of the element which is the current target of the association selectedSection, or null.

getShowAnchorBar

Gets current value of property showAnchorBar.

Determines whether the Navigation bar (Anchor bar) is displayed.

Default value is true.

getShowAnchorBarPopover

Gets current value of property showAnchorBarPopover.

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

Default value is true.

getShowEditHeaderButton

Gets current value of property showEditHeaderButton.

Determines whether an Edit button will be displayed in Header Content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getShowFooter

Gets current value of property showFooter.

Determines whether the footer is visible.

Default value is false.

getShowHeaderContent

Gets current value of property showHeaderContent.

Determines the visibility of the Header content (headerContent aggregation).

Default value is true.

getShowOnlyHighImportance

Gets current value of property showOnlyHighImportance.

Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.

Default value is false.

getShowTitleInHeaderContent

Gets current value of property showTitleInHeaderContent.

Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

Default value is false.

getSubSectionLayout

Gets current value of property subSectionLayout.

Determines whether Subsection titles are displayed on top or to the left of the Subsection content.

Default value is TitleOnTop.

getToggleHeaderOnTitleClick

Gets current value of property toggleHeaderOnTitleClick.

Determines whether the user can switch between the expanded/collapsed states of the sap.uxap.ObjectPageDynamicHeaderContent by clicking on the sap.uxap.ObjectPageDynamicHeaderTitle. If set to false, the sap.uxap.ObjectPageDynamicHeaderTitle is not clickable and the application must provide other means for expanding/collapsing the sap.uxap.ObjectPageDynamicHeaderContent, if necessary.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

Default value is true.

getUpperCaseAnchorBar

Gets current value of property upperCaseAnchorBar.

Determines whether the Anchor bar items are displayed in upper case.

Default value is true.

getUseIconTabBar

Gets current value of property useIconTabBar.

Determines whether the navigation mode is tab-based instead of the default anchor bar. If enabled, the sections are displayed separately on each tab rather than having all of them visible at the same time.

Note: Keep in mind that the sap.m.IconTabBar control is no longer used for the tab navigation mode.

Default value is false.

getUseTwoColumnsForLargeScreen

Gets current value of property useTwoColumnsForLargeScreen.

Determines whether the to use two column layout for the L screen size.

Default value is false.

indexOfHeaderContent

Checks for the provided sap.ui.core.Control in the aggregation headerContent. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oHeaderContent sap.ui.core.Control

The headerContent whose index is looked for

indexOfSection

Checks for the provided sap.uxap.ObjectPageSection in the aggregation sections. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oSection sap.uxap.ObjectPageSection

The section whose index is looked for

insertHeaderContent

Inserts a headerContent into the aggregation headerContent.

Param Type DefaultValue Description
oHeaderContent sap.ui.core.Control

The headerContent to insert; if empty, nothing is inserted

iIndex int

The 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

insertSection

Inserts a section into the aggregation sections.

Param Type DefaultValue Description
oSection sap.uxap.ObjectPageSection

The section to insert; if empty, nothing is inserted

iIndex int

The 0-based index the section should be inserted at; for a negative value of iIndex, the section is inserted at position 0; for a value greater than the current size of the aggregation, the section is inserted at the last position

invalidate

This triggers rerendering of itself and its children.

Param Type DefaultValue Description
oOrigin sap.ui.base.ManagedObject

Child control for which the method was called
If the child is an instance of sap.uxap.ObjectPageSection that corresponds to an inactive tab, the invalidation will be suppressed (in iconTabBar mode)

removeAllHeaderContent

Removes all the controls from the aggregation headerContent.

Additionally, it unregisters them from the hosting UIArea.

removeAllSections

Removes all the controls from the aggregation sections.

Additionally, it unregisters them from the hosting UIArea.

removeHeaderContent

Removes a headerContent from the aggregation headerContent.

Param Type DefaultValue Description
vHeaderContent int string sap.ui.core.Control

The headerContent to remove or its index or id

removeSection

Removes a section from the aggregation sections.

Param Type DefaultValue Description
vSection int string sap.uxap.ObjectPageSection

The section to remove or its index or id

scrollToSection

Scrolls the Object page to the given Section.

Param Type DefaultValue Description
sId string

The Section ID to scroll to

iDuration int 0

Scroll duration (in ms)

iOffset int 0

Additional pixels to scroll

setAlwaysShowContentHeader

Sets a new value for property alwaysShowContentHeader.

Determines whether Header Content will always be expanded on desktop.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

Param Type DefaultValue Description
bAlwaysShowContentHeader boolean false

New value for property alwaysShowContentHeader

setBackgroundDesignAnchorBar

Sets the value of the backgroundDesignAnchorBar property.

Param Type DefaultValue Description
sBackgroundDesignAnchorBar sap.m.BackgroundDesign

new value of the backgroundDesignAnchorBar

setEnableLazyLoading

Sets a new value for property enableLazyLoading.

Enable lazy loading for the Object page Subsections.

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

Default value is false.

Param Type DefaultValue Description
bEnableLazyLoading boolean false

New value for property enableLazyLoading

setFlexEnabled

Sets a new value for property flexEnabled.

Specifies whether the object page enables flexibility features, such as hiding and adding sections.
For more information about SAPUI5 flexibility, refer to the Developer Guide.

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

Default value is false.

Param Type DefaultValue Description
bFlexEnabled boolean false

New value for property flexEnabled

setFooter

Sets the aggregated footer.

Param Type DefaultValue Description
oFooter sap.m.IBar

The footer to set

setHeaderContentPinnable

Sets a new value for property headerContentPinnable.

Determines whether the Header Content area can be pinned.

When set to true, a pin button is displayed within the Header Content area. The pin button allows the user to make the Header Content always visible at the top of the page above any scrollable content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

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

Default value is true.

Param Type DefaultValue Description
bHeaderContentPinnable boolean true

New value for property headerContentPinnable

setHeaderContentPinned

Sets a new value for property headerContentPinned.

Determines whether the sap.uxap.ObjectPageDynamicHeaderContent is pinned.

The property can be changed explicitly with its setter or in the occurrence of the following user interactions:

Note: The property will only apply if the following rules are currently in use:

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

Default value is false.

Param Type DefaultValue Description
bHeaderContentPinned boolean false

New value for property headerContentPinned

setHeaderTitle

Sets the aggregated headerTitle.

Param Type DefaultValue Description
oHeaderTitle sap.uxap.IHeaderTitle

The headerTitle to set

setHeight

Sets a new value for property height.

Determines the height of the ObjectPage.

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

Default value is "100%".

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize "100%"

New value for property height

setIsChildPage

Sets a new value for property isChildPage.

Determines whether the page is a child page and renders it with a different design. Child pages have an additional (darker/lighter) stripe on the left side of their header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

Param Type DefaultValue Description
bIsChildPage boolean false

New value for property isChildPage

setLandmarkInfo

Sets the aggregated landmarkInfo.

Param Type DefaultValue Description
oLandmarkInfo sap.uxap.ObjectPageAccessibleLandmarkInfo

The landmarkInfo to set

setPreserveHeaderStateOnScroll

Sets a new value for property preserveHeaderStateOnScroll.

Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.

Notes:

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

Default value is false.

Param Type DefaultValue Description
bPreserveHeaderStateOnScroll boolean false

New value for property preserveHeaderStateOnScroll

setSectionTitleLevel

Sets a new value for property sectionTitleLevel.

Determines the ARIA level of the ObjectPageSection and ObjectPageSubSection titles. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note:

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

Default value is Auto.

Param Type DefaultValue Description
sSectionTitleLevel sap.ui.core.TitleLevel Auto

New value for property sectionTitleLevel

setSelectedSection

Sets the section that should be selected.

The section can either be given by itself or by its id.

Note that an argument of null will cause the first visible section be set as selectedSection. This is because the sap.uxap.ObjectPageLayout should always have one of its sections selected (unless it has 0 visible sections).

Param Type DefaultValue Description
sId string sap.uxap.ObjectPageSection

The ID or the section instance that should be selected Note that null or undefined are not valid arguments

setShowAnchorBar

Sets a new value for property showAnchorBar.

Determines whether the Navigation bar (Anchor bar) is displayed.

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

Default value is true.

Param Type DefaultValue Description
bShowAnchorBar boolean true

New value for property showAnchorBar

setShowAnchorBarPopover

Sets a new value for property showAnchorBarPopover.

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

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

Default value is true.

Param Type DefaultValue Description
bShowAnchorBarPopover boolean true

New value for property showAnchorBarPopover

setShowEditHeaderButton

Sets a new value for property showEditHeaderButton.

Determines whether an Edit button will be displayed in Header Content.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

Param Type DefaultValue Description
bShowEditHeaderButton boolean false

New value for property showEditHeaderButton

setShowFooter

Sets a new value for property showFooter.

Determines whether the footer is visible.

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

Default value is false.

Param Type DefaultValue Description
bShowFooter boolean false

New value for property showFooter

setShowHeaderContent

Sets a new value for property showHeaderContent.

Determines the visibility of the Header content (headerContent aggregation).

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

Default value is true.

Param Type DefaultValue Description
bShowHeaderContent boolean true

New value for property showHeaderContent

setShowOnlyHighImportance

Sets a new value for property showOnlyHighImportance.

Determines whether sections and subsections with importance Low and Medium are hidden even on large screens.

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

Default value is false.

Param Type DefaultValue Description
bShowOnlyHighImportance boolean false

New value for property showOnlyHighImportance

setShowTitleInHeaderContent

Sets a new value for property showTitleInHeaderContent.

Determines whether the title, image, markers and selectTitleArrow are shown in the Header content area.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageHeader is used for the headerTitle aggregation.

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

Default value is false.

Param Type DefaultValue Description
bShowTitleInHeaderContent boolean false

New value for property showTitleInHeaderContent

setSubSectionLayout

Sets a new value for property subSectionLayout.

Determines whether Subsection titles are displayed on top or to the left of the Subsection content.

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

Default value is TitleOnTop.

Param Type DefaultValue Description
sSubSectionLayout sap.uxap.ObjectPageSubSectionLayout TitleOnTop

New value for property subSectionLayout

setToggleHeaderOnTitleClick

Sets a new value for property toggleHeaderOnTitleClick.

Determines whether the user can switch between the expanded/collapsed states of the sap.uxap.ObjectPageDynamicHeaderContent by clicking on the sap.uxap.ObjectPageDynamicHeaderTitle. If set to false, the sap.uxap.ObjectPageDynamicHeaderTitle is not clickable and the application must provide other means for expanding/collapsing the sap.uxap.ObjectPageDynamicHeaderContent, if necessary.

Note: This property is only taken into account if an instance of sap.uxap.ObjectPageDynamicHeaderTitle is used for the headerTitle aggregation.

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

Default value is true.

Param Type DefaultValue Description
bToggleHeaderOnTitleClick boolean true

New value for property toggleHeaderOnTitleClick

setUpperCaseAnchorBar

Sets a new value for property upperCaseAnchorBar.

Determines whether the Anchor bar items are displayed in upper case.

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

Default value is true.

Param Type DefaultValue Description
bUpperCaseAnchorBar boolean true

New value for property upperCaseAnchorBar

setUseIconTabBar

Sets a new value for property useIconTabBar.

Determines whether the navigation mode is tab-based instead of the default anchor bar. If enabled, the sections are displayed separately on each tab rather than having all of them visible at the same time.

Note: Keep in mind that the sap.m.IconTabBar control is no longer used for the tab navigation mode.

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

Default value is false.

Param Type DefaultValue Description
bUseIconTabBar boolean false

New value for property useIconTabBar

setUseTwoColumnsForLargeScreen

Sets a new value for property useTwoColumnsForLargeScreen.

Determines whether the to use two column layout for the L screen size.

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

Default value is false.

Param Type DefaultValue Description
bUseTwoColumnsForLargeScreen boolean false

New value for property useTwoColumnsForLargeScreen