ObjectPageLayout

extends Control

An ObjectPageLayout is the layout control, used to put together all parts of an Object page - Header, Navigation bar and Sections/Subsections.

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

tabSelect(oControlEvent)The event is fired when the selected tab changes.

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

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

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.

attachTabSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the tabSelect event of this sap.uxap.ObjectPageLayout.

attachToggleAnchorBar(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.

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.

detachTabSelect(fnFunction, oListener)Detaches event handler fnFunction from the tabSelect event of this sap.uxap.ObjectPageLayout.

detachToggleAnchorBar(fnFunction, oListener)Detaches event handler fnFunction from the toggleAnchorBar event of this sap.uxap.ObjectPageLayout.

fireEditHeaderButtonPress(mArguments?)Fires event editHeaderButtonPress to attached listeners.

fireTabSelect(mArguments?)Fires event tabSelect to attached listeners.

fireToggleAnchorBar(mArguments?)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.

getHeaderTitle()Gets content of aggregation headerTitle.

getHeight()Gets current value of property height.

getIsChildPage()Gets current value of property isChildPage.

getScrollDelegate()Returns a 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.

getShowAnchorBar()Gets current value of property showAnchorBar.

getShowAnchorBarPopover()Gets current value of property showAnchorBarPopover.

getShowEditHeaderButton()Gets current value of property showEditHeaderButton.

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.

getUpperCaseAnchorBar()Gets current value of property upperCaseAnchorBar.

getUseIconTabBar()Gets current value of property useIconTabBar.

getUseTwoColumnsForLargeScreen()Gets current value of property useTwoColumnsForLargeScreen.

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.

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.

setBusy(bBusy)Overwrite setBusy, because the busyIndicator does not cover the header title, because the header title has z-index: 2 in order to appear on top of the content

setEnableLazyLoading(bEnableLazyLoading)Sets a new value for property enableLazyLoading.

setFlexEnabled(bFlexEnabled)Sets a new value for property flexEnabled.

setHeaderTitle(oHeaderTitle)Sets the aggregated headerTitle.

setHeight(sHeight)Sets a new value for property height.

setIsChildPage(bIsChildPage)Sets a new value for property isChildPage.

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.

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.

setUpperCaseAnchorBar(bUpperCaseAnchorBar)Sets a new value for property upperCaseAnchorBar.

setUseTwoColumnsForLargeScreen(bUseTwoColumnsForLargeScreen)Sets a new value for property useTwoColumnsForLargeScreen.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

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:

Properties
- showAnchorBar : boolean (default: true)
- showAnchorBarPopover : boolean (default: true)
- upperCaseAnchorBar : boolean (default: true)
- height : sap.ui.core.CSSSize (default: 100%)
- enableLazyLoading : boolean (default: false)
- subSectionLayout : sap.uxap.ObjectPageSubSectionLayout (default: TitleOnTop)
- useIconTabBar : boolean (default: false)
- showHeaderContent : boolean (default: true)
- useTwoColumnsForLargeScreen : boolean (default: false)
- showTitleInHeaderContent : boolean (default: false)
- showOnlyHighImportance : boolean (default: false)
- isChildPage : boolean (default: false)
- alwaysShowContentHeader : boolean (default: false)
- showEditHeaderButton : boolean (default: false)
- flexEnabled : boolean (default: false)
Aggregations
- sections : sap.uxap.ObjectPageSection[] (default)
- headerTitle : sap.uxap.ObjectPageHeader
- headerContent : sap.ui.core.Control[]
Events
- toggleAnchorBar : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- editHeaderButtonPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- tabSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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

Parameters:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	initial settings for the new control

Event Detail

editHeaderButtonPress(oControlEvent)

The event is fired when the Edit Header button is pressed

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

tabSelect(oControlEvent)

The event is fired when the selected tab changes. Note: Event is fired only when IconTabBar is used for navigation.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{sap.uxap.ObjectPageSection}	oControlEvent.getParameters.section	The selected section object.

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.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{boolean}	oControlEvent.getParameters.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.

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:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.uxap.ObjectPageLayout.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addHeaderContent(oHeaderContent): sap.uxap.ObjectPageLayout

Adds some headerContent to the aggregation headerContent.

Parameters:

{sap.ui.core.Control}

oHeaderContent

the headerContent to add; if empty, nothing is inserted

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

addSection(oSection): sap.uxap.ObjectPageLayout

Adds some section to the aggregation sections.

Parameters:

{sap.uxap.ObjectPageSection}

oSection

the section to add; if empty, nothing is inserted

Returns:

{sap.uxap.ObjectPageLayout} Reference 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:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

attachTabSelect(oData?, fnFunction, oListener?): sap.uxap.ObjectPageLayout

Attaches event handler fnFunction to the tabSelect 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 tab changes. Note: Event is fired only when IconTabBar is used for navigation.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

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:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

destroyHeaderContent(): sap.uxap.ObjectPageLayout

Destroys all the headerContent in the aggregation headerContent.

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

destroyHeaderTitle(): sap.uxap.ObjectPageLayout

Destroys the headerTitle in the aggregation headerTitle.

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

destroySections(): sap.uxap.ObjectPageLayout

Destroys all the sections in the aggregation sections.

Returns:

{sap.uxap.ObjectPageLayout} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

detachTabSelect(fnFunction, oListener): sap.uxap.ObjectPageLayout

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

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

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

fireEditHeaderButtonPress(mArguments?): sap.uxap.ObjectPageLayout

Fires event editHeaderButtonPress to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

fireTabSelect(mArguments?): sap.uxap.ObjectPageLayout

Fires event tabSelect to attached listeners.

Expects the following event parameters:

section of type sap.uxap.ObjectPageSectionThe selected section object.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

fireToggleAnchorBar(mArguments?): sap.uxap.ObjectPageLayout

Fires event toggleAnchorBar to attached listeners.

Expects the following event parameters:

fixed of type booleanFalse 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.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.uxap.ObjectPageLayout} Reference 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.

