A layout that allows apps to easily display information related to a business object.
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.
An ObjectPageLayout
control is used to put together all parts of an Object page - Header, optional Anchor Bar and Sections/Subsections.
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.
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.
The content of the page that appears bellow the header is composed of blocks structured into sections and subsections.
Use the ObjectPageLayout
if:
The ObjectPageLayout
is responsive and adapts to all screen sizes.
Documentation links:
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 |
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 |
backgroundDesignAnchorBar | sap.m.BackgroundDesign | Determines the background color of the Note: The default value of |
|
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. |
headerContentPinnable | boolean | true | Determines whether the Header Content area can be pinned. When set to Note: This property is only taken into account if an instance of |
headerContentPinned | boolean | false | Determines whether the 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:
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 |
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:
Since: 1.52.Visibility: public |
sectionTitleLevel | sap.ui.core.TitleLevel | Auto | Determines the ARIA level of the
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 |
showFooter | boolean | false | Determines whether the footer is visible. |
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. |
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 |
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 Note: This property is only taken into account if an instance of |
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 |
useTwoColumnsForLargeScreen | boolean | false | Determines whether the to use two column layout for the L screen size. Visibility: public |
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. |
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 If not set, no landmarks will be written. |
sections (default) | 0..n | sap.uxap.ObjectPageSection |
The sections that make up the Object page content area. |
Name | Cardinality | Type | Description |
---|---|---|---|
selectedSection | 0..1 | sap.uxap.ObjectPageSection |
The section that is selected by default on load. |
Event | Description |
---|---|
editHeaderButtonPress |
The event is fired when the Edit Header button is pressed |
headerContentPinnedStateChange |
The event is fired when the |
navigate |
The event is fired when the selected section is changed using the navigation. |
sectionChange |
Fired when the current section is changed by scrolling. |
subSectionVisibilityChange |
Fired when the visibility of subsections is changed. |
toggleAnchorBar |
The event is fired when the Anchor bar is switched from moving to fixed or the other way round. |
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 |
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. |
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. |
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 |
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. |
Method | Description |
---|---|
_resumeScroll |
Un-sets the flag that deactivates scrolling requested with the |
_suppressScroll |
Sets a flag to [temporarily] deactivate any scrolling requested with the |
_triggerVisibleSubSectionsEvents |
Resets the internal information of which subsections are in view and immediately calls the layout calculation so that an event |
addHeaderContent |
Adds some headerContent to the aggregation headerContent. |
addSection |
Adds some section to the aggregation sections. |
attachEditHeaderButtonPress |
Attaches event handler When called, the context of the event handler (its The event is fired when the Edit Header button is pressed |
attachHeaderContentPinnedStateChange |
Attaches event handler When called, the context of the event handler (its The event is fired when the |
attachNavigate |
Attaches event handler When called, the context of the event handler (its The event is fired when the selected section is changed using the navigation. |
attachSectionChange |
Attaches event handler When called, the context of the event handler (its Fired when the current section is changed by scrolling. |
attachSubSectionVisibilityChange |
Attaches event handler When called, the context of the event handler (its Fired when the visibility of subsections is changed. |
attachToggleAnchorBar |
Attaches event handler When called, the context of the event handler (its 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 The passed function and listener object must match the ones used for event registration. |
detachHeaderContentPinnedStateChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachNavigate |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSectionChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSubSectionVisibilityChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachToggleAnchorBar |
Detaches event handler 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
|
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 Default value is |
getBackgroundDesignAnchorBar |
Gets current value of property backgroundDesignAnchorBar. Determines the background color of the Note: The default value of |
getEnableLazyLoading |
Gets current value of property enableLazyLoading. Enable lazy loading for the Object page Subsections. Default value is |
getFlexEnabled |
Gets current value of property flexEnabled. Specifies whether the object page enables flexibility features, such as hiding and adding sections. Default value is |
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 Note: This property is only taken into account if an instance of Default value is |
getHeaderContentPinned |
Gets current value of property headerContentPinned. Determines whether the 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 |
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 |
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 Default value is |
getLandmarkInfo |
Gets content of aggregation landmarkInfo. Accessible landmark settings to be applied on the containers of the 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 |
getScrollDelegate |
Returns the |
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
Default value is |
getSelectedSection |
ID of the element which is the current target of the association selectedSection, or |
getShowAnchorBar |
Gets current value of property showAnchorBar. Determines whether the Navigation bar (Anchor bar) is displayed. Default value is |
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 |
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 Default value is |
getShowFooter |
Gets current value of property showFooter. Determines whether the footer is visible. Default value is |
getShowHeaderContent |
Gets current value of property showHeaderContent. Determines the visibility of the Header content (headerContent aggregation). Default value is |
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 |
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 Default value is |
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 |
getToggleHeaderOnTitleClick |
Gets current value of property toggleHeaderOnTitleClick. Determines whether the user can switch between the expanded/collapsed states of the Note: This property is only taken into account if an instance of Default value is |
getUpperCaseAnchorBar |
Gets current value of property upperCaseAnchorBar. Determines whether the Anchor bar items are displayed in upper case. Default value is |
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 Default value is |
getUseTwoColumnsForLargeScreen |
Gets current value of property useTwoColumnsForLargeScreen. Determines whether the to use two column layout for the L screen size. Default value is |
indexOfHeaderContent |
Checks for the provided |
indexOfSection |
Checks for the provided |
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 When called with a value of Default value is |
setBackgroundDesignAnchorBar |
Sets the value of the |
setEnableLazyLoading |
Sets a new value for property enableLazyLoading. Enable lazy loading for the Object page Subsections. When called with a value of Default value is |
setFlexEnabled |
Sets a new value for property flexEnabled. Specifies whether the object page enables flexibility features, such as hiding and adding sections. When called with a value of Default value is |
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 Note: This property is only taken into account if an instance of When called with a value of Default value is |
setHeaderContentPinned |
Sets a new value for property headerContentPinned. Determines whether the 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 Default value is |
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 Default value is |
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 When called with a value of Default value is |
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:
When called with a value of Default value is |
setSectionTitleLevel |
Sets a new value for property sectionTitleLevel. Determines the ARIA level of the
When called with a value of Default value is |
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 |
setShowAnchorBar |
Sets a new value for property showAnchorBar. Determines whether the Navigation bar (Anchor bar) is displayed. When called with a value of Default value is |
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 Default value is |
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 When called with a value of Default value is |
setShowFooter |
Sets a new value for property showFooter. Determines whether the footer is visible. When called with a value of Default value is |
setShowHeaderContent |
Sets a new value for property showHeaderContent. Determines the visibility of the Header content (headerContent aggregation). When called with a value of Default value is |
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 Default value is |
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 When called with a value of Default value is |
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 Default value is |
setToggleHeaderOnTitleClick |
Sets a new value for property toggleHeaderOnTitleClick. Determines whether the user can switch between the expanded/collapsed states of the Note: This property is only taken into account if an instance of When called with a value of Default value is |
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 Default value is |
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 When called with a value of Default value is |
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 Default value is |
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
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
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.
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 |
Adds some section to the aggregation sections.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSection | sap.uxap.ObjectPageSection |
The section to add; if empty, nothing is inserted |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Fires event editHeaderButtonPress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
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. |
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. |
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 |
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. |
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
.
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.
Gets current value of property enableLazyLoading.
Enable lazy loading for the Object page Subsections.
Default value is false
.
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
.
Gets content of aggregation headerContent.
Object page header content - the dynamic part of the Object page header.
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
.
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:
sap.uxap.ObjectPageDynamicHeaderContent
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:
sap.uxap.ObjectPageDynamicHeaderTitle
is used for the headerTitle
aggregation.headerContentPinnable
property is true
sap.uxap.ObjectPageDynamicHeaderContent
is expandedpreserveHeaderStateOnScroll
property or the rules for it to work are false
Default value is false
.
Gets content of aggregation headerTitle.
Object page header title - the upper, always static, part of the Object page header.
Gets current value of property height.
Determines the height of the ObjectPage.
Default value is "100%"
.
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
.
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.
Returns a metadata object for class sap.uxap.ObjectPageLayout.
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:
sap.uxap.ObjectPageDynamicHeaderTitle
is used for the headerTitle
aggregation.Default value is false
.
Returns the sap.ui.core.ScrollEnablement
delegate which is used with this control.
Gets content of aggregation sections.
The sections that make up the Object page content area.
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:
sectionTitleLevel
will add aria-level
attribute from 1 to 6 instead of changing the titles` HTML tag from H1 to H6. sectionTitleLevel
is TitleLevel.H1
, it will result as aria-level of 1 added to the ObjectPageSection
title. 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.titleLevel
on ObjectPageSection
or ObjectPageSubSection
level. In this case the value of this property will be ignored. Default value is Auto
.
ID of the element which is the current target of the association selectedSection, or null
.
Gets current value of property showAnchorBar.
Determines whether the Navigation bar (Anchor bar) is displayed.
Default value is true
.
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
.
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
.
Gets current value of property showHeaderContent.
Determines the visibility of the Header content (headerContent aggregation).
Default value is true
.
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
.
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
.
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
.
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
.
Gets current value of property upperCaseAnchorBar.
Determines whether the Anchor bar items are displayed in upper case.
Default value is true
.
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
.
Gets current value of property useTwoColumnsForLargeScreen.
Determines whether the to use two column layout for the L screen size.
Default value is false
.
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 |
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 |
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 |
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 |
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 |
Removes all the controls from the aggregation headerContent.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation sections.
Additionally, it unregisters them from the hosting UIArea.
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 |
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 |
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 |
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 |
Sets the value of the backgroundDesignAnchorBar
property.
Param | Type | DefaultValue | Description |
---|---|---|---|
sBackgroundDesignAnchorBar | sap.m.BackgroundDesign |
new value of the |
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 |
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 |
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 |
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:
sap.uxap.ObjectPageDynamicHeaderContent
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:
sap.uxap.ObjectPageDynamicHeaderTitle
is used for the headerTitle
aggregation.headerContentPinnable
property is true
sap.uxap.ObjectPageDynamicHeaderContent
is expandedpreserveHeaderStateOnScroll
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bHeaderContentPinned | boolean | false |
New value for property |
Sets the aggregated headerTitle.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderTitle | sap.uxap.IHeaderTitle |
The headerTitle to set |
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 |
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 |
Sets the aggregated landmarkInfo.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLandmarkInfo | sap.uxap.ObjectPageAccessibleLandmarkInfo |
The landmarkInfo to set |
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:
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 false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bPreserveHeaderStateOnScroll | boolean | false |
New value for property |
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:
sectionTitleLevel
will add aria-level
attribute from 1 to 6 instead of changing the titles` HTML tag from H1 to H6. sectionTitleLevel
is TitleLevel.H1
, it will result as aria-level of 1 added to the ObjectPageSection
title. 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.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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSectionTitleLevel | sap.ui.core.TitleLevel | Auto |
New value for property |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |