class sap.uxap.ObjectPageHeader

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

Represents the static part (header title) of the classic header of the sap.uxap.ObjectPageLayout.

Overview

The ObjectPageHeader is used to display the basic information about a business object, such as title/description/picture, as well as a list of common actions.

Note: The ObjectPageHeader is meant to be used inside the ObjectPageLayout control. Any other usage is not supported and can lead to unexpected behavior.

Documentation links:


Constructor

Constructor for a new ObjectPageHeader.

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.ObjectPageHeader(sId?, mSettings?)
Param Type Default Value Description
sId? string

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

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
headerDesign sap.uxap.ObjectPageHeaderDesign Light

Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.

Visibility: public
isActionAreaAlwaysVisible boolean true

Determines whether the action buttons should always be visible or visible only when the header is snapped.

Visibility: public
isObjectIconAlwaysVisible boolean false

Determines whether the icon should always be visible or visible only when the header is snapped.

Visibility: public
isObjectSubtitleAlwaysVisible boolean true

Determines whether the subtitle should always be visible or visible only when the header is snapped.

Visibility: public
isObjectTitleAlwaysVisible boolean true

Determines whether the title should always be visible or visible only when the header is snapped.

Visibility: public
markChanges boolean false

Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together with the markLocked state. If both are set to true, only the locked state will be displayed.

Since: 1.34.0.

Visibility: public
markFavorite boolean false

Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.

Visibility: public
markFlagged boolean false

Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.

Visibility: public
markLocked boolean false

Set the locked state of the objectPageHeader.

Visibility: public
objectImageAlt string empty string

The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property

Visibility: public
objectImageBackgroundColor sap.m.AvatarColor Accent6

Determines the background color of the image placeholder or icon if valid icon URI is provided.

Since: 1.73.

Visibility: public
objectImageDensityAware boolean false

The value of densityAware for the image, supplied via the objectImageURI property. See sap.m.Image for more details on densityAware.

Visibility: public
objectImageShape sap.m.AvatarShape Square

Determines whether the picture should be displayed in a square or with a circle-shaped mask.

Visibility: public
objectImageURI string

The URL of the image, representing the business object

Visibility: public
objectSubtitle string

The description of the object

Visibility: public
objectTitle string

The title of the object

Visibility: public
showMarkers boolean false

Indicates if object page header title supports showing markers such as flagged and favorite.

Visibility: public
showPlaceholder boolean false

Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.

Visibility: public
showTitleSelector boolean false

When set to true, the selector arrow icon/image is shown and can be pressed.

Visibility: public

Aggregations

Default Aggregation: actions

Name Cardinality Type Description
_breadCrumbs 0..1 sap.m.Breadcrumbs

Internal aggregation for the legacy breadCrumbsLinks.

_changesIcon 0..1 sap.m.Button
_changesIconCont 0..1 sap.m.Button
_expandButton 0..1 sap.m.Button

Internal aggregation for the expand header button.

_favIcon 0..1 sap.ui.core.Icon
_flagIcon 0..1 sap.ui.core.Icon
_lockIcon 0..1 sap.m.Button
_lockIconCont 0..1 sap.m.Button
_objectImage 0..1 sap.ui.core.Control

Icon for the identifier line.

_overflowActionSheet 0..1 sap.m.ActionSheet
_overflowButton 0..1 sap.m.Button

Internal aggregation for the overflow button in the header.

_placeholder 0..1 sap.m.Avatar
_sideContentBtn 0..1 sap.m.Button
_titleArrowIcon 0..1 sap.m.Button
_titleArrowIconCont 0..1 sap.m.Button
actions (default) 0..n sap.ui.core.Control

List of actions that will be displayed in the header. You can use ObjectPageHeaderActionButton controls to achieve a different visual representation of the action buttons in the action bar and the action sheet (overflow menu). You can use ObjectPageHeaderLayoutData to display a visual separator.

Note: If an action is placed inside the overflow area, an additional bInOverflow parameter is passed along with the press event to indicate that a popup shouldn't be opened from that action and a dialog should be used instead.

breadcrumbs 0..1 sap.m.Breadcrumbs

The breadcrumbs displayed in the ObjectPageHeader. If this aggregation is set, the breadCrumbsLinks aggregation is omitted.

Since: 1.50.

navigationBar 0..1 sap.m.Bar

An instance of sap.m.Bar to be embedded in the header

sideContentButton 0..1 sap.m.Button

