Header of the sap.f.DynamicPage.
The DynamicPageHeader
control is part of the sap.f.DynamicPage family and is used to serve as header of the DynamicPage.
The DynamicPageHeader
can hold any layout control and has two states - expanded and collapsed (snapped). The switching between these states happens when:
headerExpanded
The responsive behavior of the DynamicPageHeader
depends on the behavior of the content that is displayed.
Constructor for a new DynamicPageHeader
.
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.DynamicPageHeader(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 default value of |
|
pinnable | boolean | true | Determines whether the header is pinnable. Visibility: public |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
_collapseButton | 0..1 | sap.m.Button |
Visual indication for expanding/collapsing. |
_pinButton | 0..1 | sap.m.Button |
The pin/unpin button in the header. |
content (default) | 0..n | sap.ui.core.Control |
The content of the header. |
Method | Description |
---|---|
addContent |
Adds some content to the aggregation content. |
destroyContent |
Destroys all the content in the aggregation content. |
sap.f.DynamicPageHeader.extend |
Creates a new subclass of class sap.f.DynamicPageHeader with name
|
getBackgroundDesign |
Gets current value of property backgroundDesign. Determines the background color of the Note: The default value of |
getContent |
Gets content of aggregation content. The content of the header. |
sap.f.DynamicPageHeader.getMetadata |
Returns a metadata object for class sap.f.DynamicPageHeader. |
getPinnable |
Gets current value of property pinnable. Determines whether the header is pinnable. Default value is |
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. |
setBackgroundDesign |
Sets a new value for property backgroundDesign. Determines the background color of the Note: The default value of When called with a value of |
setPinnable |
Sets a new value for property pinnable. Determines whether the header is pinnable. 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.f.DynamicPageHeader 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 backgroundDesign.
Determines the background color of the DynamicPageHeader
.
Note: The default value of backgroundDesign
property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground
, which depends on the specific theme.
Gets current value of property pinnable.
Determines whether the header is pinnable.
Default value is true
.
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 backgroundDesign.
Determines the background color of the DynamicPageHeader
.
Note: The default value of backgroundDesign
property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground
, which depends on the specific theme.
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 |
Sets a new value for property pinnable.
Determines whether the header is pinnable.
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 |
---|---|---|---|
bPinnable | boolean | true |
New value for property |