Class sap.m.ObjectHeaderModule: sap/m/ObjectHeader

extends Control

ObjectHeader is a display control that enables the user to easily identify a specific object. The object header title is the key identifier of the object and additional text and icons can be used to further distinguish it from other objects.
Since: 1.12.
Constructor Summary
new sap.m.ObjectHeader(sId?, mSettings?)Constructor for a new ObjectHeader.
Event Summary
iconPress(oControlEvent)Event is fired when the title icon is active and the user taps/clicks on it
introPress(oControlEvent)Event is fired when the intro is active and the user taps/clicks on it
titlePress(oControlEvent)Event is fired when the title is active and the user taps/clicks on it
titleSelectorPress(oControlEvent)Event is fired when the object header title selector (down-arrow) is pressed
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.ObjectHeader.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ObjectHeader with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ObjectHeader.getMetadata()Returns a metadata object for class sap.m.ObjectHeader.
addAdditionalNumber(oAdditionalNumber)Adds some additionalNumber to the aggregation additionalNumbers.
addAriaDescribedBy(vAriaDescribedBy)Adds some ariaDescribedBy into the association ariaDescribedBy.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addAttribute(oAttribute)Adds some attribute to the aggregation attributes.
addMarker(oMarker)Adds some marker to the aggregation markers.
addStatus(oStatus)Adds some status to the aggregation statuses.
attachIconPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the iconPress event of this sap.m.ObjectHeader.
attachIntroPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the introPress event of this sap.m.ObjectHeader.
attachTitlePress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the titlePress event of this sap.m.ObjectHeader.
attachTitleSelectorPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the titleSelectorPress event of this sap.m.ObjectHeader.
destroyAdditionalNumbers()Destroys all the additionalNumbers in the aggregation additionalNumbers.
destroyAttributes()Destroys all the attributes in the aggregation attributes.
destroyHeaderContainer()Destroys the headerContainer in the aggregation headerContainer.
destroyMarkers()Destroys all the markers in the aggregation markers.
destroyStatuses()Destroys all the statuses in the aggregation statuses.
detachIconPress(fnFunction, oListener)Detaches event handler fnFunction from the iconPress event of this sap.m.ObjectHeader.
detachIntroPress(fnFunction, oListener)Detaches event handler fnFunction from the introPress event of this sap.m.ObjectHeader.
detachTitlePress(fnFunction, oListener)Detaches event handler fnFunction from the titlePress event of this sap.m.ObjectHeader.
detachTitleSelectorPress(fnFunction, oListener)Detaches event handler fnFunction from the titleSelectorPress event of this sap.m.ObjectHeader.
fireIconPress(mParameters?)Fires event iconPress to attached listeners.
fireIntroPress(mParameters?)Fires event introPress to attached listeners.
fireTitlePress(mParameters?)Fires event titlePress to attached listeners.
fireTitleSelectorPress(mParameters?)Fires event titleSelectorPress to attached listeners.
getAdditionalNumbers()Gets content of aggregation additionalNumbers.
getAriaDescribedBy()Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getAttributes()Gets content of aggregation attributes.
getBackgroundDesign()Gets current value of property backgroundDesign.
getCondensed()Gets current value of property condensed.
getFullScreenOptimized()Gets current value of property fullScreenOptimized.
getHeaderContainer()Gets content of aggregation headerContainer.
getIcon()Gets current value of property icon.
getIconActive()Gets current value of property iconActive.
getIconAlt()Gets current value of property iconAlt.
getIconDensityAware()Gets current value of property iconDensityAware.
getIconTooltip()Gets current value of property iconTooltip.
getIntro()Gets current value of property intro.
getIntroActive()Gets current value of property introActive.
getIntroHref()Gets current value of property introHref.
getIntroTarget()Gets current value of property introTarget.
getIntroTextDirection()Gets current value of property introTextDirection.
getMarkers()Gets content of aggregation markers.
getNumber()Gets current value of property number.
getNumberState()Gets current value of property numberState.
getNumberTextDirection()Gets current value of property numberTextDirection.
getNumberUnit()Gets current value of property numberUnit.
getResponsive()Gets current value of property responsive.
getShowTitleSelector()Gets current value of property showTitleSelector.
getStatuses()Gets content of aggregation statuses.
getTitle()Gets current value of property title.
getTitleActive()Gets current value of property titleActive.
getTitleHref()Gets current value of property titleHref.
getTitleLevel()Gets current value of property titleLevel.
getTitleSelectorTooltip()Gets current value of property titleSelectorTooltip.
getTitleTarget()Gets current value of property titleTarget.
getTitleTextDirection()Gets current value of property titleTextDirection.
indexOfAdditionalNumber(oAdditionalNumber)Checks for the provided sap.m.ObjectNumber in the aggregation additionalNumbers.
indexOfAttribute(oAttribute)Checks for the provided sap.m.ObjectAttribute in the aggregation attributes.
indexOfMarker(oMarker)Checks for the provided sap.m.ObjectMarker in the aggregation markers.
indexOfStatus(oStatus)Checks for the provided sap.ui.core.Control in the aggregation statuses.
insertAdditionalNumber(oAdditionalNumber, iIndex)Inserts a additionalNumber into the aggregation additionalNumbers.
insertAttribute(oAttribute, iIndex)Inserts a attribute into the aggregation attributes.
insertMarker(oMarker, iIndex)Inserts a marker into the aggregation markers.
insertStatus(oStatus, iIndex)Inserts a status into the aggregation statuses.
removeAdditionalNumber(vAdditionalNumber)Removes a additionalNumber from the aggregation additionalNumbers.
removeAllAdditionalNumbers()Removes all the controls from the aggregation additionalNumbers.
removeAllAriaDescribedBy()Removes all the controls in the association named ariaDescribedBy.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllAttributes()Removes all the controls from the aggregation attributes.
removeAllMarkers()Removes all the controls from the aggregation markers.
removeAllStatuses()Removes all the controls from the aggregation statuses.
removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeAttribute(vAttribute)Removes a attribute from the aggregation attributes.
removeMarker(vMarker)Removes a marker from the aggregation markers.
removeStatus(vStatus)Removes a status from the aggregation statuses.
setBackgroundDesign(sBackgroundDesign)Sets a new value for property backgroundDesign.
setCondensed(bCondensed)Set the condensed flag
setFullScreenOptimized(bFullScreenOptimized)Sets a new value for property fullScreenOptimized.
setHeaderContainer(oHeaderContainer)Sets the aggregated headerContainer.
setIcon(sIcon)Sets a new value for property icon.
setIconActive(bIconActive)Sets a new value for property iconActive.
setIconAlt(sIconAlt)Sets a new value for property iconAlt.
setIconDensityAware(bIconDensityAware)Sets a new value for property iconDensityAware.
setIconTooltip(sIconTooltip)Sets a new value for property iconTooltip.
setIntro(sIntro)Sets a new value for property intro.
setIntroActive(bIntroActive)Sets a new value for property introActive.
setIntroHref(sIntroHref)Sets a new value for property introHref.
setIntroTarget(sIntroTarget)Sets a new value for property introTarget.
setIntroTextDirection(sIntroTextDirection)Sets a new value for property introTextDirection.
setMarkFavorite(bMarked)Sets the visibility value of the Favorite marker.
setMarkFlagged(bMarked)Sets the visibility value of the Flagged marker.
setNumber(sNumber)Set the number value to the internal aggregation
setNumberState(sState)Set the number state to the internal aggregation
setNumberTextDirection(sNumberTextDirection)Sets a new value for property numberTextDirection.
setNumberUnit(sUnit)Set the number unit to the internal aggregation
setResponsive(bResponsive)Sets a new value for property responsive.
setShowMarkers(bMarked)Sets the visibility value of the Flagged and Favorite markers.
setShowTitleSelector(bShowTitleSelector)Sets a new value for property showTitleSelector.
setTitle(sTitle)Sets a new value for property title.
setTitleActive(bTitleActive)Sets a new value for property titleActive.
setTitleHref(sTitleHref)Sets a new value for property titleHref.
setTitleLevel(sTitleLevel)Sets a new value for property titleLevel.
setTitleSelectorTooltip(sTooltip)Sets the new text for the tooltip of the select title arrow to the internal aggregation
setTitleTarget(sTitleTarget)Sets a new value for property titleTarget.
setTitleTextDirection(sTitleTextDirection)Sets a new value for property titleTextDirection.
destroyFirstStatus()Destroys the firstStatus in the aggregation firstStatus.
destroySecondStatus()Destroys the secondStatus in the aggregation secondStatus.
getFirstStatus()Gets content of aggregation firstStatus.
getMarkFavorite()Gets current value of property markFavorite.
getMarkFlagged()Gets current value of property markFlagged.
getSecondStatus()Gets content of aggregation secondStatus.
getShowMarkers()Gets current value of property showMarkers.
setFirstStatus(oFirstStatus)Sets the aggregated firstStatus.
setSecondStatus(oSecondStatus)Sets the aggregated secondStatus.
Constructor Detail
new sap.m.ObjectHeader(sId?, mSettings?)

Constructor for a new ObjectHeader.

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
iconPress(oControlEvent)
Event is fired when the title icon is active and the user taps/clicks on it
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
objectoControlEvent.getParameters.domRefDom reference of the object header' icon to be used for positioning.
introPress(oControlEvent)
Event is fired when the intro is active and the user taps/clicks on it
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
objectoControlEvent.getParameters.domRefDom reference of the object header' intro to be used for positioning.
titlePress(oControlEvent)
Event is fired when the title is active and the user taps/clicks on it
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
objectoControlEvent.getParameters.domRefDom reference of the object header' title to be used for positioning.
titleSelectorPress(oControlEvent)
Event is fired when the object header title selector (down-arrow) is pressed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
objectoControlEvent.getParameters.domRefDom reference of the object header' titleArrow to be used for positioning.
Since:
1.16.0
Method Detail
sap.m.ObjectHeader.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.ObjectHeader 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.m.ObjectHeader.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ObjectHeader.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAdditionalNumber(oAdditionalNumber): sap.m.ObjectHeader
Adds some additionalNumber to the aggregation additionalNumbers.
Parameters:
sap.m.ObjectNumberoAdditionalNumberthe additionalNumber to add; if empty, nothing is inserted
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.38.0
addAriaDescribedBy(vAriaDescribedBy): sap.m.ObjectHeader
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaDescribedBythe ariaDescribedBy to add; if empty, nothing is inserted
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.m.ObjectHeader
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
addAttribute(oAttribute): sap.m.ObjectHeader
Adds some attribute to the aggregation attributes.
Parameters:
sap.m.ObjectAttributeoAttributethe attribute to add; if empty, nothing is inserted
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
addMarker(oMarker): sap.m.ObjectHeader
Adds some marker to the aggregation markers.
Parameters:
sap.m.ObjectMarkeroMarkerthe marker to add; if empty, nothing is inserted
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
addStatus(oStatus): sap.m.ObjectHeader
Adds some status to the aggregation statuses.
Parameters:
sap.ui.core.ControloStatusthe status to add; if empty, nothing is inserted
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
attachIconPress(oData?, fnFunction, oListener?): sap.m.ObjectHeader

Attaches event handler fnFunction to the iconPress event of this sap.m.ObjectHeader.

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.m.ObjectHeader itself.

Event is fired when the title icon is active and the user taps/clicks on it

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.m.ObjectHeader itself
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
attachIntroPress(oData?, fnFunction, oListener?): sap.m.ObjectHeader

Attaches event handler fnFunction to the introPress event of this sap.m.ObjectHeader.

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.m.ObjectHeader itself.

Event is fired when the intro is active and the user taps/clicks on it

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.m.ObjectHeader itself
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
attachTitlePress(oData?, fnFunction, oListener?): sap.m.ObjectHeader

Attaches event handler fnFunction to the titlePress event of this sap.m.ObjectHeader.

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.m.ObjectHeader itself.

Event is fired when the title is active and the user taps/clicks on it

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.m.ObjectHeader itself
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
attachTitleSelectorPress(oData?, fnFunction, oListener?): sap.m.ObjectHeader

Attaches event handler fnFunction to the titleSelectorPress event of this sap.m.ObjectHeader.

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.m.ObjectHeader itself.

Event is fired when the object 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.m.ObjectHeader itself
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
destroyAdditionalNumbers(): sap.m.ObjectHeader
Destroys all the additionalNumbers in the aggregation additionalNumbers.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.38.0
destroyAttributes(): sap.m.ObjectHeader
Destroys all the attributes in the aggregation attributes.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
destroyHeaderContainer(): sap.m.ObjectHeader
Destroys the headerContainer in the aggregation headerContainer.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.21.1
destroyMarkers(): sap.m.ObjectHeader
Destroys all the markers in the aggregation markers.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
destroyStatuses(): sap.m.ObjectHeader
Destroys all the statuses in the aggregation statuses.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
detachIconPress(fnFunction, oListener): sap.m.ObjectHeader

Detaches event handler fnFunction from the iconPress event of this sap.m.ObjectHeader.

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.m.ObjectHeaderReference to this in order to allow method chaining
detachIntroPress(fnFunction, oListener): sap.m.ObjectHeader

Detaches event handler fnFunction from the introPress event of this sap.m.ObjectHeader.

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.m.ObjectHeaderReference to this in order to allow method chaining
detachTitlePress(fnFunction, oListener): sap.m.ObjectHeader

Detaches event handler fnFunction from the titlePress event of this sap.m.ObjectHeader.

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.m.ObjectHeaderReference to this in order to allow method chaining
detachTitleSelectorPress(fnFunction, oListener): sap.m.ObjectHeader

Detaches event handler fnFunction from the titleSelectorPress event of this sap.m.ObjectHeader.

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.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
fireIconPress(mParameters?): sap.m.ObjectHeader
Fires event iconPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
objectmParameters.domRef?Dom reference of the object header' icon to be used for positioning.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
fireIntroPress(mParameters?): sap.m.ObjectHeader
Fires event introPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
objectmParameters.domRef?Dom reference of the object header' intro to be used for positioning.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
fireTitlePress(mParameters?): sap.m.ObjectHeader
Fires event titlePress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
objectmParameters.domRef?Dom reference of the object header' title to be used for positioning.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
fireTitleSelectorPress(mParameters?): sap.m.ObjectHeader
Fires event titleSelectorPress to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
objectmParameters.domRef?Dom reference of the object header' titleArrow to be used for positioning.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
getAdditionalNumbers(): sap.m.ObjectNumber[]

Gets content of aggregation additionalNumbers.

NOTE: Only applied if you set "responsive=false". Additional object numbers and units are managed in this aggregation. The numbers are hidden on tablet and phone size screens. When only one number is provided, it is rendered with additional separator from the main ObjectHeader number.

Returns:
sap.m.ObjectNumber[]
Since:
1.38.0
getAriaDescribedBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
sap.ui.core.ID[]
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
getAttributes(): sap.m.ObjectAttribute[]

Gets content of aggregation attributes.

The list of Object Attributes

Returns:
sap.m.ObjectAttribute[]
getBackgroundDesign(): sap.m.BackgroundDesign

Gets current value of property backgroundDesign.

Determines the background color of the ObjectHeader.

Note: The different types of ObjectHeader come with different default background:

  • non responsive - Transparent
  • responsive - Translucent
  • condensed - Solid
Returns:
sap.m.BackgroundDesignValue of property backgroundDesign
getCondensed(): boolean

Gets current value of property condensed.

ObjectHeader with title, one attribute, number, and number unit.

Note: Only applied if the responsive property is set to false.

Default value is false.

Returns:
booleanValue of property condensed
getFullScreenOptimized(): boolean

Gets current value of property fullScreenOptimized.

Optimizes the display of the elements of the ObjectHeader.

Set this property to true if your app uses a fullscreen layout (as opposed to a master-detail or other split-screen layout).

Note: Only applied if the responsive property is also set to true.

If set to true, the following situations apply:

  • On desktop, 1-3 attributes/statuses - positioned as a third block on the right side of the Title/Number group
  • On desktop, 4+ attributes/statuses - 4 columns below the Title/Number
  • On tablet (portrait mode), always in 2 columns below the Title/Number
  • On tablet (landscape mode), 1-2 attributes/statuses - 2 columns below the Title/Number
  • On tablet (landscape mode), 3+ attributes/statuses - 3 columns below the Title/Number

On phone, the attributes and statuses are always positioned in 1 column below the Title/Number of the ObjectHeader.

If set to false, the attributes and statuses are being positioned below the Title/Number of the ObjectHeader in 2 or 3 columns depending on their number:

  • On desktop, 1-4 attributes/statuses - 2 columns
  • On desktop, 5+ attributes/statuses - 3 columns
  • On tablet, always in 2 columns

Default value is false.

Returns:
booleanValue of property fullScreenOptimized
Since:
1.28
getHeaderContainer(): sap.m.ObjectHeaderContainer

Gets content of aggregation headerContainer.

This aggregation takes only effect when you set "responsive" to true. It can either be filled with an sap.m.IconTabBar or an sap.suite.ui.commons.HeaderContainer control. Overflow handling must be taken care of by the inner control. If used with an IconTabBar control, only the header will be displayed inside the object header, the content will be displayed below the ObjectHeader.

Returns:
sap.m.ObjectHeaderContainer
Since:
1.21.1
getIcon(): sap.ui.core.URI

Gets current value of property icon.

Defines the icon of the ObjectHeader.

Note: Recursive resolution of binding expressions is not supported by the framework. It works only in ObjectHeader, since it is a composite control and creates an Image control internally.

Returns:
sap.ui.core.URIValue of property icon
getIconActive(): boolean

Gets current value of property iconActive.

Determines whether the ObjectHeader icon is clickable.

Returns:
booleanValue of property iconActive
getIconAlt(): string

Gets current value of property iconAlt.

Determines the alternative text of the ObjectHeader icon. The text is displayed if the image for the icon is not available, or cannot be displayed.

Returns:
stringValue of property iconAlt
getIconDensityAware(): boolean

Gets current value of property iconDensityAware.

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is the key for the application, set this value to false.

Default value is true.

Returns:
booleanValue of property iconDensityAware
getIconTooltip(): string

Gets current value of property iconTooltip.

Determines the tooltip text of the ObjectHeader icon.

Returns:
stringValue of property iconTooltip
getIntro(): string

Gets current value of property intro.

Determines the introductory text for the ObjectHeader.

Returns:
stringValue of property intro
getIntroActive(): boolean

Gets current value of property introActive.

Determines whether the introductory text of the ObjectHeader is clickable.

Returns:
booleanValue of property introActive
getIntroHref(): sap.ui.core.URI

Gets current value of property introHref.

Determines the intro link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should not be set, but instead an event handler for the introPress event should be registered.

Returns:
sap.ui.core.URIValue of property introHref
Since:
1.28
getIntroTarget(): string

Gets current value of property introTarget.

Determines the target attribute for the intro link. Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered.

Returns:
stringValue of property introTarget
Since:
1.28
getIntroTextDirection(): sap.ui.core.TextDirection

Gets current value of property introTextDirection.

Specifies the intro text directionality with enumerated options. By default, the control inherits text direction from the DOM.

Default value is Inherit.

Returns:
sap.ui.core.TextDirectionValue of property introTextDirection
Since:
1.28.0
getMarkers(): sap.m.ObjectMarker[]

Gets content of aggregation markers.

List of markers (icon and/or text) that can be displayed for the ObjectHeader, such as favorite and flagged.