A button that is used for opening the side content of the page or some additional content.

Since: 1.38.0.

titleSelectorTooltip 0..1 sap.ui.core.TooltipBase

A custom tooltip for the title selector button.

The custom tooltip will be visible if the showTitleSelector property is set to true.

Note: If the aggregation is destroyed or set to invalid value, the default tooltip will be set. The default tooltip text is "Related options".

Since: 1.56.


Events Overview

Event Description
markChangesPress

The event is fired when the unsaved changes button is pressed

markLockedPress

The event is fired when the Locked button is pressed

titleSelectorPress

The event is fired when the objectPage header title selector (down-arrow) is pressed

markChangesPress

The event is fired when the unsaved changes button is pressed

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

DOM reference of the changed item's icon to be used for positioning.

Since: 1.34.0.

markLockedPress

The event is fired when the Locked button is pressed

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

DOM reference of the lock item's icon to be used for positioning.

titleSelectorPress

The event is fired when the objectPage header title selector (down-arrow) is pressed

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

DOM reference of the title item's icon to be used for positioning.


Methods Overview

Method Description
addAction

Adds some action to the aggregation actions.

addBreadCrumbLink

Adds some breadCrumbLink to the aggregation breadCrumbsLinks.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
attachMarkChangesPress

Attaches event handler fnFunction to the markChangesPress event of this sap.uxap.ObjectPageHeader.

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.ObjectPageHeader itself.

The event is fired when the unsaved changes button is pressed

attachMarkLockedPress

Attaches event handler fnFunction to the markLockedPress event of this sap.uxap.ObjectPageHeader.

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.ObjectPageHeader itself.

The event is fired when the Locked button is pressed

attachTitleSelectorPress

Attaches event handler fnFunction to the titleSelectorPress event of this sap.uxap.ObjectPageHeader.

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.ObjectPageHeader itself.

The event is fired when the objectPage header title selector (down-arrow) is pressed

destroyActions

Destroys all the actions in the aggregation actions.

destroyBreadcrumbs

Destroys the breadcrumbs in the aggregation breadcrumbs.

destroyBreadCrumbsLinks

Destroys all the breadCrumbsLinks in the aggregation breadCrumbsLinks.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
destroyNavigationBar

Destroys the navigationBar in the aggregation navigationBar.

destroySideContentButton

Destroys the sideContentButton in the aggregation sideContentButton.

destroyTitleSelectorTooltip

Destroys the titleSelectorTooltip in the aggregation titleSelectorTooltip.

detachMarkChangesPress

Detaches event handler fnFunction from the markChangesPress event of this sap.uxap.ObjectPageHeader.

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

detachMarkLockedPress

Detaches event handler fnFunction from the markLockedPress event of this sap.uxap.ObjectPageHeader.

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

detachTitleSelectorPress

Detaches event handler fnFunction from the titleSelectorPress event of this sap.uxap.ObjectPageHeader.

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

sap.uxap.ObjectPageHeader.extend

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

fireMarkChangesPress

Fires event markChangesPress to attached listeners.

fireMarkLockedPress

Fires event markLockedPress to attached listeners.

fireTitleSelectorPress

Fires event titleSelectorPress to attached listeners.

getActions

Gets content of aggregation actions.

List of actions that will be displayed in the header. You can use ObjectPageHeaderActionButton controls to achieve a different visual representation of the action buttons in the action bar and the action sheet (overflow menu). You can use ObjectPageHeaderLayoutData to display a visual separator.

Note: If an action is placed inside the overflow area, an additional bInOverflow parameter is passed along with the press event to indicate that a popup shouldn't be opened from that action and a dialog should be used instead.

getBreadcrumbs

Gets content of aggregation breadcrumbs.

The breadcrumbs displayed in the ObjectPageHeader. If this aggregation is set, the breadCrumbsLinks aggregation is omitted.

getBreadCrumbsLinks

Gets content of aggregation breadCrumbsLinks.

A list of all the active link elements in the BreadCrumbs control.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
getHeaderDesign

Gets current value of property headerDesign.

Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.

Default value is Light.

getIsActionAreaAlwaysVisible

Gets current value of property isActionAreaAlwaysVisible.

Determines whether the action buttons should always be visible or visible only when the header is snapped.

Default value is true.

getIsObjectIconAlwaysVisible

Gets current value of property isObjectIconAlwaysVisible.

Determines whether the icon should always be visible or visible only when the header is snapped.

