sap.m.ObjectHeader.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.ObjectHeader with name
sClassName
and enriches it with the information contained in
oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.core.Control.extend.
Parameters:
{string} | sClassName | Name of the class being created |
{object} | oClassInfo? | Object literal with information about the class |
{function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
{function} | Created class / constructor function |
Returns a metadata object for class sap.m.ObjectHeader.
Returns:
Adds some additionalNumber to the aggregation additionalNumbers
.
Parameters:
{sap.m.ObjectNumber} | oAdditionalNumber | the additionalNumber to add; if empty, nothing is inserted |
- Since:
- 1.38.0
Returns:
Adds some ariaDescribedBy into the association ariaDescribedBy
.
Parameters:
{string|sap.ui.core.Control} | vAriaDescribedBy | the ariaDescribedBy to add; if empty, nothing is inserted |
Returns:
Adds some ariaLabelledBy into the association ariaLabelledBy
.
Parameters:
{string|sap.ui.core.Control} | vAriaLabelledBy | the ariaLabelledBy to add; if empty, nothing is inserted |
Returns:
Adds some attribute to the aggregation attributes
.
Parameters:
Returns:
Adds some status to the aggregation statuses
.
Parameters:
- Since:
- 1.16.0
Returns:
Attaches event handler
fnFunction
to the
iconPress
event of this
sap.m.ObjectHeader
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.ObjectHeader
itself.
Event is fired when the title icon is active and the user taps/clicks on it
Parameters:
{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 |
Returns:
Attaches event handler
fnFunction
to the
introPress
event of this
sap.m.ObjectHeader
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.ObjectHeader
itself.
Event is fired when the intro is active and the user taps/clicks on it
Parameters:
{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 |
Returns:
Attaches event handler
fnFunction
to the
titlePress
event of this
sap.m.ObjectHeader
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.ObjectHeader
itself.
Event is fired when the title is active and the user taps/clicks on it
Parameters:
{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 |
Returns:
Attaches event handler
fnFunction
to the
titleSelectorPress
event of this
sap.m.ObjectHeader
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.ObjectHeader
itself.
Event is fired when the object header title selector (down-arrow) is pressed
Parameters:
{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
Returns:
Destroys all the additionalNumbers in the aggregation additionalNumbers
.
- Since:
- 1.38.0
Returns:
Destroys all the attributes in the aggregation attributes
.
Returns:
Destroys the headerContainer in the aggregation headerContainer
.
- Since:
- 1.21.1
Returns:
Destroys all the statuses in the aggregation statuses
.
- Since:
- 1.16.0
Returns:
Detaches event handler
fnFunction
from the
iconPress
event of this
sap.m.ObjectHeader
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
introPress
event of this
sap.m.ObjectHeader
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
titlePress
event of this
sap.m.ObjectHeader
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
titleSelectorPress
event of this
sap.m.ObjectHeader
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{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
Returns:
Fires event
iconPress
to attached listeners.
Expects the following event parameters:
domRef
of type object
Dom reference of the object header' icon to be used for positioning.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
introPress
to attached listeners.
Expects the following event parameters:
domRef
of type object
Dom reference of the object header' intro to be used for positioning.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
titlePress
to attached listeners.
Expects the following event parameters:
domRef
of type object
Dom reference of the object header' title to be used for positioning.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
titleSelectorPress
to attached listeners.
Expects the following event parameters:
domRef
of type object
Dom reference of the object header' titleArrow to be used for positioning.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.16.0
Returns:
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.
- Since:
- 1.38.0
Returns:
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy
.
Returns:
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy
.
Returns:
Gets content of aggregation
attributes
.
The list of Object Attributes
Returns:
Gets current value of property
backgroundDesign
.
Determines the background color of the ObjectHeader
.
Note: The different types of ObjectHeader
come with different default background:
- non responsive - Transparent
- responsive - Translucent
- condensed - Solid
Returns:
getCondensed(): boolean
Gets current value of property
condensed
.
ObjectHeader
with title, one attribute, number, and number unit.
Note: Only applied if the responsive
property is set to false
.
Default value is false
.
Returns:
{boolean} | Value of property condensed |
getFullScreenOptimized(): boolean
Gets current value of property
fullScreenOptimized
.
Optimizes the display of the elements of the ObjectHeader
.
Set this property to true
if your app uses a fullscreen layout (as opposed to a master-detail or other split-screen layout).
Note: Only applied if the responsive
property is also set to true
.
If set to true
, the following situations apply:
- On desktop, 1-3 attributes/statuses - positioned as a third block on the right side of the Title/Number group
- On desktop, 4+ attributes/statuses - 4 columns below the Title/Number
- On tablet (portrait mode), always in 2 columns below the Title/Number
- On tablet (landscape mode), 1-2 attributes/statuses - 2 columns below the Title/Number
- On tablet (landscape mode), 3+ attributes/statuses - 3 columns below the Title/Number
On phone, the attributes and statuses are always positioned in 1 column below the Title/Number of the
ObjectHeader
.
If set to false
, the attributes and statuses are being positioned below the Title/Number of the ObjectHeader
in 2 or 3 columns depending on their number:
- On desktop, 1-4 attributes/statuses - 2 columns
- On desktop, 5+ attributes/statuses - 3 columns
- On tablet, always in 2 columns
Default value is false
.
- Since:
- 1.28
Returns:
{boolean} | Value of property fullScreenOptimized |
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 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
Returns:
Gets current value of property
icon
.
Defines the icon of the ObjectHeader
.
Note: Recursive resolution of binding expressions is not supported by the framework. It works only in ObjectHeader, since it is a composite control and creates an Image control internally.
Returns:
getIconActive(): boolean
Gets current value of property
iconActive
.
Determines whether the ObjectHeader
icon is clickable.
Returns:
{boolean} | Value of property iconActive |
getIconAlt(): string
Gets current value of property
iconAlt
.
Determines the alternative text of the ObjectHeader
icon. The text is displayed if the image for the icon is not available, or cannot be displayed.
Returns:
{string} | Value of property iconAlt |
getIconDensityAware(): boolean
Gets current value of property
iconDensityAware
.
By default, this is set to true
but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
If bandwidth is the key for the application, set this value to false
.
Default value is true
.
Returns:
{boolean} | Value of property iconDensityAware |
getIntro(): string
Gets current value of property
intro
.
Determines the introductory text for the ObjectHeader
.
Returns:
{string} | Value of property intro |
getIntroActive(): boolean
Gets current value of property
introActive
.
Determines whether the introductory text of the ObjectHeader
is clickable.
Returns:
{boolean} | Value of property introActive |
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.
- Since:
- 1.28
Returns:
getIntroTarget(): string
Gets current value of property
introTarget
.
Determines the target
attribute for the intro link. Options are _self
, _top
, _blank
, _parent
, _search
. Alternatively, a frame name can be entered.
- Since:
- 1.28
Returns:
{string} | Value of property introTarget |
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
.
- Since:
- 1.28.0
Returns:
getMarkFavorite(): boolean
Gets current value of property
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
Returns:
{boolean} | Value of property markFavorite |
getMarkFlagged(): boolean
Gets current value of property
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
Returns:
{boolean} | Value of property markFlagged |
getNumber(): string
Gets current value of property
number
.
Determines the displayed number of the ObjectHeader
number field.
Returns:
{string} | Value of property number |
Gets current value of property
numberState
.
Determines the value state of the number and numberUnit properties.
Default value is None
.
- Since:
- 1.16.0
Returns:
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:
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 |
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:
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 |
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:
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:
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 |
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:
indexOfAdditionalNumber(oAdditionalNumber): int
Checks for the provided sap.m.ObjectNumber
in the aggregation additionalNumbers
. and returns its index if found or -1 otherwise.
Parameters:
- 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:
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:
- Since:
- 1.16.0
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
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:
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:
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:
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:
Removes all the controls from the aggregation
additionalNumbers
.
Additionally, it unregisters them from the hosting UIArea.
- Since:
- 1.38.0
Returns:
Removes all the controls in the association named ariaDescribedBy
.
Returns:
Removes all the controls in the association named ariaLabelledBy
.
Returns:
Removes all the controls from the aggregation
attributes
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes all the controls from the aggregation
statuses
.
Additionally, it unregisters them from the hosting UIArea.
- Since:
- 1.16.0
Returns:
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:
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:
Removes a attribute from the aggregation attributes
.
Parameters:
Returns:
Removes a status from the aggregation statuses
.
Parameters:
- Since:
- 1.16.0
Returns:
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:
Returns:
Set the condensed flag
Parameters:
{boolean} | bCondensed | the new value |
Returns:
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:
Sets the aggregated headerContainer
.
Parameters:
- Since:
- 1.21.1
Returns:
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:
Returns:
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:
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:
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:
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:
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:
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:
- Since:
- 1.28
Returns:
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:
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:
- Since:
- 1.28.0
Returns:
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:
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:
Set the number value to the internal aggregation
Parameters:
{string} | sNumber | the new value |
Returns:
Set the number state to the internal aggregation
Parameters:
Returns:
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:
- Since:
- 1.28.0
Returns:
Set the number unit to the internal aggregation
Parameters:
{string} | sUnit | the new value |
Returns:
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:
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:
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:
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:
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:
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:
- Since:
- 1.28
Returns:
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:
Returns:
Sets the new text for the tooltip of the select title arrow to the internal aggregation
Parameters:
Returns:
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:
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:
- Since:
- 1.28.0
Returns:
Destroys the firstStatus in the aggregation firstStatus
.
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:
Destroys the secondStatus in the aggregation secondStatus
.
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:
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:
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:
Sets the aggregated firstStatus
.
Parameters:
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns:
Sets the aggregated secondStatus
.
Parameters:
- Deprecated:
- Since version 1.16.0. Use the statuses aggregation instead.
Returns: