Provides basic functionality for header controls that can be used in sap.f.Card
Constructor for a new BaseHeader
.
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.f.cards.BaseHeader(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 |
---|---|---|---|
dataTimestamp | string | empty string | Defines the timestamp of the oldest data in the card. Use this to show to the end user how fresh the information in the card is. Must be specified in ISO 8601 format. Will be shown as a relative time like "5 minutes ago". Visibility: public |
dataTimestampUpdating | boolean | false | Set to true to show that the data timestamp is currently updating. Visibility: hidden |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_dataTimestamp | 0..1 | sap.m.Text |
Holds the internal data timestamp text aggregation. |
_error | 0..1 | sap.ui.core.Control |
Defines an error which will be displayed in the header. |
toolbar | 0..1 | sap.ui.core.Control |
Defines the toolbar. |
Method | Description |
---|---|
destroyToolbar |
Destroys the toolbar in the aggregation toolbar. |
sap.f.cards.BaseHeader.extend |
Creates a new subclass of class sap.f.cards.BaseHeader with name
|
getAriaHeadingLevel | |
getAriaRole | |
getAriaRoleDescription | |
getDataTimestamp |
Gets current value of property dataTimestamp. Defines the timestamp of the oldest data in the card. Use this to show to the end user how fresh the information in the card is. Must be specified in ISO 8601 format. Will be shown as a relative time like "5 minutes ago". Default value is |
sap.f.cards.BaseHeader.getMetadata |
Returns a metadata object for class sap.f.cards.BaseHeader. |
sap.f.cards.BaseHeader.getTimestampIntervalTrigger |
Gets or creates an interval trigger for the timestamp which is shared for all card headers. |
getToolbar |
Gets content of aggregation toolbar. Defines the toolbar. |
setToolbar |
Sets the aggregated toolbar. |
Creates a new subclass of class sap.f.cards.BaseHeader 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 |
Gets current value of property dataTimestamp.
Defines the timestamp of the oldest data in the card. Use this to show to the end user how fresh the information in the card is.
Must be specified in ISO 8601 format.
Will be shown as a relative time like "5 minutes ago".
Default value is empty string
.
Gets or creates an interval trigger for the timestamp which is shared for all card headers.
Sets the aggregated toolbar.
Param | Type | DefaultValue | Description |
---|---|---|---|
oToolbar | sap.ui.core.Control |
The toolbar to set |