Note: You should use either this aggregation or the already deprecated properties - markFlagged and markFavorite. Using both can lead to unexpected results.

Returns:
sap.m.ObjectMarker[]
getNumber(): string

Gets current value of property number.

Determines the displayed number of the ObjectHeader number field.

Returns:
stringValue of property number
getNumberState(): sap.ui.core.ValueState

Gets current value of property numberState.

Determines the value state of the number and numberUnit properties.

Default value is None.

Returns:
sap.ui.core.ValueStateValue of property numberState
Since:
1.16.0
getNumberTextDirection(): sap.ui.core.TextDirection

Gets current value of property numberTextDirection.

Specifies the number and unit text directionality with enumerated options. By default, the control inherits text direction from the DOM.

Default value is Inherit.

Returns:
sap.ui.core.TextDirectionValue of property numberTextDirection
Since:
1.28.0
getNumberUnit(): string

Gets current value of property numberUnit.

Determines the units qualifier of the ObjectHeader number.

Note: The value of the numberUnit is not displayed if the number property is set to null.

Returns:
stringValue of property numberUnit
getResponsive(): boolean

Gets current value of property responsive.

Determines whether the ObjectHeader is rendered with a different design that reacts responsively to the screen sizes.

Note: Be aware that the design and behavior of the responsive ObjectHeader could change without further notification.

Default value is false.

Returns:
booleanValue of property responsive
Since:
1.21.1
getShowTitleSelector(): boolean

Gets current value of property showTitleSelector.

Determines whether the selector arrow icon/image is displayed and can be pressed.

Default value is false.

Returns:
booleanValue of property showTitleSelector
Since:
1.16.0
getStatuses(): sap.ui.core.Control[]

Gets content of aggregation statuses.

The list of Object sap.ui.core.Control. It will only allow sap.m.ObjectStatus and sap.m.ProgressIndicator controls.

Returns:
sap.ui.core.Control[]
Since:
1.16.0
getTitle(): string

Gets current value of property title.

Determines the title of the ObjectHeader.

Returns:
stringValue of property title
getTitleActive(): boolean

Gets current value of property titleActive.

Determines whether the title of the ObjectHeader is clickable and is set only if a title is provided.

Returns:
booleanValue of property titleActive
getTitleHref(): sap.ui.core.URI

Gets current value of property titleHref.

Defines the title link target URI. Supports standard hyperlink behavior.

Note: If an action should be triggered, this property should not be set, but instead an event handler for the titlePress event should be registered.

Returns:
sap.ui.core.URIValue of property titleHref
Since:
1.28
getTitleLevel(): sap.ui.core.TitleLevel

Gets current value of property titleLevel.

Defines the semantic level of the title.

This information is used by assistive technologies, such as screen readers to create a hierarchical site map for faster navigation. Depending on this setting an HTML h1-h6 element is used.

Default value is H1.

Returns:
sap.ui.core.TitleLevelValue of property titleLevel
getTitleSelectorTooltip(): string

Gets current value of property titleSelectorTooltip.

Determines a custom text for the tooltip of the select title arrow. If not set, a default text of the tooltip will be displayed.

Default value is Options.

Returns:
stringValue of property titleSelectorTooltip
Since:
1.30.0
getTitleTarget(): string

Gets current value of property titleTarget.

Determines the target attribute for the title link. Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered.

Returns:
stringValue of property titleTarget
Since:
1.28
getTitleTextDirection(): sap.ui.core.TextDirection

Gets current value of property titleTextDirection.

Specifies the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.

Default value is Inherit.

