Class sap.uxap.ObjectPageLayoutModule: sap/uxap/ObjectPageLayout

extends Control

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:

  • The users need to see, edit, or create an item with all its details.
  • Users need to get an overview of an object and interact with different parts of the object.

Responsive behavior

The ObjectPageLayout is responsive and adapts to all screen sizes.


Since: 1.26.
Constructor Summary
new sap.uxap.ObjectPageLayout(sId?, mSettings?)Constructor for a new ObjectPageLayout.
Event Summary
editHeaderButtonPress(oControlEvent)The event is fired when the Edit Header button is pressed
navigate(oControlEvent)The event is fired when the selected section is changed using the navigation.
toggleAnchorBar(oControlEvent)The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.uxap.ObjectPageLayout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageLayout with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageLayout.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageLayout.
addHeaderContent(oHeaderContent)Adds some headerContent to the aggregation headerContent.
addSection(oSection)Adds some section to the aggregation sections.
attachEditHeaderButtonPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the editHeaderButtonPress event of this sap.uxap.ObjectPageLayout.
attachNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the navigate event of this sap.uxap.ObjectPageLayout.
attachToggleAnchorBar(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.
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.
destroySections()Destroys all the sections in the aggregation sections.
detachEditHeaderButtonPress(fnFunction, oListener)Detaches event handler fnFunction from the editHeaderButtonPress event of this sap.uxap.ObjectPageLayout.
detachNavigate(fnFunction, oListener)Detaches event handler fnFunction from the navigate event of this sap.uxap.ObjectPageLayout.
detachToggleAnchorBar(fnFunction, oListener)Detaches event handler fnFunction from the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.
fireEditHeaderButtonPress(mParameters?)Fires event editHeaderButtonPress to attached listeners.
fireNavigate(mParameters?)Fires event navigate to attached listeners.
fireToggleAnchorBar(mParameters?)Fires event toggleAnchorBar to attached listeners.
getAlwaysShowContentHeader()Gets current value of property alwaysShowContentHeader.
getEnableLazyLoading()Gets current value of property enableLazyLoading.
getFlexEnabled()Gets current value of property flexEnabled.
getFooter()Gets content of aggregation footer.
getHeaderContent()Gets content of aggregation headerContent.
getHeaderContentPinnable()Gets current value of property headerContentPinnable.
getHeaderTitle()Gets content of aggregation headerTitle.
getHeight()Gets current value of property height.
getIsChildPage()Gets current value of property isChildPage.
getScrollDelegate()Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling
getScrollingSectionId()Returns the UI5 ID of the Section that is currently being scrolled.
getSections()Gets content of aggregation sections.
getSectionTitleLevel()Gets current value of property sectionTitleLevel.
getSelectedSection()ID of the element which is the current target of the association selectedSection, or null.
getShowAnchorBar()Gets current value of property showAnchorBar.
getShowAnchorBarPopover()Gets current value of property showAnchorBarPopover.
getShowEditHeaderButton()Gets current value of property showEditHeaderButton.
getShowFooter()Gets current value of property showFooter.
getShowHeaderContent()Gets current value of property showHeaderContent.
getShowOnlyHighImportance()Gets current value of property showOnlyHighImportance.
getShowTitleInHeaderContent()Gets current value of property showTitleInHeaderContent.
getSubSectionLayout()Gets current value of property subSectionLayout.
getToggleHeaderOnTitleClick()Gets current value of property toggleHeaderOnTitleClick.
getUpperCaseAnchorBar()Gets current value of property upperCaseAnchorBar.
getUseIconTabBar()Gets current value of property useIconTabBar.
indexOfHeaderContent(oHeaderContent)Checks for the provided sap.ui.core.Control in the aggregation headerContent.
indexOfSection(oSection)Checks for the provided sap.uxap.ObjectPageSection in the aggregation sections.
insertHeaderContent(oHeaderContent, iIndex)Inserts a headerContent into the aggregation headerContent.
insertSection(oSection, iIndex)Inserts a section into the aggregation sections.
invalidate(oOrigin?)This triggers rerendering of itself and its children.
removeAllHeaderContent()Removes all the controls from the aggregation headerContent.
removeAllSections()Removes all the controls from the aggregation sections.
removeHeaderContent(vHeaderContent)Removes a headerContent from the aggregation headerContent.
removeSection(vSection)Removes a section from the aggregation sections.
scrollToSection(sId, iDuration, iOffset)Scrolls the Object page to the given Section.
setAlwaysShowContentHeader(bAlwaysShowContentHeader)Sets a new value for property alwaysShowContentHeader.
setEnableLazyLoading(bEnableLazyLoading)Sets a new value for property enableLazyLoading.
setFlexEnabled(bFlexEnabled)Sets a new value for property flexEnabled.
setFooter(oFooter)Sets the aggregated footer.
setHeaderContentPinnable(bHeaderContentPinnable)Sets a new value for property headerContentPinnable.
setHeaderTitle(oHeaderTitle)Sets the aggregated headerTitle.
setHeight(sHeight)Sets a new value for property height.
setIsChildPage(bIsChildPage)Sets a new value for property isChildPage.
setPreserveHeaderStateOnScroll(bPreserveHeaderStateOnScroll)Sets a new value for property preserveHeaderStateOnScroll.
setSectionTitleLevel(sSectionTitleLevel)Sets a new value for property sectionTitleLevel.
setSelectedSection(vSectionBase)Sets the section that should be selected.
setShowAnchorBar(bShowAnchorBar)Sets a new value for property showAnchorBar.
setShowAnchorBarPopover(bShowAnchorBarPopover)Sets a new value for property showAnchorBarPopover.
setShowEditHeaderButton(bShowEditHeaderButton)Sets a new value for property showEditHeaderButton.
setShowFooter(bShowFooter)Sets a new value for property showFooter.
setShowHeaderContent(bShowHeaderContent)Sets a new value for property showHeaderContent.
setShowOnlyHighImportance(bShowOnlyHighImportance)Sets a new value for property showOnlyHighImportance.
setShowTitleInHeaderContent(bShowTitleInHeaderContent)Sets a new value for property showTitleInHeaderContent.
setSubSectionLayout(sSubSectionLayout)Sets a new value for property subSectionLayout.
setToggleHeaderOnTitleClick(bToggleHeaderOnTitleClick)Sets a new value for property toggleHeaderOnTitleClick.
setUpperCaseAnchorBar(bUpperCaseAnchorBar)Sets a new value for property upperCaseAnchorBar.
setUseIconTabBar(bUseIconTabBar)Sets a new value for property useIconTabBar.
setUseTwoColumnsForLargeScreen(bUseTwoColumnsForLargeScreen)Sets a new value for property useTwoColumnsForLargeScreen.
Constructor Detail
new sap.uxap.ObjectPageLayout(sId?, mSettings?)

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 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
See:
{@link topic:2e61ab6c68a2480eb666c1927a707658 Object Page Layout}
{@link topic:d2ef0099542d44dc868719d908e576d0 Object Page Headers}
{@link topic:370b67986497463187336fa130aebbf1 Anchor Bar}
{@link topic:4527729576cb4a4888275b6935aad03a Object Page Blocks}
{@link topic:2978f6064742456ebed31c5ccf4d051d Creating Blocks}
{@link topic:bc410e94e46540efa02857e15aae583f Object Page Scrolling}
Event Detail
editHeaderButtonPress(oControlEvent)
The event is fired when the Edit Header button is pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
navigate(oControlEvent)
The event is fired when the selected section is changed using the navigation.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.uxap.ObjectPageSectionoControlEvent.getParameters.sectionThe selected section object.
sap.uxap.ObjectPageSubSectionoControlEvent.getParameters.subSectionThe selected subsection object.
Since:
1.40
toggleAnchorBar(oControlEvent)
The event is fired when the Anchor bar is switched from moving to fixed or the other way round.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
booleanoControlEvent.getParameters.fixedFalse 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.
Method Detail
sap.uxap.ObjectPageLayout.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.uxap.ObjectPageLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageLayout.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addHeaderContent(oHeaderContent): sap.uxap.ObjectPageLayout
Adds some headerContent to the aggregation headerContent.
Parameters:
sap.ui.core.ControloHeaderContentThe headerContent to add; if empty, nothing is inserted
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
addSection(oSection): sap.uxap.ObjectPageLayout
Adds some section to the aggregation sections.
Parameters:
sap.uxap.ObjectPageSectionoSectionThe section to add; if empty, nothing is inserted
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
attachEditHeaderButtonPress(oData?, fnFunction, oListener?): sap.uxap.ObjectPageLayout

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

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.uxap.ObjectPageLayout itself
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
attachNavigate(oData?, fnFunction, oListener?): sap.uxap.ObjectPageLayout

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.

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.uxap.ObjectPageLayout itself
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.40
attachToggleAnchorBar(oData?, fnFunction, oListener?): sap.uxap.ObjectPageLayout

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.

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.uxap.ObjectPageLayout itself
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
destroyFooter(): sap.uxap.ObjectPageLayout
Destroys the footer in the aggregation footer.
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.40
destroyHeaderContent(): sap.uxap.ObjectPageLayout
Destroys all the headerContent in the aggregation headerContent.
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
destroyHeaderTitle(): sap.uxap.ObjectPageLayout
Destroys the headerTitle in the aggregation headerTitle.
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
destroySections(): sap.uxap.ObjectPageLayout
Destroys all the sections in the aggregation sections.
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
detachEditHeaderButtonPress(fnFunction, oListener): sap.uxap.ObjectPageLayout

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
detachNavigate(fnFunction, oListener): sap.uxap.ObjectPageLayout

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.40
detachToggleAnchorBar(fnFunction, oListener): sap.uxap.ObjectPageLayout

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
fireEditHeaderButtonPress(mParameters?): sap.uxap.ObjectPageLayout
Fires event editHeaderButtonPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
fireNavigate(mParameters?): sap.uxap.ObjectPageLayout
Fires event navigate to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.uxap.ObjectPageSectionmParameters.section?The selected section object.
sap.uxap.ObjectPageSubSectionmParameters.subSection?The selected subsection object.
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.40
fireToggleAnchorBar(mParameters?): sap.uxap.ObjectPageLayout
Fires event toggleAnchorBar to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
booleanmParameters.fixed?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.
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
getAlwaysShowContentHeader(): boolean

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.

Returns:
booleanValue of property alwaysShowContentHeader
Since:
1.34.0
getEnableLazyLoading(): boolean

Gets current value of property enableLazyLoading.

Enable lazy loading for the Object page Subsections.

Default value is false.

Returns:
booleanValue of property enableLazyLoading
getFlexEnabled(): boolean

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.

Returns:
booleanValue of property flexEnabled
Since:
1.34.0
getFooter(): sap.m.IBar

Gets content of aggregation footer.

Object page floating footer.

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

Gets content of aggregation headerContent.

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

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

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.

Returns:
booleanValue of property headerContentPinnable
Since:
1.52
getHeaderTitle(): sap.uxap.IHeaderTitle

Gets content of aggregation headerTitle.

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

Returns:
sap.uxap.IHeaderTitle
getHeight(): sap.ui.core.CSSSize

Gets current value of property height.

Determines the height of the ObjectPage.

Default value is 100%.

Returns:
sap.ui.core.CSSSizeValue of property height
getIsChildPage(): boolean

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.

Returns:
booleanValue of property isChildPage
Since:
1.34.0
getPreserveHeaderStateOnScroll(): boolean

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.

Returns:
booleanValue of property preserveHeaderStateOnScroll
Since:
1.52
getScrollDelegate(): object
Returns an sap.ui.core.delegate.ScrollEnablement object used to handle scrolling
Returns:
object
getScrollingSectionId(): string
Returns the UI5 ID of the Section that is currently being scrolled.
Returns:
string
getSections(): sap.uxap.ObjectPageSection[]

Gets content of aggregation sections.

The sections that make up the Object page content area.

Returns:
sap.uxap.ObjectPageSection[]
getSectionTitleLevel(): sap.ui.core.TitleLevel

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.

Returns:
sap.ui.core.TitleLevelValue of property sectionTitleLevel
Since:
1.44.0
getSelectedSection(): sap.ui.core.ID
ID of the element which is the current target of the association selectedSection, or null.
Returns:
sap.ui.core.ID
Since:
1.44.0
getShowAnchorBar(): boolean

Gets current value of property showAnchorBar.

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

Default value is true.

Returns:
booleanValue of property showAnchorBar
getShowAnchorBarPopover(): boolean

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.

Returns:
booleanValue of property showAnchorBarPopover
getShowEditHeaderButton(): boolean

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.

Returns:
booleanValue of property showEditHeaderButton
Since:
1.34.0
getShowFooter(): boolean

Gets current value of property showFooter.

Determines whether the footer is visible.

Default value is false.

Returns:
booleanValue of property showFooter
Since:
1.40
getShowHeaderContent(): boolean

Gets current value of property showHeaderContent.

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

Default value is true.

Returns:
booleanValue of property showHeaderContent
getShowOnlyHighImportance(): boolean

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.

Returns:
booleanValue of property showOnlyHighImportance
Since:
1.32.0
getShowTitleInHeaderContent(): boolean

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.

Returns:
booleanValue of property showTitleInHeaderContent
getSubSectionLayout(): sap.uxap.ObjectPageSubSectionLayout

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.

Returns:
sap.uxap.ObjectPageSubSectionLayoutValue of property subSectionLayout
getToggleHeaderOnTitleClick(): boolean

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.

Returns:
booleanValue of property toggleHeaderOnTitleClick
Since:
1.52
getUpperCaseAnchorBar(): boolean

Gets current value of property upperCaseAnchorBar.

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

Default value is true.

Returns:
booleanValue of property upperCaseAnchorBar
getUseIconTabBar(): boolean

Gets current value of property useIconTabBar.

Use tab navigation mode instead of the default Anchor bar mode.
Note: Keep in mind that the sap.m.IconTabBar control is no longer used for the tab navigation mode.

Default value is false.

Returns:
booleanValue of property useIconTabBar
getUseTwoColumnsForLargeScreen(): boolean

Gets current value of property useTwoColumnsForLargeScreen.

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

Default value is false.

Returns:
booleanValue of property useTwoColumnsForLargeScreen
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
indexOfSection(oSection): int
Checks for the provided sap.uxap.ObjectPageSection in the aggregation sections. and returns its index if found or -1 otherwise.
Parameters:
sap.uxap.ObjectPageSectionoSectionThe section whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertHeaderContent(oHeaderContent, iIndex): sap.uxap.ObjectPageLayout
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.uxap.ObjectPageLayoutReference to this in order to allow method chaining
insertSection(oSection, iIndex): sap.uxap.ObjectPageLayout
Inserts a section into the aggregation sections.
Parameters:
sap.uxap.ObjectPageSectionoSectionThe section to insert; if empty, nothing is inserted
intiIndexThe 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
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
invalidate(oOrigin?)
This triggers rerendering of itself and its children.
Parameters:
sap.ui.base.ManagedObjectoOrigin?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(): 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)
removeAllSections(): sap.uxap.ObjectPageSection[]

