Class sap.m.ObjectHeaderModule: sap/m/ObjectHeader
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.
sClassName
and enriches it with the information contained in oClassInfo
.additionalNumbers
.fnFunction
to the iconPress
event of this sap.m.ObjectHeader
.fnFunction
to the introPress
event of this sap.m.ObjectHeader
.fnFunction
to the titlePress
event of this sap.m.ObjectHeader
.fnFunction
to the titleSelectorPress
event of this sap.m.ObjectHeader
.fnFunction
from the iconPress
event of this sap.m.ObjectHeader
.fnFunction
from the introPress
event of this sap.m.ObjectHeader
.fnFunction
from the titlePress
event of this sap.m.ObjectHeader
.fnFunction
from the titleSelectorPress
event of this sap.m.ObjectHeader
.ariaDescribedBy
.ariaLabelledBy
.sap.m.ObjectNumber
in the aggregation additionalNumbers
.sap.m.ObjectAttribute
in the aggregation attributes
.additionalNumbers
.additionalNumbers
.ariaDescribedBy
.ariaLabelledBy
. 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
- title : string
- number : string
- numberUnit : string
- intro : string
- introActive : boolean
- titleActive : boolean
- icon : sap.ui.core.URI
- iconActive : boolean
- iconAlt : string
- iconDensityAware : boolean (default: true)
- markFavorite : boolean (default: false)
- markFlagged : boolean (default: false)
- showMarkers : boolean (default: false)
- showTitleSelector : boolean (default: false)
- numberState : sap.ui.core.ValueState (default: None)
- condensed : boolean (default: false)
- backgroundDesign : sap.m.BackgroundDesign
- responsive : boolean (default: false)
- fullScreenOptimized : boolean (default: false)
- titleHref : sap.ui.core.URI
- titleTarget : string
- introHref : sap.ui.core.URI
- introTarget : string
- titleTextDirection : sap.ui.core.TextDirection (default: Inherit)
- introTextDirection : sap.ui.core.TextDirection (default: Inherit)
- numberTextDirection : sap.ui.core.TextDirection (default: Inherit)
- titleSelectorTooltip : string (default: Options)
- titleLevel : sap.ui.core.TitleLevel (default: H1)
- Aggregations
- attributes : sap.m.ObjectAttribute[] (default)
- firstStatus : sap.m.ObjectStatus
- secondStatus : sap.m.ObjectStatus
- statuses : sap.ui.core.Control[]
- additionalNumbers : sap.m.ObjectNumber[]
- headerContainer : sap.m.ObjectHeaderContainer
- Events
- titlePress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- introPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- iconPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- titleSelectorPress : 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.
{string} | sId? | ID for the new control, generated automatically if no ID is given |
{object} | mSettings? | Initial settings for the new control |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.domRef | Dom reference of the object header' icon to be used for positioning. |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.domRef | Dom reference of the object header' intro to be used for positioning. |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.domRef | Dom reference of the object header' title to be used for positioning. |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{object} | oControlEvent.getParameters.domRef | Dom reference of the object header' titleArrow to be used for positioning. |
- Since:
- 1.16.0
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.
{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 |
{function} | Created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
additionalNumbers
. {sap.m.ObjectNumber} | oAdditionalNumber | the additionalNumber to add; if empty, nothing is inserted |
- Since:
- 1.38.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
ariaDescribedBy
. {string|sap.ui.core.Control} | vAriaDescribedBy | the ariaDescribedBy to add; if empty, nothing is inserted |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
ariaLabelledBy
. {string|sap.ui.core.Control} | vAriaLabelledBy | the ariaLabelledBy to add; if empty, nothing is inserted |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
attributes
. {sap.m.ObjectAttribute} | oAttribute | the attribute to add; if empty, nothing is inserted |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
statuses
. {sap.ui.core.Control} | oStatus | the status to add; if empty, nothing is inserted |
- Since:
- 1.16.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
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
{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.m.ObjectHeader itself |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
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
{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.m.ObjectHeader itself |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
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
{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.m.ObjectHeader itself |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
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
{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.m.ObjectHeader itself |
- Since:
- 1.16.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
additionalNumbers
. - Since:
- 1.38.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
attributes
. {sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
headerContainer
. - Since:
- 1.21.1
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
statuses
. - Since:
- 1.16.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
fnFunction
from the iconPress
event of this sap.m.ObjectHeader
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
fnFunction
from the introPress
event of this sap.m.ObjectHeader
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
fnFunction
from the titlePress
event of this sap.m.ObjectHeader
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
fnFunction
from the titleSelectorPress
event of this sap.m.ObjectHeader
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
- Since:
- 1.16.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
iconPress
to attached listeners. Expects the following event parameters:
domRef
of typeobject
Dom reference of the object header' icon to be used for positioning.
{Map} | mArguments? | The arguments to pass along with the event |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
introPress
to attached listeners. Expects the following event parameters:
domRef
of typeobject
Dom reference of the object header' intro to be used for positioning.
{Map} | mArguments? | The arguments to pass along with the event |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
titlePress
to attached listeners. Expects the following event parameters:
domRef
of typeobject
Dom reference of the object header' title to be used for positioning.
{Map} | mArguments? | The arguments to pass along with the event |
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
titleSelectorPress
to attached listeners. Expects the following event parameters:
domRef
of typeobject
Dom reference of the object header' titleArrow to be used for positioning.
{Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.16.0
{sap.m.ObjectHeader} | Reference to this in order to allow method chaining |
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.
- Since:
- 1.38.0
{sap.m.ObjectNumber[]} |
ariaDescribedBy
. {sap.ui.core.Control[]} |
ariaLabelledBy
. {sap.ui.core.Control[]} |
attributes
. The list of Object Attributes
{sap.m.ObjectAttribute[]} |
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
{sap.m.BackgroundDesign} | Value of property backgroundDesign |
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
.
{boolean} | Value of property condensed |
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
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
.
- Since:
- 1.28
{boolean} | Value of property fullScreenOptimized |
headerContainer
. This aggregation takes only effect when you set "responsive" to true. It can either be filled with an sap.m.IconTabBar or a 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.
- Since:
- 1.21.1
{sap.m.ObjectHeaderContainer} |
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.
{sap.ui.core.URI} | Value of property icon |
iconActive
. Determines whether the ObjectHeader
icon is clickable.
{boolean} | Value of property iconActive |
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.
{string} | Value of property iconAlt |
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
.
{boolean} | Value of property iconDensityAware |
intro
. Determines the introductory text for the ObjectHeader
.
{string} | Value of property intro |
introActive
. Determines whether the introductory text of the ObjectHeader
is clickable.
{boolean} | Value of property introActive |
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.
- Since:
- 1.28
{sap.ui.core.URI} | Value of property introHref |
introTarget
. Determines the target
attribute for the intro link. Options are _self
, _top
, _blank
, _parent
, _search
. Alternatively, a frame name can be entered.
- Since:
- 1.28
{string} | Value of property introTarget |
introTextDirection
. Specifies the intro text directionality with enumerated options. By default, the control inherits text direction from the DOM.
Default value is Inherit
.
- Since:
- 1.28.0
{sap.ui.core.TextDirection} | Value of property introTextDirection |
markFavorite
. Sets the favorite state to true or false. The showMarkers property must be true for this property to take effect.
Default value is false
.
- Since:
- 1.16.0
{boolean} | Value of property markFavorite |
markFlagged
. Sets the flagged state to true or false. The showMarkers property must be true for this property to take effect.
Default value is false
.
- Since:
- 1.16.0
{boolean} | Value of property markFlagged |
number
. Determines the displayed number of the ObjectHeader
number field.
{string} | Value of property number |
numberState
. Determines the value state of the number
and
numberUnit
properties.
Default value is
None
.
Since:
1.16.0
Returns:
{sap.ui.core.ValueState} | Value of property numberState |
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
.
- Since:
- 1.28.0
Returns:{sap.ui.core.TextDirection} Value of property numberTextDirection
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:{string} Value 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
.
Since:
1.21.1
Returns:
{boolean} Value of property responsive
getShowMarkers(): boolean Gets current value of property showMarkers
. Indicates if object header supports showing markers such as flagged and favorite.
Default value is false
.
- Since:
- 1.16.0
Returns:{boolean} Value of property showMarkers
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
.
- Since:
- 1.16.0
Returns:{boolean} Value of property showTitleSelector
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.
- Since:
- 1.16.0
Returns:{sap.ui.core.Control[]}
getTitle(): string Gets current value of property title
. Determines the title of the ObjectHeader
.
Returns:{string} Value 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:{boolean} Value 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.
- Since:
- 1.28
Returns:{sap.ui.core.URI} Value of property titleHref
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.TitleLevel} Value 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
.
- Since:
- 1.30.0
Returns:{string} Value of property titleSelectorTooltip
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.
- Since:
- 1.28
Returns:{string} Value of property titleTarget
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
.
- Since:
- 1.28.0
Returns:{sap.ui.core.TextDirection} Value of property titleTextDirection
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.ObjectNumber} oAdditionalNumber The additionalNumber whose index is looked for
- Since:
- 1.38.0
Returns:{int} The index of the provided control in the aggregation if found, or -1 otherwise
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.ObjectAttribute} oAttribute The attribute whose index is looked for
Returns:{int} The 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.Control} oStatus The status whose index is looked for
- Since:
- 1.16.0
Returns:{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertAdditionalNumber(oAdditionalNumber, iIndex): sap.m.ObjectHeader Inserts a additionalNumber into the aggregation additionalNumbers
. Parameters:{sap.m.ObjectNumber} oAdditionalNumber the additionalNumber to insert; if empty, nothing is inserted {int} iIndex the 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
- Since:
- 1.38.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
insertAttribute(oAttribute, iIndex): sap.m.ObjectHeader Inserts a attribute into the aggregation attributes
. Parameters:{sap.m.ObjectAttribute} oAttribute the attribute to insert; if empty, nothing is inserted {int} iIndex the 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.ObjectHeader} Reference 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.Control} oStatus the status to insert; if empty, nothing is inserted {int} iIndex the 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
- Since:
- 1.16.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
removeAdditionalNumber(vAdditionalNumber): sap.m.ObjectNumber Removes a additionalNumber from the aggregation additionalNumbers
. Parameters:{int|string|sap.m.ObjectNumber} vAdditionalNumber The additionalNumberto remove or its index or id
- Since:
- 1.38.0
Returns:{sap.m.ObjectNumber} The removed additionalNumber or null
removeAllAdditionalNumbers(): sap.m.ObjectNumber[] Removes all the controls from the aggregation additionalNumbers
. Additionally, it unregisters them from the hosting UIArea.
- Since:
- 1.38.0
Returns:{sap.m.ObjectNumber[]} An array of the removed elements (might be empty)
removeAllAriaDescribedBy(): sap.ui.core.Control[] Removes all the controls in the association named ariaDescribedBy
. Returns:{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.Control[] Removes all the controls in the association named ariaLabelledBy
. Returns:{sap.ui.core.Control[]} 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)
removeAllStatuses(): sap.ui.core.Control[] Removes all the controls from the aggregation statuses
. Additionally, it unregisters them from the hosting UIArea.
- Since:
- 1.16.0
Returns:{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.Control Removes an ariaDescribedBy from the association named ariaDescribedBy
. Parameters:{int|string|sap.ui.core.Control} vAriaDescribedBy The ariaDescribedByto be removed or its index or ID
Returns:{sap.ui.core.Control} the removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control Removes an ariaLabelledBy from the association named ariaLabelledBy
. Parameters:{int|string|sap.ui.core.Control} vAriaLabelledBy The ariaLabelledByto be removed or its index or ID
Returns:{sap.ui.core.Control} the removed ariaLabelledBy or null
removeAttribute(vAttribute): sap.m.ObjectAttribute Removes a attribute from the aggregation attributes
. Parameters:{int|string|sap.m.ObjectAttribute} vAttribute The attributeto remove or its index or id
Returns:{sap.m.ObjectAttribute} The removed attribute or null
removeStatus(vStatus): sap.ui.core.Control Removes a status from the aggregation statuses
. Parameters:{int|string|sap.ui.core.Control} vStatus The statusto remove or its index or id
- Since:
- 1.16.0
Returns:{sap.ui.core.Control} The removed status or null
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.BackgroundDesign} sBackgroundDesign New value for property backgroundDesign
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setCondensed(bCondensed): sap.m.ObjectHeader Set the condensed flag Parameters:{boolean} bCondensed the new value
Returns:{sap.m.ObjectHeader} this 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:{boolean} bFullScreenOptimized New value for property fullScreenOptimized
- Since:
- 1.28
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setHeaderContainer(oHeaderContainer): sap.m.ObjectHeader Sets the aggregated headerContainer
. Parameters:{sap.m.ObjectHeaderContainer} oHeaderContainer The headerContainer to set
- Since:
- 1.21.1
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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.URI} sIcon New value for property icon
Returns:{sap.m.ObjectHeader} Reference 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:{boolean} bIconActive New value for property iconActive
Returns:{sap.m.ObjectHeader} Reference 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:{string} sIconAlt New value for property iconAlt
Returns:{sap.m.ObjectHeader} Reference 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:{boolean} bIconDensityAware New value for property iconDensityAware
Returns:{sap.m.ObjectHeader} Reference 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:{string} sIntro New value for property intro
Returns:{sap.m.ObjectHeader} Reference 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:{boolean} bIntroActive New value for property introActive
Returns:{sap.m.ObjectHeader} Reference 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.URI} sIntroHref New value for property introHref
- Since:
- 1.28
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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:{string} sIntroTarget New value for property introTarget
- Since:
- 1.28
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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.TextDirection} sIntroTextDirection New value for property introTextDirection
- Since:
- 1.28.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setMarkFavorite(bMarkFavorite): sap.m.ObjectHeader Sets a new value for property markFavorite
. Sets 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
- Since:
- 1.16.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setMarkFlagged(bMarkFlagged): sap.m.ObjectHeader Sets a new value for property markFlagged
. Sets 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
- Since:
- 1.16.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setNumber(sNumber): sap.m.ObjectHeader Set the number value to the internal aggregation Parameters:{string} sNumber the new value
Returns:{sap.m.ObjectHeader} this pointer for chaining
setNumberState(sState): sap.m.ObjectHeader Set the number state to the internal aggregation Parameters:{sap.ui.core.ValueState} sState the new value
Returns:{sap.m.ObjectHeader} this 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.TextDirection} sNumberTextDirection New value for property numberTextDirection
- Since:
- 1.28.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setNumberUnit(sUnit): sap.m.ObjectHeader Set the number unit to the internal aggregation Parameters:{string} sUnit the new value
Returns:{sap.m.ObjectHeader} this 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:
{boolean} bResponsive New value for property responsive
Since:
1.21.1
Returns:
{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setShowMarkers(bShowMarkers): sap.m.ObjectHeader Sets a new value for property showMarkers
. Indicates if object header 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
- Since:
- 1.16.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method 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:{boolean} bShowTitleSelector New value for property showTitleSelector
- Since:
- 1.16.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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:{string} sTitle New value for property title
Returns:{sap.m.ObjectHeader} Reference 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:{boolean} bTitleActive New value for property titleActive
Returns:{sap.m.ObjectHeader} Reference 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.URI} sTitleHref New value for property titleHref
- Since:
- 1.28
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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.TitleLevel} sTitleLevel New value for property titleLevel
Returns:{sap.m.ObjectHeader} Reference 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:sTooltip the new value
Returns:{sap.m.ObjectHeader} this 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:{string} sTitleTarget New value for property titleTarget
- Since:
- 1.28
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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.TextDirection} sTitleTextDirection New value for property titleTextDirection
- Since:
- 1.28.0
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
destroyFirstStatus(): sap.m.ObjectHeader Destroys the firstStatus in the aggregation firstStatus
. - Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
destroySecondStatus(): sap.m.ObjectHeader Destroys the secondStatus in the aggregation secondStatus
. - Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
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.
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:{sap.m.ObjectStatus}
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.
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:{sap.m.ObjectStatus}
setFirstStatus(oFirstStatus): sap.m.ObjectHeader Sets the aggregated firstStatus
. Parameters:{sap.m.ObjectStatus} oFirstStatus The firstStatus to set
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining
setSecondStatus(oSecondStatus): sap.m.ObjectHeader Sets the aggregated secondStatus
. Parameters:{sap.m.ObjectStatus} oSecondStatus The secondStatus to set
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:{sap.m.ObjectHeader} Reference to this
in order to allow method chaining