Returns:
sap.ui.core.TextDirectionValue of property titleTextDirection
Since:
1.28.0
indexOfAdditionalNumber(oAdditionalNumber): int
Checks for the provided sap.m.ObjectNumber in the aggregation additionalNumbers. and returns its index if found or -1 otherwise.
Parameters:
sap.m.ObjectNumberoAdditionalNumberThe additionalNumber whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
Since:
1.38.0
indexOfAttribute(oAttribute): int
Checks for the provided sap.m.ObjectAttribute in the aggregation attributes. and returns its index if found or -1 otherwise.
Parameters:
sap.m.ObjectAttributeoAttributeThe attribute whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfMarker(oMarker): int
Checks for the provided sap.m.ObjectMarker in the aggregation markers. and returns its index if found or -1 otherwise.
Parameters:
sap.m.ObjectMarkeroMarkerThe marker whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfStatus(oStatus): int
Checks for the provided sap.ui.core.Control in the aggregation statuses. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloStatusThe status whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
Since:
1.16.0
insertAdditionalNumber(oAdditionalNumber, iIndex): sap.m.ObjectHeader
Inserts a additionalNumber into the aggregation additionalNumbers.
Parameters:
sap.m.ObjectNumberoAdditionalNumberthe additionalNumber to insert; if empty, nothing is inserted
intiIndexthe 0-based index the additionalNumber should be inserted at; for a negative value of iIndex, the additionalNumber is inserted at position 0; for a value greater than the current size of the aggregation, the additionalNumber is inserted at the last position
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.38.0
insertAttribute(oAttribute, iIndex): sap.m.ObjectHeader
Inserts a attribute into the aggregation attributes.
Parameters:
sap.m.ObjectAttributeoAttributethe attribute to insert; if empty, nothing is inserted
intiIndexthe 0-based index the attribute should be inserted at; for a negative value of iIndex, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
insertMarker(oMarker, iIndex): sap.m.ObjectHeader
Inserts a marker into the aggregation markers.
Parameters:
sap.m.ObjectMarkeroMarkerthe marker to insert; if empty, nothing is inserted
intiIndexthe 0-based index the marker should be inserted at; for a negative value of iIndex, the marker is inserted at position 0; for a value greater than the current size of the aggregation, the marker is inserted at the last position
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
insertStatus(oStatus, iIndex): sap.m.ObjectHeader
Inserts a status into the aggregation statuses.
Parameters:
sap.ui.core.ControloStatusthe status to insert; if empty, nothing is inserted
intiIndexthe 0-based index the status should be inserted at; for a negative value of iIndex, the status is inserted at position 0; for a value greater than the current size of the aggregation, the status is inserted at the last position
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
removeAdditionalNumber(vAdditionalNumber): sap.m.ObjectNumber
Removes a additionalNumber from the aggregation additionalNumbers.
Parameters:
int|string|sap.m.ObjectNumbervAdditionalNumberThe additionalNumber to remove or its index or id
Returns:
sap.m.ObjectNumberThe removed additionalNumber or null
Since:
1.38.0
removeAllAdditionalNumbers(): sap.m.ObjectNumber[]

Removes all the controls from the aggregation additionalNumbers.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.ObjectNumber[]An array of the removed elements (might be empty)
Since:
1.38.0
removeAllAriaDescribedBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaDescribedBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllAttributes(): sap.m.ObjectAttribute[]

Removes all the controls from the aggregation attributes.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.ObjectAttribute[]An array of the removed elements (might be empty)
removeAllMarkers(): sap.m.ObjectMarker[]

Removes all the controls from the aggregation markers.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.ObjectMarker[]An array of the removed elements (might be empty)
removeAllStatuses(): sap.ui.core.Control[]

Removes all the controls from the aggregation statuses.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
Since:
1.16.0
removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.ID
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaDescribedByThe ariaDescribedBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
removeAttribute(vAttribute): sap.m.ObjectAttribute
Removes a attribute from the aggregation attributes.
Parameters:
int|string|sap.m.ObjectAttributevAttributeThe attribute to remove or its index or id
Returns:
sap.m.ObjectAttributeThe removed attribute or null
removeMarker(vMarker): sap.m.ObjectMarker
Removes a marker from the aggregation markers.
Parameters:
int|string|sap.m.ObjectMarkervMarkerThe marker to remove or its index or id
Returns:
sap.m.ObjectMarkerThe removed marker or null
removeStatus(vStatus): sap.ui.core.Control
Removes a status from the aggregation statuses.
Parameters:
int|string|sap.ui.core.ControlvStatusThe status to remove or its index or id
Returns:
sap.ui.core.ControlThe removed status or null
Since:
1.16.0
setBackgroundDesign(sBackgroundDesign): sap.m.ObjectHeader

Sets a new value for property backgroundDesign.

Determines the background color of the ObjectHeader.

Note: The different types of ObjectHeader come with different default background:

  • non responsive - Transparent
  • responsive - Translucent
  • condensed - Solid

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

Parameters:
sap.m.BackgroundDesignsBackgroundDesignNew value for property backgroundDesign
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setCondensed(bCondensed): sap.m.ObjectHeader
Set the condensed flag
Parameters:
booleanbCondensedthe new value
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setFullScreenOptimized(bFullScreenOptimized): sap.m.ObjectHeader

Sets a new value for property fullScreenOptimized.

Optimizes the display of the elements of the ObjectHeader.

Set this property to true if your app uses a fullscreen layout (as opposed to a master-detail or other split-screen layout).

Note: Only applied if the responsive property is also set to true.

If set to true, the following situations apply:

  • On desktop, 1-3 attributes/statuses - positioned as a third block on the right side of the Title/Number group
  • On desktop, 4+ attributes/statuses - 4 columns below the Title/Number
  • On tablet (portrait mode), always in 2 columns below the Title/Number
  • On tablet (landscape mode), 1-2 attributes/statuses - 2 columns below the Title/Number
  • On tablet (landscape mode), 3+ attributes/statuses - 3 columns below the Title/Number

On phone, the attributes and statuses are always positioned in 1 column below the Title/Number of the ObjectHeader.

If set to false, the attributes and statuses are being positioned below the Title/Number of the ObjectHeader in 2 or 3 columns depending on their number:

  • On desktop, 1-4 attributes/statuses - 2 columns
  • On desktop, 5+ attributes/statuses - 3 columns
  • On tablet, always in 2 columns

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

Default value is false.

Parameters:
booleanbFullScreenOptimizedNew value for property fullScreenOptimized
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28
setHeaderContainer(oHeaderContainer): sap.m.ObjectHeader
Sets the aggregated headerContainer.
Parameters:
sap.m.ObjectHeaderContaineroHeaderContainerThe headerContainer to set
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.21.1
setIcon(sIcon): sap.m.ObjectHeader

Sets a new value for property icon.

Defines the icon of the ObjectHeader.

Note: Recursive resolution of binding expressions is not supported by the framework. It works only in ObjectHeader, since it is a composite control and creates an Image control internally.

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

Parameters:
sap.ui.core.URIsIconNew value for property icon
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIconActive(bIconActive): sap.m.ObjectHeader

Sets a new value for property iconActive.

Determines whether the ObjectHeader icon is clickable.

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

Parameters:
booleanbIconActiveNew value for property iconActive
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIconAlt(sIconAlt): sap.m.ObjectHeader

Sets a new value for property iconAlt.

Determines the alternative text of the ObjectHeader icon. The text is displayed if the image for the icon is not available, or cannot be displayed.

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

Parameters:
stringsIconAltNew value for property iconAlt
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIconDensityAware(bIconDensityAware): sap.m.ObjectHeader

Sets a new value for property iconDensityAware.

By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.

If bandwidth is the key for the application, set this value to false.

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

Default value is true.

Parameters:
booleanbIconDensityAwareNew value for property iconDensityAware
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIconTooltip(sIconTooltip): sap.m.ObjectHeader

Sets a new value for property iconTooltip.

Determines the tooltip text of the ObjectHeader icon.

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

Parameters:
stringsIconTooltipNew value for property iconTooltip
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIntro(sIntro): sap.m.ObjectHeader

Sets a new value for property intro.

Determines the introductory text for the ObjectHeader.

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

Parameters:
stringsIntroNew value for property intro
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIntroActive(bIntroActive): sap.m.ObjectHeader

Sets a new value for property introActive.

Determines whether the introductory text of the ObjectHeader is clickable.

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

Parameters:
booleanbIntroActiveNew value for property introActive
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setIntroHref(sIntroHref): sap.m.ObjectHeader

Sets a new value for property introHref.

Determines the intro link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should not be set, but instead an event handler for the introPress event should be registered.

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

Parameters:
sap.ui.core.URIsIntroHrefNew value for property introHref
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28
setIntroTarget(sIntroTarget): sap.m.ObjectHeader

Sets a new value for property introTarget.

Determines the target attribute for the intro link. Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered.

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

Parameters:
stringsIntroTargetNew value for property introTarget
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28
setIntroTextDirection(sIntroTextDirection): sap.m.ObjectHeader

Sets a new value for property introTextDirection.

Specifies the intro text directionality with enumerated options. By default, the control inherits text direction from the DOM.

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

Default value is Inherit.

Parameters:
sap.ui.core.TextDirectionsIntroTextDirectionNew value for property introTextDirection
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28.0
setMarkFavorite(bMarked): sap.m.ObjectHeader
Sets the visibility value of the Favorite marker.
Parameters:
booleanbMarkedvisibility of the marker
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setMarkFlagged(bMarked): sap.m.ObjectHeader
Sets the visibility value of the Flagged marker.
Parameters:
booleanbMarkedvisibility of the marker
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setNumber(sNumber): sap.m.ObjectHeader
Set the number value to the internal aggregation
Parameters:
stringsNumberthe new value
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setNumberState(sState): sap.m.ObjectHeader
Set the number state to the internal aggregation
Parameters:
sap.ui.core.ValueStatesStatethe new value
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setNumberTextDirection(sNumberTextDirection): sap.m.ObjectHeader

Sets a new value for property numberTextDirection.

Specifies the number and unit text directionality with enumerated options. By default, the control inherits text direction from the DOM.

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

Default value is Inherit.

Parameters:
sap.ui.core.TextDirectionsNumberTextDirectionNew value for property numberTextDirection
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28.0
setNumberUnit(sUnit): sap.m.ObjectHeader
Set the number unit to the internal aggregation
Parameters:
stringsUnitthe new value
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setResponsive(bResponsive): sap.m.ObjectHeader

Sets a new value for property responsive.

Determines whether the ObjectHeader is rendered with a different design that reacts responsively to the screen sizes.

Note: Be aware that the design and behavior of the responsive ObjectHeader could change without further notification.

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

Default value is false.

Parameters:
booleanbResponsiveNew value for property responsive
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.21.1
setShowMarkers(bMarked): sap.m.ObjectHeader
Sets the visibility value of the Flagged and Favorite markers.
Parameters:
booleanbMarkedvisibility of all markers
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setShowTitleSelector(bShowTitleSelector): sap.m.ObjectHeader

Sets a new value for property showTitleSelector.

Determines whether the selector arrow icon/image is displayed 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.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.16.0
setTitle(sTitle): sap.m.ObjectHeader

Sets a new value for property title.

Determines the title of the ObjectHeader.

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

