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.
When using the sap.m.ObjectHeader
in SAP Quartz theme, the breakpoints and layout paddings could be automatically determined by the container's width. To enable this concept and implement responsive padding to the ObjectHeader
control, add the following class: sapUiResponsivePadding--header
.
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#constructor for a general description of the syntax of the settings object.
new sap.m.ObjectHeader(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
backgroundDesign | sap.m.BackgroundDesign | Determines the background color of the Note: The different types of
|
|
condensed | boolean | false |
Note: Only applied if the |
fullScreenOptimized | boolean | false | Optimizes the display of the elements of the Set this property to Note: Only applied if the If set to
ObjectHeader .If set to
Since: 1.28.Visibility: public |
icon | sap.ui.core.URI | Defines the icon of the 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. Visibility: public |
|
iconActive | boolean | Determines whether the |
|
iconAlt | string | Determines the alternative text of the Note: Provide an empty string value for the |
|
iconDensityAware | boolean | true | By default, this is set to If bandwidth is the key for the application, set this value to |
iconTooltip | string | Determines the tooltip text of the |
|
imageShape | sap.m.ObjectHeaderPictureShape | Square | Determines whether the picture should be displayed in a square or with a circle-shaped mask just like in sap.uxap.ObjectPageHeader. Note: This property takes effect only on Images and it is ignored for Icons. |
intro | string | Determines the introductory text for the |
|
introActive | boolean | Determines whether the introductory text of the |
|
introHref | sap.ui.core.URI | 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 |
|
introTarget | string | Determines the |
|
introTextDirection | sap.ui.core.TextDirection | Inherit | Specifies the intro text directionality with enumerated options. By default, the control inherits text direction from the DOM. |
markFavorite | boolean | false | Sets the favorite state for the |
markFlagged | boolean | false | Sets the flagged state for the |
number | string | Determines the displayed number of the |
|
numberState | sap.ui.core.ValueState | None | Determines the value state of the |
numberTextDirection | sap.ui.core.TextDirection | Inherit | Specifies the number and unit text directionality with enumerated options. By default, the control inherits text direction from the DOM. |
numberUnit | string | Determines the units qualifier of the Note: The value of the |
|
responsive | boolean | false | Determines whether the When the
Since: 1.21.1.Visibility: public |
showMarkers | boolean | false | If set to |
showTitleSelector | boolean | false | Determines whether the selector arrow icon/image is displayed and can be pressed. |
title | string | Determines the title of the |
|
titleActive | boolean | Determines whether the title of the |
|
titleHref | sap.ui.core.URI | 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 |
|
titleLevel | sap.ui.core.TitleLevel | H1 | 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. Visibility: public |
titleSelectorTooltip | string | Options | Determines a custom text for the tooltip of the select title arrow. If not set, a default text of the tooltip will be displayed. |
titleTarget | string | Determines the |
|
titleTextDirection | sap.ui.core.TextDirection | Inherit | Specifies the title text directionality with enumerated options. By default, the control inherits text direction from the DOM. |
Default Aggregation: attributes
Name | Cardinality | Type | Description |
---|---|---|---|
_objectNumber | 0..1 | sap.m.ObjectNumber |
The object number and unit are managed in this aggregation |
additionalNumbers | 0..n | sap.m.ObjectNumber |
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. |
attributes (default) | 0..n | sap.m.ObjectAttribute |
The list of Object Attributes |
firstStatus | 0..1 | sap.m.ObjectStatus |
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. |
headerContainer | 0..1 | sap.m.ObjectHeaderContainer |
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. |
markers | 0..n | sap.m.ObjectMarker |
List of markers (icon and/or text) that can be displayed for the |
secondStatus | 0..1 | sap.m.ObjectStatus |
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. |
statuses | 0..n | sap.ui.core.Control |
The list of Object sap.ui.core.Control. It will only allow sap.m.ObjectStatus and sap.m.ProgressIndicator controls. |
Name | Cardinality | Type | Description |
---|---|---|---|
ariaDescribedBy | 0..n | sap.ui.core.Control |
Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). |
ariaLabelledBy | 0..n | sap.ui.core.Control |
Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). |
Event | Description |
---|---|
iconPress |
Event is fired when the title icon is active and the user taps/clicks on it |
introPress |
Event is fired when the intro is active and the user taps/clicks on it |
titlePress |
Event is fired when the title is active and the user taps/clicks on it |
titleSelectorPress |
Event is fired when the object header title selector (down-arrow) is pressed |
Event is fired when the title icon is active and the user taps/clicks on it
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
domRef | object |
Dom reference of the object header' icon to be used for positioning. |
Event is fired when the intro is active and the user taps/clicks on it
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
domRef | object |
Dom reference of the object header' intro to be used for positioning. |
Event is fired when the title is active and the user taps/clicks on it
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
domRef | object |
Dom reference of the object header' title to be used for positioning. |
Event is fired when the object header title selector (down-arrow) is pressed
Since: 1.16.0.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
domRef | object |
Dom reference of the object header' titleArrow to be used for positioning. |
Method | Description |
---|---|
addAdditionalNumber |
Adds some additionalNumber to the aggregation additionalNumbers. |
addAriaDescribedBy |
Adds some ariaDescribedBy into the association ariaDescribedBy. |
addAriaLabelledBy |
Adds some ariaLabelledBy into the association ariaLabelledBy. |
addAttribute |
Adds some attribute to the aggregation attributes. |
addMarker |
Adds some marker to the aggregation markers. |
addStatus |
Adds some status to the aggregation statuses. |
attachIconPress |
Attaches event handler When called, the context of the event handler (its Event is fired when the title icon is active and the user taps/clicks on it |
attachIntroPress |
Attaches event handler When called, the context of the event handler (its Event is fired when the intro is active and the user taps/clicks on it |
attachTitlePress |
Attaches event handler When called, the context of the event handler (its Event is fired when the title is active and the user taps/clicks on it |
attachTitleSelectorPress |
Attaches event handler When called, the context of the event handler (its Event is fired when the object header title selector (down-arrow) is pressed |
destroyAdditionalNumbers |
Destroys all the additionalNumbers in the aggregation additionalNumbers. |
destroyAttributes |
Destroys all the attributes in the aggregation attributes. |
destroyFirstStatus |
Destroys the firstStatus in the aggregation firstStatus.
Since 1.16.0 replaced by <code>statuses</code> aggregation
|
destroyHeaderContainer |
Destroys the headerContainer in the aggregation headerContainer. |
destroyMarkers |
Destroys all the markers in the aggregation markers. |
destroySecondStatus |
Destroys the secondStatus in the aggregation secondStatus.
Since 1.16.0 replaced by <code>statuses</code> aggregation
|
destroyStatuses |
Destroys all the statuses in the aggregation statuses. |
detachIconPress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachIntroPress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTitlePress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTitleSelectorPress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.ObjectHeader.extend |
Creates a new subclass of class sap.m.ObjectHeader with name
|
fireIconPress |
Fires event iconPress to attached listeners. |
fireIntroPress |
Fires event introPress to attached listeners. |
fireTitlePress |
Fires event titlePress to attached listeners. |
fireTitleSelectorPress |
Fires event titleSelectorPress to attached listeners. |
getAdditionalNumbers |
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. |
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. The list of Object Attributes |
getBackgroundDesign |
Gets current value of property backgroundDesign. Determines the background color of the Note: The different types of
|
getCondensed |
Gets current value of property condensed.
Note: Only applied if the Default value is |
getFirstStatus |
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.
Since 1.16.0 replaced by <code>statuses</code> aggregation
|
getFullScreenOptimized |
Gets current value of property fullScreenOptimized. Optimizes the display of the elements of the Set this property to Note: Only applied if the If set to
ObjectHeader .If set to
Default value is |
getHeaderContainer |
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. |
getIcon |
Gets current value of property icon. Defines the icon of the 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. |
getIconActive |
Gets current value of property iconActive. Determines whether the |
getIconAlt |
Gets current value of property iconAlt. Determines the alternative text of the Note: Provide an empty string value for the |
getIconDensityAware |
Gets current value of property iconDensityAware. By default, this is set to If bandwidth is the key for the application, set this value to Default value is |
getIconTooltip |
Gets current value of property iconTooltip. Determines the tooltip text of the |
getImageShape |
Gets current value of property imageShape. Determines whether the picture should be displayed in a square or with a circle-shaped mask just like in sap.uxap.ObjectPageHeader. Note: This property takes effect only on Images and it is ignored for Icons. Default value is |
getIntro |
Gets current value of property intro. Determines the introductory text for the |
getIntroActive |
Gets current value of property introActive. Determines whether the introductory text of the |
getIntroHref |
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 |
getIntroTarget |
Gets current value of property introTarget. Determines the |
getIntroTextDirection |
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 |
getMarkers |
Gets content of aggregation markers. List of markers (icon and/or text) that can be displayed for the |
getMarkFavorite |
Gets current value of property markFavorite. Sets the favorite state for the Default value is
Since 1.42.0 replaced by <code>markers</code> aggregation. Add {@link sap.m.ObjectMarker} with type <code>sap.m.ObjectMarkerType.Favorite</code>. You should use either this property or the <code>markers</code> aggregation, using both may lead to unpredicted behavior.
|
getMarkFlagged |
Gets current value of property markFlagged. Sets the flagged state for the Default value is
Since 1.42.0 replaced by <code>markers</code> aggregation. Add {@link sap.m.ObjectMarker} with type <code>sap.m.ObjectMarkerType.Flagged</code>. You should use either this property or the <code>markers</code> aggregation, using both may lead to unpredicted behavior.
|
sap.m.ObjectHeader.getMetadata |
Returns a metadata object for class sap.m.ObjectHeader. |
getNumber |
Gets current value of property number. Determines the displayed number of the |
getNumberState |
Gets current value of property numberState. Determines the value state of the Default value is |
getNumberTextDirection |
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 |
getNumberUnit |
Gets current value of property numberUnit. Determines the units qualifier of the Note: The value of the |
getResponsive |
Gets current value of property responsive. Determines whether the When the
Default value is |
getSecondStatus |
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.
Since 1.16.0 replaced by <code>statuses</code> aggregation
|
getShowMarkers |
Gets current value of property showMarkers. If set to Default value is
Since 1.42.0 replaced by <code>markers</code> aggregationv. This property is valid only if you are using the already deprecated properties - <code>markFlagged</code> and <code>markFavorite</code>. If you are using <code>markers</code>, the visibility of the markers depends on what is set in the aggregation itself.
|
getShowTitleSelector |
Gets current value of property showTitleSelector. Determines whether the selector arrow icon/image is displayed and can be pressed. Default value is |
getStatuses |
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. |
getTitle |
Gets current value of property title. Determines the title of the |
getTitleActive |
Gets current value of property titleActive. Determines whether the title of the |
getTitleHref |
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 |
getTitleLevel |
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 |
getTitleSelectorTooltip |
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 |
getTitleTarget |
Gets current value of property titleTarget. Determines the |
getTitleTextDirection |
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 |
indexOfAdditionalNumber |
Checks for the provided |
indexOfAttribute |
Checks for the provided |
indexOfMarker |
Checks for the provided |
indexOfStatus |
Checks for the provided |
insertAdditionalNumber |
Inserts a additionalNumber into the aggregation additionalNumbers. |
insertAttribute |
Inserts a attribute into the aggregation attributes. |
insertMarker |
Inserts a marker into the aggregation markers. |
insertStatus |
Inserts a status into the aggregation statuses. |
removeAdditionalNumber |
Removes a additionalNumber from the aggregation additionalNumbers. |
removeAllAdditionalNumbers |
Removes all the controls from the aggregation additionalNumbers. Additionally, it unregisters them from the hosting UIArea. |
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. Additionally, it unregisters them from the hosting UIArea. |
removeAllMarkers |
Removes all the controls from the aggregation markers. Additionally, it unregisters them from the hosting UIArea. |
removeAllStatuses |
Removes all the controls from the aggregation statuses. Additionally, it unregisters them from the hosting UIArea. |
removeAriaDescribedBy |
Removes an ariaDescribedBy from the association named ariaDescribedBy. |
removeAriaLabelledBy |
Removes an ariaLabelledBy from the association named ariaLabelledBy. |
removeAttribute |
Removes a attribute from the aggregation attributes. |
removeMarker |
Removes a marker from the aggregation markers. |
removeStatus |
Removes a status from the aggregation statuses. |
setBackgroundDesign |
Sets a new value for property backgroundDesign. Determines the background color of the Note: The different types of
When called with a value of |
setCondensed |
Set the condensed flag |
setFirstStatus |
Sets the aggregated firstStatus.
Since 1.16.0 replaced by <code>statuses</code> aggregation
|
setFullScreenOptimized |
Sets a new value for property fullScreenOptimized. Optimizes the display of the elements of the Set this property to Note: Only applied if the If set to
ObjectHeader .If set to
When called with a value of Default value is |
setHeaderContainer |
Sets the aggregated headerContainer. |
setIcon |
Sets a new value for property icon. Defines the icon of the 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 |
setIconActive |
Sets a new value for property iconActive. Determines whether the When called with a value of |
setIconAlt |
Sets the alternative text of the |
setIconDensityAware |
Sets a new value for property iconDensityAware. By default, this is set to If bandwidth is the key for the application, set this value to When called with a value of Default value is |
setIconTooltip |
Sets a new value for property iconTooltip. Determines the tooltip text of the When called with a value of |
setImageShape |
Sets a new value for property imageShape. Determines whether the picture should be displayed in a square or with a circle-shaped mask just like in sap.uxap.ObjectPageHeader. Note: This property takes effect only on Images and it is ignored for Icons. When called with a value of Default value is |
setIntro |
Sets a new value for property intro. Determines the introductory text for the When called with a value of |
setIntroActive |
Sets a new value for property introActive. Determines whether the introductory text of the When called with a value of |
setIntroHref |
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 When called with a value of |
setIntroTarget |
Sets a new value for property introTarget. Determines the When called with a value of |
setIntroTextDirection |
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 Default value is |
setMarkFavorite |
Sets the visibility value of the Favorite marker. |
setMarkFlagged |
Sets the visibility value of the Flagged marker. |
setNumber |
Set the number value to the internal aggregation |
setNumberState |
Set the number state to the internal aggregation |
setNumberTextDirection |
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 Default value is |
setNumberUnit |
Set the number unit to the internal aggregation |
setResponsive |
Sets a new value for property responsive. Determines whether the When the
When called with a value of Default value is |
setSecondStatus |
Sets the aggregated secondStatus.
Since 1.16.0 replaced by <code>statuses</code> aggregation
|
setShowMarkers |
Sets the visibility value of the Flagged and Favorite markers. |
setShowTitleSelector |
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 Default value is |
setTitle |
Sets a new value for property title. Determines the title of the When called with a value of |
setTitleActive |
Sets a new value for property titleActive. Determines whether the title of the When called with a value of |
setTitleHref |
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 When called with a value of |
setTitleLevel |
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 Default value is |
setTitleSelectorTooltip |
Sets the new text for the tooltip of the select title arrow to the internal aggregation |
setTitleTarget |
Sets a new value for property titleTarget. Determines the When called with a value of |
setTitleTextDirection |
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 Default value is |
Adds some additionalNumber to the aggregation additionalNumbers.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAdditionalNumber | sap.m.ObjectNumber |
The additionalNumber to add; if empty, nothing is inserted |
Adds some ariaDescribedBy into the association ariaDescribedBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaDescribedBy | sap.ui.core.ID sap.ui.core.Control |
The ariaDescribedBy to add; if empty, nothing is inserted |
Adds some ariaLabelledBy into the association ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to add; if empty, nothing is inserted |
Adds some attribute to the aggregation attributes.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAttribute | sap.m.ObjectAttribute |
The attribute to add; if empty, nothing is inserted |
Adds some marker to the aggregation markers.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMarker | sap.m.ObjectMarker |
The marker to add; if empty, nothing is inserted |
Adds some status to the aggregation statuses.
Param | Type | DefaultValue | Description |
---|---|---|---|
oStatus | sap.ui.core.Control |
The status to add; if empty, nothing is inserted |
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
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Destroys the firstStatus in the aggregation firstStatus.
Destroys the secondStatus in the aggregation secondStatus.
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event iconPress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
domRef | object |
Dom reference of the object header' icon to be used for positioning. |
Fires event introPress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
domRef | object |
Dom reference of the object header' intro to be used for positioning. |
Fires event titlePress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
domRef | object |
Dom reference of the object header' title to be used for positioning. |
Fires event titleSelectorPress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
domRef | object |
Dom reference of the object header' titleArrow to be used for positioning. |
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 array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Gets current value of property backgroundDesign.
Determines the background color of the ObjectHeader
.
Note: The different types of ObjectHeader
come with different default background:
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
.
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.
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:
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:
Default value is false
.
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.
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.
Gets current value of property iconActive.
Determines whether the ObjectHeader
icon is clickable.
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.
Note: Provide an empty string value for the iconAlt
property in case you want to use the icon for decoration only.
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
.
Gets current value of property iconTooltip.
Determines the tooltip text of the ObjectHeader
icon.
Gets current value of property imageShape.
Determines whether the picture should be displayed in a square or with a circle-shaped mask just like in sap.uxap.ObjectPageHeader.
Note: This property takes effect only on Images and it is ignored for Icons.
Default value is Square
.
Gets current value of property intro.
Determines the introductory text for the ObjectHeader
.
Gets current value of property introActive.
Determines whether the introductory text of the ObjectHeader
is clickable.
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.
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.
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
.
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.
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.
Default value is false
.
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.
Default value is false
.
Gets current value of property number.
Determines the displayed number of the ObjectHeader
number field.
Gets current value of property numberState.
Determines the value state of the number
and numberUnit
properties.
Default value is None
.
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
.
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
.
Gets current value of property responsive.
Determines whether the ObjectHeader
is rendered with a different design that reacts responsively to the screen sizes.
When the responsive
property is set to true
, the following behavior specifics for the control exist:
icon
property, it is hidden in portrait mode on phone.Default value is false
.
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.
Gets current value of property showMarkers.
If set to true
, the ObjectHeader
can be marked with icons such as favorite and flag.
Default value is false
.
Gets current value of property showTitleSelector.
Determines whether the selector arrow icon/image is displayed and can be pressed.
Default value is false
.
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.
Gets current value of property titleActive.
Determines whether the title of the ObjectHeader
is clickable and is set only if a title is provided.
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.
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
.
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"
.
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.
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
.
Checks for the provided sap.m.ObjectNumber
in the aggregation additionalNumbers. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAdditionalNumber | sap.m.ObjectNumber |
The additionalNumber whose index is looked for |
Checks for the provided sap.m.ObjectAttribute
in the aggregation attributes. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAttribute | sap.m.ObjectAttribute |
The attribute whose index is looked for |
Checks for the provided sap.m.ObjectMarker
in the aggregation markers. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMarker | sap.m.ObjectMarker |
The marker whose index is looked for |
Checks for the provided sap.ui.core.Control
in the aggregation statuses. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oStatus | sap.ui.core.Control |
The status whose index is looked for |
Inserts a additionalNumber into the aggregation additionalNumbers.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAdditionalNumber | sap.m.ObjectNumber |
The additionalNumber to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a attribute into the aggregation attributes.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAttribute | sap.m.ObjectAttribute |
The attribute to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a marker into the aggregation markers.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMarker | sap.m.ObjectMarker |
The marker to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a status into the aggregation statuses.
Param | Type | DefaultValue | Description |
---|---|---|---|
oStatus | sap.ui.core.Control |
The status to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes a additionalNumber from the aggregation additionalNumbers.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAdditionalNumber | int string sap.m.ObjectNumber |
The additionalNumber to remove or its index or id |
Removes all the controls from the aggregation additionalNumbers.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation attributes.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation markers.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation statuses.
Additionally, it unregisters them from the hosting UIArea.
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaDescribedBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaDescribedBy to be removed or its index or ID |
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to be removed or its index or ID |
Removes a attribute from the aggregation attributes.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAttribute | int string sap.m.ObjectAttribute |
The attribute to remove or its index or id |
Removes a marker from the aggregation markers.
Param | Type | DefaultValue | Description |
---|---|---|---|
vMarker | int string sap.m.ObjectMarker |
The marker to remove or its index or id |
Removes a status from the aggregation statuses.
Param | Type | DefaultValue | Description |
---|---|---|---|
vStatus | int string sap.ui.core.Control |
The status to remove or its index or id |
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:
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sBackgroundDesign | sap.m.BackgroundDesign |
New value for property |
Set the condensed flag
Param | Type | DefaultValue | Description |
---|---|---|---|
bCondensed | boolean |
the new value |
Sets the aggregated firstStatus.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFirstStatus | sap.m.ObjectStatus |
The firstStatus to set |
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:
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:
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFullScreenOptimized | boolean | false |
New value for property |
Sets the aggregated headerContainer.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContainer | sap.m.ObjectHeaderContainer |
The headerContainer to set |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIconActive | boolean |
New value for property |
Sets the alternative text of the ObjectHeader
icon.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIconAlt | boolean |
the alternative icon text |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIconDensityAware | boolean | true |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIconTooltip | string |
New value for property |
Sets a new value for property imageShape.
Determines whether the picture should be displayed in a square or with a circle-shaped mask just like in sap.uxap.ObjectPageHeader.
Note: This property takes effect only on Images and it is ignored for Icons.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Square
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sImageShape | sap.m.ObjectHeaderPictureShape | Square |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIntro | string |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIntroActive | boolean |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIntroHref | sap.ui.core.URI |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIntroTarget | string |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIntroTextDirection | sap.ui.core.TextDirection | Inherit |
New value for property |
Sets the visibility value of the Favorite marker.
Param | Type | DefaultValue | Description |
---|---|---|---|
bMarked | boolean |
visibility of the marker |
Sets the visibility value of the Flagged marker.
Param | Type | DefaultValue | Description |
---|---|---|---|
bMarked | boolean |
visibility of the marker |
Set the number value to the internal aggregation
Param | Type | DefaultValue | Description |
---|---|---|---|
sNumber | string |
the new value |
Set the number state to the internal aggregation
Param | Type | DefaultValue | Description |
---|---|---|---|
sState | sap.ui.core.ValueState |
the new value |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sNumberTextDirection | sap.ui.core.TextDirection | Inherit |
New value for property |
Set the number unit to the internal aggregation
Param | Type | DefaultValue | Description |
---|---|---|---|
sUnit | string |
the new value |
Sets a new value for property responsive.
Determines whether the ObjectHeader
is rendered with a different design that reacts responsively to the screen sizes.
When the responsive
property is set to true
, the following behavior specifics for the control exist:
icon
property, it is hidden in portrait mode on phone.When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bResponsive | boolean | false |
New value for property |
Sets the aggregated secondStatus.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSecondStatus | sap.m.ObjectStatus |
The secondStatus to set |
Sets the visibility value of the Flagged and Favorite markers.
Param | Type | DefaultValue | Description |
---|---|---|---|
bMarked | boolean |
visibility of all markers |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowTitleSelector | boolean | false |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
bTitleActive | boolean |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleHref | sap.ui.core.URI |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleLevel | sap.ui.core.TitleLevel | H1 |
New value for property |
Sets the new text for the tooltip of the select title arrow to the internal aggregation
Param | Type | DefaultValue | Description |
---|---|---|---|
sTooltip | string |
the tooltip of the title selector |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleTarget | string |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleTextDirection | sap.ui.core.TextDirection | Inherit |
New value for property |