Class sap.uxap.ObjectPageHeaderContentModule: sap/uxap/ObjectPageHeaderContent

extends Control

Header content for the classic header of the sap.uxap.ObjectPageLayout.

Overview

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:


Since: 1.30.
Constructor Summary
new sap.uxap.ObjectPageHeaderContent(sId?, mSettings?)Constructor for a new ObjectPageHeaderContent.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.uxap.ObjectPageHeaderContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageHeaderContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageHeaderContent.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
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.
getContentDesign()Gets current value of property contentDesign.
setContentDesign(sContentDesign)Sets a new value for property contentDesign.
Constructor Detail
new sap.uxap.ObjectPageHeaderContent(sId?, mSettings?)

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 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.uxap.ObjectPageHeaderContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.uxap.ObjectPageHeaderContent.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addContent(oContent): sap.uxap.ObjectPageHeaderContent
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentThe content to add; if empty, nothing is inserted
Returns:
sap.uxap.ObjectPageHeaderContentReference to this in order to allow method chaining
Destroys all the content in the aggregation content.
Returns:
sap.uxap.ObjectPageHeaderContentReference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The list of Objects of type sap.ui.core.Control.

Returns:
sap.ui.core.Control[]
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.uxap.ObjectPageHeaderContent
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.uxap.ObjectPageHeaderContentReference 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
getContentDesign(): sap.uxap.ObjectPageHeaderDesign

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:
sap.uxap.ObjectPageHeaderDesignValue of property contentDesign
Deprecated API:
Since version 1.40.1
setContentDesign(sContentDesign): sap.uxap.ObjectPageHeaderContent

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.

Parameters:
sap.uxap.ObjectPageHeaderDesignsContentDesignNew value for property contentDesign
Returns:
sap.uxap.ObjectPageHeaderContentReference to this in order to allow method chaining
Deprecated API:
Since version 1.40.1