Parameters:
stringsTitleNew value for property title
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setTitleActive(bTitleActive): sap.m.ObjectHeader

Sets a new value for property titleActive.

Determines whether the title of the ObjectHeader is clickable and is set only if a title is provided.

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

Parameters:
booleanbTitleActiveNew value for property titleActive
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setTitleHref(sTitleHref): sap.m.ObjectHeader

Sets a new value for property titleHref.

Defines the title link target URI. Supports standard hyperlink behavior.

Note: If an action should be triggered, this property should not be set, but instead an event handler for the titlePress event should be registered.

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

Parameters:
sap.ui.core.URIsTitleHrefNew value for property titleHref
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28
setTitleLevel(sTitleLevel): sap.m.ObjectHeader

Sets a new value for property titleLevel.

Defines the semantic level of the title.

This information is used by assistive technologies, such as screen readers to create a hierarchical site map for faster navigation. Depending on this setting an HTML h1-h6 element is used.

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

Default value is H1.

Parameters:
sap.ui.core.TitleLevelsTitleLevelNew value for property titleLevel
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
setTitleSelectorTooltip(sTooltip): sap.m.ObjectHeader
Sets the new text for the tooltip of the select title arrow to the internal aggregation
Parameters:
stringsTooltipthe tooltip of the title selector
Returns:
sap.m.ObjectHeaderthis pointer for chaining
setTitleTarget(sTitleTarget): sap.m.ObjectHeader

Sets a new value for property titleTarget.

Determines the target attribute for the title link. Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered.

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

Parameters:
stringsTitleTargetNew value for property titleTarget
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28
setTitleTextDirection(sTitleTextDirection): sap.m.ObjectHeader

Sets a new value for property titleTextDirection.

Specifies the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.

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

Default value is Inherit.

Parameters:
sap.ui.core.TextDirectionsTitleTextDirectionNew value for property titleTextDirection
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Since:
1.28.0
destroyFirstStatus(): sap.m.ObjectHeader
Destroys the firstStatus in the aggregation firstStatus.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.0. Use the statuses aggregation instead.
destroySecondStatus(): sap.m.ObjectHeader
Destroys the secondStatus in the aggregation secondStatus.
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.0. Use the statuses aggregation instead.
getFirstStatus(): sap.m.ObjectStatus

Gets content of aggregation firstStatus.

First status shown on the right side of the attributes above the second status. If it is not set the first attribute will expand to take the entire row.

Returns:
sap.m.ObjectStatus
Deprecated API:
Since version 1.16.0. Use the statuses aggregation instead.
getMarkFavorite(): boolean

Gets current value of property markFavorite.

Sets the favorite state for the ObjectHeader. The showMarkers property must be set to true for this property to take effect.

Note: As this property is deprecated, we recommend that you use the markers aggregation - add sap.m.ObjectMarker with type sap.m.ObjectMarkerType.Favorite. You should use either this property or the markers aggregation, using both may lead to unpredicted behavior.

Default value is false.

Returns:
booleanValue of property markFavorite
Deprecated API:
Since version 1.42.0.
Since:
1.16.0
getMarkFlagged(): boolean

Gets current value of property markFlagged.

Sets the flagged state for the ObjectHeader. The showMarkers property must be set to true for this property to take effect.

Note: As this property is deprecated, we recommend that you use the markers aggregation - add sap.m.ObjectMarker with type sap.m.ObjectMarkerType.Flagged. You should use either this property or the markers aggregation, using both may lead to unpredicted behavior.

Default value is false.

Returns:
booleanValue of property markFlagged
Deprecated API:
Since version 1.42.0.
Since:
1.16.0
getSecondStatus(): sap.m.ObjectStatus

Gets content of aggregation secondStatus.

Second status shown on the right side of the attributes below the first status. If it is not set the second attribute will expand to take the entire row.

Returns:
sap.m.ObjectStatus
Deprecated API:
Since version 1.16.0. Use the statuses aggregation instead.
getShowMarkers(): boolean

Gets current value of property showMarkers.

If set to true, the ObjectHeader can be marked with icons such as favorite and flag.

Note: This property is valid only if you are using the already deprecated properties - markFlagged and markFavorite. If you are using the markers aggregation, the visibility of the markers depends on what is set in the aggregation itself.

Default value is false.

Returns:
booleanValue of property showMarkers
Deprecated API:
Since version 1.42.0.
Since:
1.16.0
setFirstStatus(oFirstStatus): sap.m.ObjectHeader
Sets the aggregated firstStatus.
Parameters:
sap.m.ObjectStatusoFirstStatusThe firstStatus to set
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.0. Use the statuses aggregation instead.
setSecondStatus(oSecondStatus): sap.m.ObjectHeader
Sets the aggregated secondStatus.
Parameters:
sap.m.ObjectStatusoSecondStatusThe secondStatus to set
Returns:
sap.m.ObjectHeaderReference to this in order to allow method chaining
Deprecated API:
Since version 1.16.0. Use the statuses aggregation instead.