Default value is false.

Since:: 1.34.0

Returns:

{boolean} Value of property alwaysShowContentHeader

getEnableLazyLoading(): boolean

Gets current value of property enableLazyLoading.

Enable lazy loading for the Object page Subsections.

Default value is false.

Returns:

{boolean} Value 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.

Since:: 1.34.0

Returns:

{boolean} Value of property flexEnabled

getHeaderTitle(): sap.uxap.ObjectPageHeader

Gets content of aggregation headerTitle.

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

Returns:

{sap.uxap.ObjectPageHeader}

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.CSSSize} Value 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.

Default value is false.

Since:: 1.34.0

Returns:

{boolean} Value of property isChildPage

getScrollDelegate(): object

Returns a 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[]}

getShowAnchorBar(): boolean

Gets current value of property showAnchorBar.

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

Default value is true.

Returns:

{boolean} Value 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:

{boolean} Value of property showAnchorBarPopover

getShowEditHeaderButton(): boolean

Gets current value of property showEditHeaderButton.

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

Default value is false.

Since:: 1.34.0

Returns:

{boolean} Value of property showEditHeaderButton

getShowHeaderContent(): boolean

Gets current value of property showHeaderContent.

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

Default value is true.

Returns:

{boolean} Value 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.

Since:: 1.32.0

Returns:

{boolean} Value of property showOnlyHighImportance

getShowTitleInHeaderContent(): boolean

Gets current value of property showTitleInHeaderContent.

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

Default value is false.

Returns:

{boolean} Value 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.ObjectPageSubSectionLayout} Value of property subSectionLayout

getUpperCaseAnchorBar(): boolean

Gets current value of property upperCaseAnchorBar.

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

Default value is true.

Returns:

{boolean} Value of property upperCaseAnchorBar

getUseIconTabBar(): boolean

