Class sap.f.DynamicPageHeaderModule: sap/f/DynamicPageHeader

extends Control

Header of the sap.f.DynamicPage.

Overview

The DynamicPageHeader control is part of the sap.f.DynamicPage family and is used to serve as header of the DynamicPage.

Usage

The DynamicPageHeader can hold any layout control and has two states - expanded and collapsed (snapped). The switching between these states happens when:

Responsive Behavior

The responsive behavior of the DynamicPageHeader depends on the behavior of the content that is displayed.


Since: 1.42.
Constructor Summary
new sap.f.DynamicPageHeader(sId?, mSettings?)Constructor for a new DynamicPageHeader.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.f.DynamicPageHeader.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.f.DynamicPageHeader with name sClassName and enriches it with the information contained in oClassInfo.
sap.f.DynamicPageHeader.getMetadata()Returns a metadata object for class sap.f.DynamicPageHeader.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
getPinnable()Gets current value of property pinnable.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setPinnable(bPinnable)Sets a new value for property pinnable.
Constructor Detail
new sap.f.DynamicPageHeader(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Method Detail
sap.f.DynamicPageHeader.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.f.DynamicPageHeader.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.f.DynamicPageHeader.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addContent(oContent): sap.f.DynamicPageHeader
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to add; if empty, nothing is inserted
Returns:
sap.f.DynamicPageHeaderReference to this in order to allow method chaining
destroyContent(): sap.f.DynamicPageHeader
Destroys all the content in the aggregation content.
Returns:
sap.f.DynamicPageHeaderReference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The content of the header.

Returns:
sap.ui.core.Control[]
getPinnable(): boolean

Gets current value of property pinnable.

Determines whether the header is pinnable.

Default value is true.

Returns:
booleanValue of property pinnable
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloContentThe content whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.f.DynamicPageHeader
Inserts a content into the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
sap.f.DynamicPageHeaderReference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
int|string|sap.ui.core.ControlvContentThe content to remove or its index or id
Returns:
sap.ui.core.ControlThe removed content or null
setPinnable(bPinnable): sap.f.DynamicPageHeader

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.

Parameters:
booleanbPinnableNew value for property pinnable
Returns:
sap.f.DynamicPageHeaderReference to this in order to allow method chaining