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

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

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.

addBreadCrumbLink(oBreadCrumbLink)Adds some breadCrumbLink to the aggregation breadCrumbsLinks.

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.

destroyBreadCrumbsLinks()Destroys all the breadCrumbsLinks in the aggregation breadCrumbsLinks.

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(mArguments?)Fires event markChangesPress to attached listeners.

fireMarkLockedPress(mArguments?)Fires event markLockedPress to attached listeners.

fireTitleSelectorPress(mArguments?)Fires event titleSelectorPress to attached listeners.

getActions()Gets content of aggregation actions.

getBreadCrumbsLinks()Gets content of aggregation breadCrumbsLinks.

getHeaderDesign()Gets current value of property headerDesign.

getIsActionAreaAlwaysVisible()Gets current value of property isActionAreaAlwaysVisible.

getIsObjectIconAlwaysVisible()Gets current value of property isObjectIconAlwaysVisible.

getIsObjectSubtitleAlwaysVisible()Gets current value of property isObjectSubtitleAlwaysVisible.

getIsObjectTitleAlwaysVisible()Gets current value of property isObjectTitleAlwaysVisible.

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.

indexOfBreadCrumbLink(oBreadCrumbLink)Checks for the provided sap.m.Link in the aggregation breadCrumbsLinks.

insertAction(oAction, iIndex)Inserts a action into the aggregation actions.

insertBreadCrumbLink(oBreadCrumbLink, iIndex)Inserts a breadCrumbLink into the aggregation breadCrumbsLinks.

removeAction(vAction)Removes a action from the aggregation actions.

removeAllActions()Removes all the controls from the aggregation actions.

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.

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.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

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

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.uxap.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:

Properties
- objectImageURI : string
- objectImageAlt : string (default: )
- objectImageDensityAware : boolean (default: false)
- objectTitle : string
- objectSubtitle : string
- objectImageShape : sap.uxap.ObjectPageHeaderPictureShape (default: Square)
- isObjectIconAlwaysVisible : boolean (default: false)
- isObjectTitleAlwaysVisible : boolean (default: true)
- isObjectSubtitleAlwaysVisible : boolean (default: true)
- isActionAreaAlwaysVisible : boolean (default: true)
- headerDesign : sap.uxap.ObjectPageHeaderDesign (default: Light)
- showTitleSelector : boolean (default: false)
- markFavorite : boolean (default: false)
- markFlagged : boolean (default: false)
- showMarkers : boolean (default: false)
- markLocked : boolean (default: false)
- showPlaceholder : boolean (default: false)
- markChanges : boolean (default: false)
Aggregations
- breadCrumbsLinks : sap.m.Link[]
- navigationBar : sap.m.Bar
- actions : sap.ui.core.Control[] (default)
- sideContentButton : sap.m.Button
Events
- titleSelectorPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- markLockedPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- markChangesPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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

Parameters:

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

Event Detail

markChangesPress(oControlEvent)

The event is fired when the unsaved changes button is pressed

Parameters:

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

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

Returns:

{function}

Created class / constructor function

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addAction(oAction): sap.uxap.ObjectPageHeader

Adds some action to the aggregation actions.

Parameters:

{sap.ui.core.Control}

oAction

the action to add; if empty, nothing is inserted

Returns:

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

addBreadCrumbLink(oBreadCrumbLink): sap.uxap.ObjectPageHeader

Adds some breadCrumbLink to the aggregation breadCrumbsLinks.

Parameters:

{sap.m.Link}

oBreadCrumbLink

the breadCrumbLink to add; if empty, nothing is inserted

Returns:

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

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

Returns:

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

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

Returns:

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

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

Returns:

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

destroyActions(): sap.uxap.ObjectPageHeader

Destroys all the actions in the aggregation actions.

Returns:

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

destroyBreadCrumbsLinks(): sap.uxap.ObjectPageHeader

Destroys all the breadCrumbsLinks in the aggregation breadCrumbsLinks.

Returns:

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

destroyNavigationBar(): sap.uxap.ObjectPageHeader

Destroys the navigationBar in the aggregation navigationBar.

Returns:

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

destroySideContentButton(): sap.uxap.ObjectPageHeader

Destroys the sideContentButton in the aggregation sideContentButton.

Since:: 1.38.0

Returns:

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

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:

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

Returns:

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

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

Returns:

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

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

Returns:

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

fireMarkChangesPress(mArguments?): sap.uxap.ObjectPageHeader

Fires event markChangesPress to attached listeners.

Expects the following event parameters:

domRef of type stringDOM reference of the changed item's icon to be used for positioning.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

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

fireMarkLockedPress(mArguments?): sap.uxap.ObjectPageHeader

Fires event markLockedPress to attached listeners.

Expects the following event parameters:

domRef of type stringDOM reference of the lock item's icon to be used for positioning.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

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

fireTitleSelectorPress(mArguments?): sap.uxap.ObjectPageHeader

Fires event titleSelectorPress to attached listeners.

Expects the following event parameters:

domRef of type stringDOM reference of the title item's icon to be used for positioning.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.uxap.ObjectPageHeader} Reference 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[]}

