Header content for the classic header of the sap.uxap.ObjectPageLayout.
The ObjectPageHeaderContent
represents the movable part of the ObjectPageLayout
's classic header. It can contain any control and scrolls along with the content of the page until it disappears (collapsed header). When scrolled back to the top it becomes visible again (expanded header). It contains all the additional information of the object.
Documentation links:
Constructor for a new ObjectPageHeaderContent
.
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.uxap.ObjectPageHeaderContent(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 |
---|---|---|---|
contentDesign | sap.uxap.ObjectPageHeaderDesign | Light | Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_editHeaderButton | 0..1 | sap.m.Button |
Internal aggregation for the "Edit Header" button. |
_objectImage | 0..1 | sap.ui.core.Control | |
_placeholder | 0..1 | sap.m.Avatar | |
content | 0..n | sap.ui.core.Control |
The list of Objects of type sap.ui.core.Control. |
Method | Description |
---|---|
addContent |
Adds some content to the aggregation content. |
destroyContent |
Destroys all the content in the aggregation content. |
sap.uxap.ObjectPageHeaderContent.extend |
Creates a new subclass of class sap.uxap.ObjectPageHeaderContent with name
|
getContent |
Gets content of aggregation content. The list of Objects of type sap.ui.core.Control. |
getContentDesign |
Gets current value of property contentDesign. Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes. Default value is |
sap.uxap.ObjectPageHeaderContent.getMetadata |
Returns a metadata object for class sap.uxap.ObjectPageHeaderContent. |
indexOfContent |
Checks for the provided |
insertContent |
Inserts a content into the aggregation content. |
removeAllContent |
Removes all the controls from the aggregation content. Additionally, it unregisters them from the hosting UIArea. |
removeContent |
Removes a content from the aggregation content. |
setContentDesign |
Sets a new value for property contentDesign. Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes. When called with a value of Default value is |
Adds some content to the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to add; if empty, nothing is inserted |
Creates a new subclass of class sap.uxap.ObjectPageHeaderContent 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 contentDesign.
Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
Default value is Light
.
Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
Checks for the provided sap.ui.core.Control
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content whose index is looked for |
Inserts a content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.core.Control |
The content to remove or its index or id |
Sets a new value for property contentDesign.
Determines the design of the header - Light or Dark. Note: This property is deprecated. It will continue to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Light
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sContentDesign | sap.uxap.ObjectPageHeaderDesign | Light |
New value for property |