Default value is false.

getIsObjectSubtitleAlwaysVisible

Gets current value of property isObjectSubtitleAlwaysVisible.

Determines whether the subtitle should always be visible or visible only when the header is snapped.

Default value is true.

getIsObjectTitleAlwaysVisible

Gets current value of property isObjectTitleAlwaysVisible.

Determines whether the title should always be visible or visible only when the header is snapped.

Default value is true.

getMarkChanges

Gets current value of property markChanges.

Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together with the markLocked state. If both are set to true, only the locked state will be displayed.

Default value is false.

getMarkFavorite

Gets current value of property markFavorite.

Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.

Default value is false.

getMarkFlagged

Gets current value of property markFlagged.

Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.

Default value is false.

getMarkLocked

Gets current value of property markLocked.

Set the locked state of the objectPageHeader.

Default value is false.

sap.uxap.ObjectPageHeader.getMetadata

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

getNavigationBar

Gets content of aggregation navigationBar.

An instance of sap.m.Bar to be embedded in the header

getObjectImageAlt

Gets current value of property objectImageAlt.

The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property

Default value is empty string.

getObjectImageBackgroundColor

Gets current value of property objectImageBackgroundColor.

Determines the background color of the image placeholder or icon if valid icon URI is provided.

Default value is Accent6.

getObjectImageDensityAware

Gets current value of property objectImageDensityAware.

The value of densityAware for the image, supplied via the objectImageURI property. See sap.m.Image for more details on densityAware.

Default value is false.

getObjectImageShape

Gets current value of property objectImageShape.

Determines whether the picture should be displayed in a square or with a circle-shaped mask.

Default value is Square.

getObjectImageURI

Gets current value of property objectImageURI.

The URL of the image, representing the business object

getObjectSubtitle

Gets current value of property objectSubtitle.

The description of the object

getObjectTitle

Gets current value of property objectTitle.

The title of the object

getShowMarkers

Gets current value of property showMarkers.

Indicates if object page header title supports showing markers such as flagged and favorite.

Default value is false.

getShowPlaceholder

Gets current value of property showPlaceholder.

Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.

Default value is false.

getShowTitleSelector

Gets current value of property showTitleSelector.

When set to true, the selector arrow icon/image is shown and can be pressed.

Default value is false.

getSideContentButton

Gets content of aggregation sideContentButton.

A button that is used for opening the side content of the page or some additional content.

getTitleSelectorTooltip

Gets content of aggregation titleSelectorTooltip.

A custom tooltip for the title selector button.

The custom tooltip will be visible if the showTitleSelector property is set to true.

Note: If the aggregation is destroyed or set to invalid value, the default tooltip will be set. The default tooltip text is "Related options".

indexOfAction

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

indexOfBreadCrumbLink

Checks for the provided sap.m.Link in the aggregation breadCrumbsLinks. and returns its index if found or -1 otherwise.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
insertAction

Inserts a action into the aggregation actions.

insertBreadCrumbLink

Inserts a breadCrumbLink into the aggregation breadCrumbsLinks.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
removeAction

Removes a action from the aggregation actions.

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllBreadCrumbsLinks

Removes all the controls from the aggregation breadCrumbsLinks.

Additionally, it unregisters them from the hosting UIArea.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
removeBreadCrumbLink

Removes a breadCrumbLink from the aggregation breadCrumbsLinks.

Since 1.50 use the <code>breadcrumbs</code> aggregation instead.
setBreadcrumbs

Sets the aggregated breadcrumbs.

setHeaderDesign

Sets a new value for property headerDesign.

Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.

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

Default value is Light.

setIsActionAreaAlwaysVisible

Sets a new value for property isActionAreaAlwaysVisible.

Determines whether the action buttons should always be visible or visible only when the header is snapped.

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

Default value is true.

setIsObjectIconAlwaysVisible

Sets a new value for property isObjectIconAlwaysVisible.

Determines whether the icon should always be visible or visible only when the header is snapped.

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

Default value is false.

setIsObjectSubtitleAlwaysVisible

Sets a new value for property isObjectSubtitleAlwaysVisible.

Determines whether the subtitle should always be visible or visible only when the header is snapped.

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

Default value is true.

setIsObjectTitleAlwaysVisible

Sets a new value for property isObjectTitleAlwaysVisible.

Determines whether the title should always be visible or visible only when the header is snapped.

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

Default value is true.

setMarkChanges

Sets a new value for property markChanges.

Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together with the markLocked state. If both are set to true, only the locked state will be displayed.

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

Default value is false.

setMarkFavorite

Sets a new value for property markFavorite.

Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.

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

Default value is false.

setMarkFlagged

Sets a new value for property markFlagged.

Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.

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

Default value is false.

setMarkLocked

Sets a new value for property markLocked.

Set the locked state of the objectPageHeader.

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

Default value is false.

setNavigationBar

Sets the aggregated navigationBar.

setObjectImageAlt

Sets a new value for property objectImageAlt.

The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property

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

Default value is empty string.

setObjectImageBackgroundColor

Sets a new value for property objectImageBackgroundColor.

Determines the background color of the image placeholder or icon if valid icon URI is provided.

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

Default value is Accent6.

setObjectImageDensityAware

Sets a new value for property objectImageDensityAware.

The value of densityAware for the image, supplied via the objectImageURI property. See sap.m.Image for more details on densityAware.

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

Default value is false.

setObjectImageShape

Sets a new value for property objectImageShape.

Determines whether the picture should be displayed in a square or with a circle-shaped mask.

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

Default value is Square.

setObjectImageURI

Sets a new value for property objectImageURI.

The URL of the image, representing the business object

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

setObjectSubtitle

Sets a new value for property objectSubtitle.

The description of the object

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

setObjectTitle

Sets a new value for property objectTitle.

The title of the object

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

setShowMarkers

Sets a new value for property showMarkers.

Indicates if object page header title supports showing markers such as flagged and favorite.

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

Default value is false.

setShowPlaceholder

Sets a new value for property showPlaceholder.

Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.

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

Default value is false.

setShowTitleSelector

Sets a new value for property showTitleSelector.

When set to true, the selector arrow icon/image is shown and can be pressed.

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

Default value is false.

setSideContentButton

Sets the aggregated sideContentButton.

setTitleSelectorTooltip

Sets the aggregated titleSelectorTooltip.

addAction

Adds some action to the aggregation actions.

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

The action to add; if empty, nothing is inserted

attachMarkChangesPress

Attaches event handler fnFunction to the markChangesPress event of this sap.uxap.ObjectPageHeader.

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.ObjectPageHeader itself.

The event is fired when the unsaved changes button is pressed

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachMarkLockedPress

Attaches event handler fnFunction to the markLockedPress event of this sap.uxap.ObjectPageHeader.

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.ObjectPageHeader itself.

The event is fired when the Locked button is pressed

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachTitleSelectorPress

Attaches event handler fnFunction to the titleSelectorPress event of this sap.uxap.ObjectPageHeader.

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.ObjectPageHeader itself.

The event is fired when the objectPage header title selector (down-arrow) is pressed

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

destroyActions

Destroys all the actions in the aggregation actions.

destroyBreadcrumbs

Destroys the breadcrumbs in the aggregation breadcrumbs.

destroyNavigationBar

Destroys the navigationBar in the aggregation navigationBar.

destroySideContentButton

Destroys the sideContentButton in the aggregation sideContentButton.

destroyTitleSelectorTooltip

Destroys the titleSelectorTooltip in the aggregation titleSelectorTooltip.

detachMarkChangesPress

Detaches event handler fnFunction from the markChangesPress event of this sap.uxap.ObjectPageHeader.

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

detachMarkLockedPress

Detaches event handler fnFunction from the markLockedPress event of this sap.uxap.ObjectPageHeader.

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

detachTitleSelectorPress

Detaches event handler fnFunction from the titleSelectorPress event of this sap.uxap.ObjectPageHeader.

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

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

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.uxap.ObjectPageHeader.extend

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

fireMarkChangesPress

Fires event markChangesPress to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

domRef string

DOM reference of the changed item's icon to be used for positioning.

fireMarkLockedPress

Fires event markLockedPress to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

domRef string

DOM reference of the lock item's icon to be used for positioning.

fireTitleSelectorPress

Fires event titleSelectorPress to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

domRef string

DOM reference of the title item's icon to be used for positioning.

getActions

Gets content of aggregation actions.

List of actions that will be displayed in the header. You can use ObjectPageHeaderActionButton controls to achieve a different visual representation of the action buttons in the action bar and the action sheet (overflow menu). You can use ObjectPageHeaderLayoutData to display a visual separator.

Note: If an action is placed inside the overflow area, an additional bInOverflow parameter is passed along with the press event to indicate that a popup shouldn't be opened from that action and a dialog should be used instead.

getBreadcrumbs

Gets content of aggregation breadcrumbs.

The breadcrumbs displayed in the ObjectPageHeader. If this aggregation is set, the breadCrumbsLinks aggregation is omitted.

getHeaderDesign

Gets current value of property headerDesign.

Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.

Default value is Light.

getIsActionAreaAlwaysVisible

Gets current value of property isActionAreaAlwaysVisible.

Determines whether the action buttons should always be visible or visible only when the header is snapped.

Default value is true.

getIsObjectIconAlwaysVisible

Gets current value of property isObjectIconAlwaysVisible.

Determines whether the icon should always be visible or visible only when the header is snapped.

Default value is false.

getIsObjectSubtitleAlwaysVisible

Gets current value of property isObjectSubtitleAlwaysVisible.

Determines whether the subtitle should always be visible or visible only when the header is snapped.

Default value is true.

getIsObjectTitleAlwaysVisible

Gets current value of property isObjectTitleAlwaysVisible.

Determines whether the title should always be visible or visible only when the header is snapped.

Default value is true.

getMarkChanges

Gets current value of property markChanges.

Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together with the markLocked state. If both are set to true, only the locked state will be displayed.

Default value is false.

getMarkFavorite

Gets current value of property markFavorite.

Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.

Default value is false.

getMarkFlagged

Gets current value of property markFlagged.

Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.

Default value is false.

getMarkLocked

Gets current value of property markLocked.

Set the locked state of the objectPageHeader.

Default value is false.

sap.uxap.ObjectPageHeader.getMetadata

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

getNavigationBar

Gets content of aggregation navigationBar.

An instance of sap.m.Bar to be embedded in the header

getObjectImageAlt

Gets current value of property objectImageAlt.

The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property

Default value is empty string.

getObjectImageBackgroundColor

Gets current value of property objectImageBackgroundColor.

Determines the background color of the image placeholder or icon if valid icon URI is provided.

Default value is Accent6.

getObjectImageDensityAware

Gets current value of property objectImageDensityAware.

The value of densityAware for the image, supplied via the objectImageURI property. See sap.m.Image for more details on densityAware.

Default value is false.

getObjectImageShape

Gets current value of property objectImageShape.

Determines whether the picture should be displayed in a square or with a circle-shaped mask.

Default value is Square.

getObjectImageURI

Gets current value of property objectImageURI.

The URL of the image, representing the business object

getObjectSubtitle

Gets current value of property objectSubtitle.

The description of the object

getObjectTitle

Gets current value of property objectTitle.

The title of the object

getShowMarkers

Gets current value of property showMarkers.

Indicates if object page header title supports showing markers such as flagged and favorite.

Default value is false.

getShowPlaceholder

Gets current value of property showPlaceholder.

Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.

Default value is false.

getShowTitleSelector

Gets current value of property showTitleSelector.

When set to true, the selector arrow icon/image is shown and can be pressed.

Default value is false.

getSideContentButton

Gets content of aggregation sideContentButton.

A button that is used for opening the side content of the page or some additional content.

getTitleSelectorTooltip

Gets content of aggregation titleSelectorTooltip.

A custom tooltip for the title selector button.

The custom tooltip will be visible if the showTitleSelector property is set to true.

Note: If the aggregation is destroyed or set to invalid value, the default tooltip will be set. The default tooltip text is "Related options".

indexOfAction

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

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

The action whose index is looked for

insertAction

Inserts a action into the aggregation actions.

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

The action to insert; if empty, nothing is inserted

iIndex int

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

removeAction

Removes a action from the aggregation actions.

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

The action to remove or its index or id

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

setBreadcrumbs

Sets the aggregated breadcrumbs.

Param Type DefaultValue Description
oBreadcrumbs sap.m.Breadcrumbs

The breadcrumbs to set

setHeaderDesign

Sets a new value for property headerDesign.

Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.

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

Default value is Light.

Param Type DefaultValue Description
sHeaderDesign sap.uxap.ObjectPageHeaderDesign Light

New value for property headerDesign

setIsActionAreaAlwaysVisible

Sets a new value for property isActionAreaAlwaysVisible.

Determines whether the action buttons should always be visible or visible only when the header is snapped.

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
bIsActionAreaAlwaysVisible boolean true

New value for property isActionAreaAlwaysVisible

setIsObjectIconAlwaysVisible

Sets a new value for property isObjectIconAlwaysVisible.