getBreadCrumbsLinks(): sap.m.Link[]

Gets content of aggregation breadCrumbsLinks.

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

Returns:

{sap.m.Link[]}

getHeaderDesign(): sap.uxap.ObjectPageHeaderDesign

Gets current value of property headerDesign.

Determines the design of the header - Light or Dark

Default value is Light.

Returns:

{sap.uxap.ObjectPageHeaderDesign} Value of property headerDesign

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:

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

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

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

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

Since:: 1.34.0

Returns:

{boolean} Value of property markChanges

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:

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

{boolean} Value of property markFlagged

getMarkLocked(): boolean

Gets current value of property markLocked.

Set the locked state of the objectPageHeader.

Default value is false.

Returns:

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

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

{boolean} Value of property objectImageDensityAware

getObjectImageShape(): sap.uxap.ObjectPageHeaderPictureShape

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.ObjectPageHeaderPictureShape} Value of property objectImageShape

getObjectImageURI(): string

Gets current value of property objectImageURI.

The URL of the image, representing the business object

Returns:

{string} Value of property objectImageURI

getObjectSubtitle(): string

Gets current value of property objectSubtitle.

The description of the object

Returns:

{string} Value of property objectSubtitle

getObjectTitle(): string

Gets current value of property objectTitle.

The title of the object

Returns:

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

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

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

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

Since:: 1.38.0

Returns:

{sap.m.Button}

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

oAction

The action whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfBreadCrumbLink(oBreadCrumbLink): int

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

Parameters:

{sap.m.Link}

oBreadCrumbLink

The breadCrumbLink whose index is looked for

Returns:

{int}

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

Returns:

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

insertBreadCrumbLink(oBreadCrumbLink, iIndex): sap.uxap.ObjectPageHeader

Inserts a breadCrumbLink into the aggregation breadCrumbsLinks.

Parameters:

{sap.m.Link}	oBreadCrumbLink	the breadCrumbLink to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the breadCrumbLink should be inserted at; for a negative value of `iIndex`, the breadCrumbLink is inserted at position 0; for a value greater than the current size of the aggregation, the breadCrumbLink is inserted at the last position

Returns:

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

vAction

The actionto remove or its index or id

Returns:

{sap.ui.core.Control} The 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)

removeAllBreadCrumbsLinks(): sap.m.Link[]

Removes all the controls from the aggregation breadCrumbsLinks.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.m.Link[]}

An array of the removed elements (might be empty)

removeBreadCrumbLink(vBreadCrumbLink): sap.m.Link

Removes a breadCrumbLink from the aggregation breadCrumbsLinks.

Parameters:

{int|string|sap.m.Link}

vBreadCrumbLink

The breadCrumbLinkto remove or its index or id

Returns:

{sap.m.Link} The removed breadCrumbLink or null

setHeaderDesign(sHeaderDesign): sap.uxap.ObjectPageHeader

Sets a new value for property headerDesign.

Determines the design of the header - Light or Dark

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.ObjectPageHeaderDesign} sHeaderDesign New value for property headerDesign

Returns:

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

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:

{boolean} bIsActionAreaAlwaysVisible New value for property isActionAreaAlwaysVisible

Returns:

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

{boolean} bIsObjectIconAlwaysVisible New value for property isObjectIconAlwaysVisible

Returns:

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

{boolean} bIsObjectSubtitleAlwaysVisible New value for property isObjectSubtitleAlwaysVisible

Returns:

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

{boolean} bIsObjectTitleAlwaysVisible New value for property isObjectTitleAlwaysVisible

Returns:

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

setMarkChanges(bMarkChanges): sap.uxap.ObjectPageHeader

Sets a new value for property markChanges.

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

Default value is false.

Parameters:

{boolean} bMarkChanges New value for property markChanges

Since:: 1.34.0

Returns:

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

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:

{boolean} bMarkFavorite New value for property markFavorite

Returns:

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

{boolean} bMarkFlagged New value for property markFlagged

Returns:

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

{boolean} bMarkLocked New value for property markLocked

Returns:

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

{string} sObjectImageAlt New value for property objectImageAlt

Returns:

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

{boolean} bObjectImageDensityAware New value for property objectImageDensityAware

Returns:

{sap.uxap.ObjectPageHeader} Reference 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.ObjectPageHeaderPictureShape} sObjectImageShape New value for property objectImageShape

Returns:

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

{string} sObjectImageURI New value for property objectImageURI

Returns:

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

{string} sObjectSubtitle New value for property objectSubtitle

Returns:

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

{boolean} bShowMarkers New value for property showMarkers

Returns:

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

{boolean} bShowPlaceholder New value for property showPlaceholder

Returns:

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

{boolean} bShowTitleSelector New value for property showTitleSelector

Returns:

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

setSideContentButton(oSideContentButton): sap.uxap.ObjectPageHeader

Sets the aggregated sideContentButton.

Parameters:

{sap.m.Button}

oSideContentButton

The sideContentButton to set

Since:: 1.38.0

Returns:

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