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

extends Control

ObjectPageHeaderContent represents the dynamic part of an Object page header. May contain any control. Unlike the Object page header title, the Object page header content is part of the scrolling area of the Object page. This enables it to hold any amount of information and still be usable on a mobile device.


Since: 1.30.
Constructor Summary
new sap.uxap.ObjectPageHeaderContent(sId?, mSettings?)Constructor for a new ObjectPageHeaderContent.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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.
getContentDesign()Gets current value of property contentDesign.
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.
setContentDesign(sContentDesign)Sets a new value for property contentDesign.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
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:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? 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:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.uxap.ObjectPageHeaderContent.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageHeaderContent.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.uxap.ObjectPageHeaderContent
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.uxap.ObjectPageHeaderContent} Reference to this in order to allow method chaining
destroyContent(): sap.uxap.ObjectPageHeaderContent
Destroys all the content in the aggregation content.
Returns:
{sap.uxap.ObjectPageHeaderContent} Reference 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[]}
getContentDesign(): sap.uxap.ObjectPageHeaderDesign
Gets current value of property contentDesign.

Determines the design of the header - Light or Dark

Default value is Light.

Returns:
{sap.uxap.ObjectPageHeaderDesign} Value of property contentDesign
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.Control}oContent The content whose index is looked for
Returns:
{int} The 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.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex the 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.ObjectPageHeaderContent} Reference 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.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
setContentDesign(sContentDesign): sap.uxap.ObjectPageHeaderContent
Sets a new value for property contentDesign.

Determines the design of the header - Light or Dark

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.ObjectPageHeaderDesign}sContentDesign New value for property contentDesign
Returns:
{sap.uxap.ObjectPageHeaderContent} Reference to this in order to allow method chaining