Determines whether the icon should always be visible or visible only when the header is snapped.

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
bIsObjectIconAlwaysVisible boolean false

New value for property isObjectIconAlwaysVisible

setIsObjectSubtitleAlwaysVisible

Sets a new value for property isObjectSubtitleAlwaysVisible.

Determines whether the subtitle should always be visible or visible only when the header is snapped.

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
bIsObjectSubtitleAlwaysVisible boolean true

New value for property isObjectSubtitleAlwaysVisible

setIsObjectTitleAlwaysVisible

Sets a new value for property isObjectTitleAlwaysVisible.

Determines whether the title should always be visible or visible only when the header is snapped.

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
bIsObjectTitleAlwaysVisible boolean true

New value for property isObjectTitleAlwaysVisible

setMarkChanges

Sets a new value for property markChanges.

Marks that there are unsaved changes in the objectPageHeader. The markChanges state cannot be used together with the markLocked state. If both are set to true, only the locked state will be displayed.

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
bMarkChanges boolean false

New value for property markChanges

setMarkFavorite

Sets a new value for property markFavorite.

Set the favorite state to true or false. The showMarkers property must be true for this property to take effect.

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
bMarkFavorite boolean false

New value for property markFavorite

setMarkFlagged

Sets a new value for property markFlagged.

Set the flagged state to true or false. The showMarkers property must be true for this property to take effect.

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
bMarkFlagged boolean false

New value for property markFlagged

setMarkLocked

Sets a new value for property markLocked.

Set the locked state of the objectPageHeader.

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
bMarkLocked boolean false

New value for property markLocked

setNavigationBar

Sets the aggregated navigationBar.

Param Type DefaultValue Description
oNavigationBar sap.m.Bar

The navigationBar to set

setObjectImageAlt

Sets a new value for property objectImageAlt.

The text to be used for the Alt and Tooltip attribute of the image, supplied via the objectImageURI property

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

Default value is empty string.

Param Type DefaultValue Description
sObjectImageAlt string ''

New value for property objectImageAlt

setObjectImageBackgroundColor

Sets a new value for property objectImageBackgroundColor.

Determines the background color of the image placeholder or icon if valid icon URI is provided.

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

Default value is Accent6.

Param Type DefaultValue Description
sObjectImageBackgroundColor sap.m.AvatarColor Accent6

New value for property objectImageBackgroundColor

setObjectImageDensityAware

Sets a new value for property objectImageDensityAware.

The value of densityAware for the image, supplied via the objectImageURI property. See sap.m.Image for more details on densityAware.

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
bObjectImageDensityAware boolean false

New value for property objectImageDensityAware

setObjectImageShape

Sets a new value for property objectImageShape.

Determines whether the picture should be displayed in a square or with a circle-shaped mask.

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

Default value is Square.

Param Type DefaultValue Description
sObjectImageShape sap.m.AvatarShape Square

New value for property objectImageShape

setObjectImageURI

Sets a new value for property objectImageURI.

The URL of the image, representing the business object

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

Param Type DefaultValue Description
sObjectImageURI string

New value for property objectImageURI

setObjectSubtitle

Sets a new value for property objectSubtitle.

The description of the object

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

Param Type DefaultValue Description
sObjectSubtitle string

New value for property objectSubtitle

setObjectTitle

Sets a new value for property objectTitle.

The title of the object

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

Param Type DefaultValue Description
sObjectTitle string

New value for property objectTitle

setShowMarkers

Sets a new value for property showMarkers.

Indicates if object page header title supports showing markers such as flagged and favorite.

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
bShowMarkers boolean false

New value for property showMarkers

setShowPlaceholder

Sets a new value for property showPlaceholder.

Enables support of a placeholder image in case no image is specified or the URL of the provided image is invalid.

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
bShowPlaceholder boolean false

New value for property showPlaceholder

setShowTitleSelector

Sets a new value for property showTitleSelector.

When set to true, the selector arrow icon/image is shown and can be pressed.

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
bShowTitleSelector boolean false

New value for property showTitleSelector

setSideContentButton

Sets the aggregated sideContentButton.

Param Type DefaultValue Description
oSideContentButton sap.m.Button

The sideContentButton to set

setTitleSelectorTooltip

Sets the aggregated titleSelectorTooltip.

Param Type DefaultValue Description
vTitleSelectorTooltip sap.ui.core.TooltipBase string

The titleSelectorTooltip to set