Removes all the controls from the aggregation sections.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.uxap.ObjectPageSection[]An array of the removed elements (might be empty)
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
removeSection(vSection): sap.uxap.ObjectPageSection
Removes a section from the aggregation sections.
Parameters:
int|string|sap.uxap.ObjectPageSectionvSectionThe section to remove or its index or id
Returns:
sap.uxap.ObjectPageSectionThe removed section or null
scrollToSection(sId, iDuration, iOffset)
Scrolls the Object page to the given Section.
Parameters:
stringsIdThe Section ID to scroll to
intiDurationScroll duration (in ms). Default value is 0
intiOffsetAdditional pixels to scroll
setAlwaysShowContentHeader(bAlwaysShowContentHeader): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbAlwaysShowContentHeaderNew value for property alwaysShowContentHeader
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.34.0
setEnableLazyLoading(bEnableLazyLoading): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbEnableLazyLoadingNew value for property enableLazyLoading
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setFlexEnabled(bFlexEnabled): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbFlexEnabledNew value for property flexEnabled
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.34.0
setFooter(oFooter): sap.uxap.ObjectPageLayout
Sets the aggregated footer.
Parameters:
sap.m.IBaroFooterThe footer to set
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.40
setHeaderContentPinnable(bHeaderContentPinnable): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbHeaderContentPinnableNew value for property headerContentPinnable
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.52
setHeaderTitle(oHeaderTitle): sap.uxap.ObjectPageLayout
Sets the aggregated headerTitle.
Parameters:
sap.uxap.IHeaderTitleoHeaderTitleThe headerTitle to set
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setHeight(sHeight): sap.uxap.ObjectPageLayout

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%.

