Class sap.uxap.ObjectPageHeaderModule: sap/uxap/ObjectPageHeader

extends Control

ObjectPageHeader represents the static part of an Object page header. Typically used to display the basic information about a business object, such as title/description/picture, as well as a list of common actions.
Since: 1.26.
Constructor Summary
new sap.uxap.ObjectPageHeader(sId?, mSettings?)Constructor for a new ObjectPageHeader.
Event Summary
markChangesPress(oControlEvent)The event is fired when the unsaved changes button is pressed
markLockedPress(oControlEvent)The event is fired when the Locked button is pressed
titleSelectorPress(oControlEvent)The event is fired when the objectPage header title selector (down-arrow) is pressed
Events borrowed from class sap.ui.core.Control
Method Summary
sap.uxap.ObjectPageHeader.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageHeader with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageHeader.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageHeader.
addAction(oAction)Adds some action to the aggregation actions.
attachMarkChangesPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the markChangesPress event of this sap.uxap.ObjectPageHeader.
attachMarkLockedPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the markLockedPress event of this sap.uxap.ObjectPageHeader.
attachTitleSelectorPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the titleSelectorPress event of this sap.uxap.ObjectPageHeader.
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.
detachMarkChangesPress(fnFunction, oListener)Detaches event handler fnFunction from the markChangesPress event of this sap.uxap.ObjectPageHeader.
detachMarkLockedPress(fnFunction, oListener)Detaches event handler fnFunction from the markLockedPress event of this sap.uxap.ObjectPageHeader.
detachTitleSelectorPress(fnFunction, oListener)Detaches event handler fnFunction from the titleSelectorPress event of this sap.uxap.ObjectPageHeader.
fireMarkChangesPress(mParameters?)Fires event markChangesPress to attached listeners.
fireMarkLockedPress(mParameters?)Fires event markLockedPress to attached listeners.
fireTitleSelectorPress(mParameters?)Fires event titleSelectorPress to attached listeners.
getActions()Gets content of aggregation actions.
getBreadcrumbs()Gets content of aggregation breadcrumbs.
getMarkChanges()Gets current value of property markChanges.
getMarkFavorite()Gets current value of property markFavorite.
getMarkFlagged()Gets current value of property markFlagged.
getMarkLocked()Gets current value of property markLocked.
getNavigationBar()Gets content of aggregation navigationBar.
getObjectImageAlt()Gets current value of property objectImageAlt.
getObjectImageDensityAware()Gets current value of property objectImageDensityAware.
getObjectImageShape()Gets current value of property objectImageShape.
getObjectImageURI()Gets current value of property objectImageURI.
getObjectSubtitle()Gets current value of property objectSubtitle.
getObjectTitle()Gets current value of property objectTitle.
getShowMarkers()Gets current value of property showMarkers.
getShowPlaceholder()Gets current value of property showPlaceholder.
getShowTitleSelector()Gets current value of property showTitleSelector.
getSideContentButton()Gets content of aggregation sideContentButton.
indexOfAction(oAction)Checks for the provided sap.ui.core.Control in the aggregation actions.
insertAction(oAction, iIndex)Inserts a action into the aggregation actions.
removeAction(vAction)Removes a action from the aggregation actions.
removeAllActions()Removes all the controls from the aggregation actions.
setBreadcrumbs(oBreadcrumbs)Sets the aggregated breadcrumbs.
setIsActionAreaAlwaysVisible(bIsActionAreaAlwaysVisible)Sets a new value for property isActionAreaAlwaysVisible.
setIsObjectIconAlwaysVisible(bIsObjectIconAlwaysVisible)Sets a new value for property isObjectIconAlwaysVisible.
setIsObjectSubtitleAlwaysVisible(bIsObjectSubtitleAlwaysVisible)Sets a new value for property isObjectSubtitleAlwaysVisible.
setIsObjectTitleAlwaysVisible(bIsObjectTitleAlwaysVisible)Sets a new value for property isObjectTitleAlwaysVisible.
setMarkChanges(bMarkChanges)Sets a new value for property markChanges.
setMarkFavorite(bMarkFavorite)Sets a new value for property markFavorite.
setMarkFlagged(bMarkFlagged)Sets a new value for property markFlagged.
setMarkLocked(bMarkLocked)Sets a new value for property markLocked.
setObjectImageAlt(sObjectImageAlt)Sets a new value for property objectImageAlt.
setObjectImageDensityAware(bObjectImageDensityAware)Sets a new value for property objectImageDensityAware.
setObjectImageShape(sObjectImageShape)Sets a new value for property objectImageShape.
setObjectImageURI(sObjectImageURI)Sets a new value for property objectImageURI.
setObjectSubtitle(sObjectSubtitle)Sets a new value for property objectSubtitle.
setShowMarkers(bShowMarkers)Sets a new value for property showMarkers.
setShowPlaceholder(bShowPlaceholder)Sets a new value for property showPlaceholder.
setShowTitleSelector(bShowTitleSelector)Sets a new value for property showTitleSelector.
setSideContentButton(oSideContentButton)Sets the aggregated sideContentButton.
addBreadCrumbLink(oBreadCrumbLink)Adds some breadCrumbLink to the aggregation breadCrumbsLinks.
destroyBreadCrumbsLinks()Destroys all the breadCrumbsLinks in the aggregation breadCrumbsLinks.
getBreadCrumbsLinks()Gets content of aggregation breadCrumbsLinks.
getHeaderDesign()Gets current value of property headerDesign.
indexOfBreadCrumbLink(oBreadCrumbLink)Checks for the provided sap.m.Link in the aggregation breadCrumbsLinks.
insertBreadCrumbLink(oBreadCrumbLink, iIndex)Inserts a breadCrumbLink into the aggregation breadCrumbsLinks.
removeAllBreadCrumbsLinks()Removes all the controls from the aggregation breadCrumbsLinks.
removeBreadCrumbLink(vBreadCrumbLink)Removes a breadCrumbLink from the aggregation breadCrumbsLinks.
setHeaderDesign(sHeaderDesign)Sets a new value for property headerDesign.
Constructor Detail
new sap.uxap.ObjectPageHeader(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

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

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
markChangesPress(oControlEvent)
The event is fired when the unsaved changes button is pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.domRefDOM reference of the changed item's icon to be used for positioning.
markLockedPress(oControlEvent)
The event is fired when the Locked button is pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.domRefDOM reference of the lock item's icon to be used for positioning.
titleSelectorPress(oControlEvent)
The event is fired when the objectPage header title selector (down-arrow) is pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.domRefDOM reference of the title item's icon to be used for positioning.
Method Detail
sap.uxap.ObjectPageHeader.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.uxap.ObjectPageHeader.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageHeader.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAction(oAction): sap.uxap.ObjectPageHeader
Adds some action to the aggregation actions.
Parameters:
sap.ui.core.ControloActionthe action to add; if empty, nothing is inserted
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
attachMarkChangesPress(oData?, fnFunction, oListener?): sap.uxap.ObjectPageHeader

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

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader itself
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
attachMarkLockedPress(oData?, fnFunction, oListener?): sap.uxap.ObjectPageHeader

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

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader itself
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
attachTitleSelectorPress(oData?, fnFunction, oListener?): sap.uxap.ObjectPageHeader

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

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.uxap.ObjectPageHeader itself
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
destroyActions(): sap.uxap.ObjectPageHeader
Destroys all the actions in the aggregation actions.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
destroyBreadcrumbs(): sap.uxap.ObjectPageHeader
Destroys the breadcrumbs in the aggregation breadcrumbs.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
Since:
1.50
destroyNavigationBar(): sap.uxap.ObjectPageHeader
Destroys the navigationBar in the aggregation navigationBar.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
destroySideContentButton(): sap.uxap.ObjectPageHeader
Destroys the sideContentButton in the aggregation sideContentButton.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
Since:
1.38.0
detachMarkChangesPress(fnFunction, oListener): sap.uxap.ObjectPageHeader

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.

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

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.

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

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
fireMarkChangesPress(mParameters?): sap.uxap.ObjectPageHeader
Fires event markChangesPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.domRef?DOM reference of the changed item's icon to be used for positioning.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
fireMarkLockedPress(mParameters?): sap.uxap.ObjectPageHeader
Fires event markLockedPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.domRef?DOM reference of the lock item's icon to be used for positioning.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
fireTitleSelectorPress(mParameters?): sap.uxap.ObjectPageHeader
Fires event titleSelectorPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.domRef?DOM reference of the title item's icon to be used for positioning.
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
getActions(): sap.ui.core.Control[]

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.

Returns:
sap.ui.core.Control[]
getBreadcrumbs(): sap.m.Breadcrumbs

Gets content of aggregation breadcrumbs.

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

Returns:
sap.m.Breadcrumbs
Since:
1.50
getIsActionAreaAlwaysVisible(): boolean

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.

Returns:
booleanValue of property isActionAreaAlwaysVisible
getIsObjectIconAlwaysVisible(): boolean

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.

Returns:
booleanValue of property isObjectIconAlwaysVisible
getIsObjectSubtitleAlwaysVisible(): boolean

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.

Returns:
booleanValue of property isObjectSubtitleAlwaysVisible
getIsObjectTitleAlwaysVisible(): boolean

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.

Returns:
booleanValue of property isObjectTitleAlwaysVisible
getMarkChanges(): boolean

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.

Returns:
booleanValue of property markChanges
Since:
1.34.0
getMarkFavorite(): boolean

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.

Returns:
booleanValue of property markFavorite
getMarkFlagged(): boolean

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.

Returns:
booleanValue of property markFlagged
getMarkLocked(): boolean

Gets current value of property markLocked.

Set the locked state of the objectPageHeader.

Default value is false.

Returns:
booleanValue of property markLocked
getNavigationBar(): sap.m.Bar

Gets content of aggregation navigationBar.

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

Returns:
sap.m.Bar
getObjectImageAlt(): string

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 .

Returns:
stringValue of property objectImageAlt
getObjectImageDensityAware(): boolean

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.

Returns:
booleanValue of property objectImageDensityAware

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.

Returns:
sap.uxap.ObjectPageHeaderPictureShapeValue of property objectImageShape
getObjectImageURI(): string

Gets current value of property objectImageURI.

The URL of the image, representing the business object

Returns:
stringValue of property objectImageURI
getObjectSubtitle(): string

Gets current value of property objectSubtitle.

The description of the object

Returns:
stringValue of property objectSubtitle
getObjectTitle(): string

Gets current value of property objectTitle.

The title of the object

Returns:
stringValue of property objectTitle
getShowMarkers(): boolean

Gets current value of property showMarkers.

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

Default value is false.

Returns:
booleanValue of property showMarkers
getShowPlaceholder(): boolean

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.

Returns:
booleanValue of property showPlaceholder
getShowTitleSelector(): boolean

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.

Returns:
booleanValue of property showTitleSelector
getSideContentButton(): sap.m.Button

Gets content of aggregation sideContentButton.

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

Returns:
sap.m.Button
Since:
1.38.0
indexOfAction(oAction): int
Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloActionThe action whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertAction(oAction, iIndex): sap.uxap.ObjectPageHeader
Inserts a action into the aggregation actions.
Parameters:
sap.ui.core.ControloActionthe action to insert; if empty, nothing is inserted
intiIndexthe 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
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
removeAction(vAction): sap.ui.core.Control
Removes a action from the aggregation actions.
Parameters:
int|string|sap.ui.core.ControlvActionThe action to remove or its index or id
Returns:
sap.ui.core.ControlThe removed action or null
removeAllActions(): sap.ui.core.Control[]

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
setBreadcrumbs(oBreadcrumbs): sap.uxap.ObjectPageHeader
Sets the aggregated breadcrumbs.
Parameters:
sap.m.BreadcrumbsoBreadcrumbsThe breadcrumbs to set
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
Since:
1.50
setIsActionAreaAlwaysVisible(bIsActionAreaAlwaysVisible): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbIsActionAreaAlwaysVisibleNew value for property isActionAreaAlwaysVisible
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setIsObjectIconAlwaysVisible(bIsObjectIconAlwaysVisible): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbIsObjectIconAlwaysVisibleNew value for property isObjectIconAlwaysVisible
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setIsObjectSubtitleAlwaysVisible(bIsObjectSubtitleAlwaysVisible): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbIsObjectSubtitleAlwaysVisibleNew value for property isObjectSubtitleAlwaysVisible
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setIsObjectTitleAlwaysVisible(bIsObjectTitleAlwaysVisible): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbIsObjectTitleAlwaysVisibleNew value for property isObjectTitleAlwaysVisible
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setMarkChanges(bMarkChanges): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbMarkChangesNew value for property markChanges
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
Since:
1.34.0
setMarkFavorite(bMarkFavorite): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbMarkFavoriteNew value for property markFavorite
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setMarkFlagged(bMarkFlagged): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbMarkFlaggedNew value for property markFlagged
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setMarkLocked(bMarkLocked): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbMarkLockedNew value for property markLocked
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setObjectImageAlt(sObjectImageAlt): sap.uxap.ObjectPageHeader

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 .

Parameters:
stringsObjectImageAltNew value for property objectImageAlt
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setObjectImageDensityAware(bObjectImageDensityAware): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbObjectImageDensityAwareNew value for property objectImageDensityAware
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setObjectImageShape(sObjectImageShape): sap.uxap.ObjectPageHeader

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.

Parameters:
sap.uxap.ObjectPageHeaderPictureShapesObjectImageShapeNew value for property objectImageShape
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setObjectImageURI(sObjectImageURI): sap.uxap.ObjectPageHeader

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.

Parameters:
stringsObjectImageURINew value for property objectImageURI
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setObjectSubtitle(sObjectSubtitle): sap.uxap.ObjectPageHeader

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.

Parameters:
stringsObjectSubtitleNew value for property objectSubtitle
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setShowMarkers(bShowMarkers): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbShowMarkersNew value for property showMarkers
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setShowPlaceholder(bShowPlaceholder): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbShowPlaceholderNew value for property showPlaceholder
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setShowTitleSelector(bShowTitleSelector): sap.uxap.ObjectPageHeader

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.

Parameters:
booleanbShowTitleSelectorNew value for property showTitleSelector
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
setSideContentButton(oSideContentButton): sap.uxap.ObjectPageHeader
Sets the aggregated sideContentButton.
Parameters:
sap.m.ButtonoSideContentButtonThe sideContentButton to set
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
Since:
1.38.0

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.

Returns:
sap.uxap.ObjectPageHeaderDesignValue of property headerDesign
Deprecated API:
Since version 1.40.1
setHeaderDesign(sHeaderDesign): sap.uxap.ObjectPageHeader

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.

Parameters:
sap.uxap.ObjectPageHeaderDesignsHeaderDesignNew value for property headerDesign
Returns:
sap.uxap.ObjectPageHeaderReference to this in order to allow method chaining
Deprecated API:
Since version 1.40.1