Gets current value of property useIconTabBar.

Use sap.m.IconTabBar instead of the default Anchor bar

Default value is false.

Returns:

{boolean} Value 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:

{boolean} Value 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.Control}

oHeaderContent

The headerContent whose index is looked for

Returns:

{int}

The 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.ObjectPageSection}

oSection

The section whose index is looked for

Returns:

{int}

The 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.Control}	oHeaderContent	the headerContent to insert; if empty, nothing is inserted
{int}	iIndex	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

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

insertSection(oSection, iIndex): sap.uxap.ObjectPageLayout

Inserts a section into the aggregation sections.

Parameters:

{sap.uxap.ObjectPageSection}	oSection	the section to insert; if empty, nothing is inserted
{int}	iIndex	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

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

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.Control}

vHeaderContent

The headerContentto remove or its index or id

Returns:

{sap.ui.core.Control} The removed headerContent or null

removeSection(vSection): sap.uxap.ObjectPageSection

Removes a section from the aggregation sections.

Parameters:

{int|string|sap.uxap.ObjectPageSection}

vSection

The sectionto remove or its index or id

Returns:

{sap.uxap.ObjectPageSection} The removed section or null

scrollToSection(sId, iDuration, iOffset)

Scrolls the Object page to the given Section.

Parameters:

{string}	sId	The Section ID to scroll to
{int}	iDuration	Scroll duration (in ms). Default value is 0
{int}	iOffset	Additional 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.

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

Default value is false.

Parameters:

{boolean} bAlwaysShowContentHeader New value for property alwaysShowContentHeader

Since:: 1.34.0

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

setBusy(bBusy)

Overwrite setBusy, because the busyIndicator does not cover the header title, because the header title has z-index: 2 in order to appear on top of the content

Parameters:

{boolean}

bBusy

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:

{boolean} bEnableLazyLoading New value for property enableLazyLoading

Returns:

{sap.uxap.ObjectPageLayout} Reference 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:

{boolean} bFlexEnabled New value for property flexEnabled

Since:: 1.34.0

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

setHeaderTitle(oHeaderTitle): sap.uxap.ObjectPageLayout

Sets the aggregated headerTitle.

Parameters:

{sap.uxap.ObjectPageHeader}

oHeaderTitle

The headerTitle to set

Returns:

{sap.uxap.ObjectPageLayout} Reference 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.CSSSize} sHeight New value for property height

Returns:

{sap.uxap.ObjectPageLayout} Reference 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.

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

Default value is false.

Parameters:

{boolean} bIsChildPage New value for property isChildPage

Since:: 1.34.0

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order 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:

{boolean} bShowAnchorBar New value for property showAnchorBar

Returns:

{sap.uxap.ObjectPageLayout} Reference 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:

{boolean} bShowAnchorBarPopover New value for property showAnchorBarPopover

Returns:

{sap.uxap.ObjectPageLayout} Reference 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 shown in Header Content.

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

Default value is false.

Parameters:

{boolean} bShowEditHeaderButton New value for property showEditHeaderButton

Since:: 1.34.0

Returns:

{sap.uxap.ObjectPageLayout} Reference 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:

{boolean} bShowOnlyHighImportance New value for property showOnlyHighImportance

Since:: 1.32.0

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

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.

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

Default value is false.

Parameters:

{boolean} bShowTitleInHeaderContent New value for property showTitleInHeaderContent

Returns:

{sap.uxap.ObjectPageLayout} Reference 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.ObjectPageSubSectionLayout} sSubSectionLayout New value for property subSectionLayout

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining

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:

{boolean} bUpperCaseAnchorBar New value for property upperCaseAnchorBar

Returns:

{sap.uxap.ObjectPageLayout} Reference 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:

{boolean} bUseTwoColumnsForLargeScreen New value for property useTwoColumnsForLargeScreen

Returns:

{sap.uxap.ObjectPageLayout} Reference to this in order to allow method chaining