Parameters:
sap.ui.core.CSSSizesHeightNew value for property height
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setIsChildPage(bIsChildPage): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbIsChildPageNew value for property isChildPage
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.34.0
setPreserveHeaderStateOnScroll(bPreserveHeaderStateOnScroll): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbPreserveHeaderStateOnScrollNew value for property preserveHeaderStateOnScroll
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.52
setSectionTitleLevel(sSectionTitleLevel): sap.uxap.ObjectPageLayout

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.

Parameters:
sap.ui.core.TitleLevelsSectionTitleLevelNew value for property sectionTitleLevel
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.44.0
setSelectedSection(vSectionBase): sap.uxap.ObjectPageLayout

Sets the section that should be selected.

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

Note that null or undefined are not valid arguments and will be discarded. This is because the sap.uxap.ObjectPageLayout should always have one of its sections selected (unless it has 0 sections).

Parameters:
string|sap.uxap.ObjectPageSectionvSectionBaseThe ID or the section instance that should be selected Note that null or undefined are not valid arguments
Returns:
sap.uxap.ObjectPageLayoutReturns this to allow method chaining
setShowAnchorBar(bShowAnchorBar): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowAnchorBarNew value for property showAnchorBar
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setShowAnchorBarPopover(bShowAnchorBarPopover): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowAnchorBarPopoverNew value for property showAnchorBarPopover
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setShowEditHeaderButton(bShowEditHeaderButton): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowEditHeaderButtonNew value for property showEditHeaderButton
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.34.0
setShowFooter(bShowFooter): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowFooterNew value for property showFooter
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.40
setShowHeaderContent(bShowHeaderContent): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowHeaderContentNew value for property showHeaderContent
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setShowOnlyHighImportance(bShowOnlyHighImportance): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowOnlyHighImportanceNew value for property showOnlyHighImportance
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.32.0
setShowTitleInHeaderContent(bShowTitleInHeaderContent): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbShowTitleInHeaderContentNew value for property showTitleInHeaderContent
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setSubSectionLayout(sSubSectionLayout): sap.uxap.ObjectPageLayout

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.

Parameters:
sap.uxap.ObjectPageSubSectionLayoutsSubSectionLayoutNew value for property subSectionLayout
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setToggleHeaderOnTitleClick(bToggleHeaderOnTitleClick): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbToggleHeaderOnTitleClickNew value for property toggleHeaderOnTitleClick
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
Since:
1.52
setUpperCaseAnchorBar(bUpperCaseAnchorBar): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbUpperCaseAnchorBarNew value for property upperCaseAnchorBar
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setUseIconTabBar(bUseIconTabBar): sap.uxap.ObjectPageLayout

Sets a new value for property useIconTabBar.

Use tab navigation mode instead of the default Anchor bar mode.
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.

Parameters:
booleanbUseIconTabBarNew value for property useIconTabBar
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining
setUseTwoColumnsForLargeScreen(bUseTwoColumnsForLargeScreen): sap.uxap.ObjectPageLayout

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.

Parameters:
booleanbUseTwoColumnsForLargeScreenNew value for property useTwoColumnsForLargeScreen
Returns:
sap.uxap.ObjectPageLayoutReference to this in order to allow method chaining