Class sap.f.DynamicPageTitleModule: sap/f/DynamicPageTitle

extends Control

Title of the sap.f.DynamicPage.

Overview

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

Usage

The DynamicPageTitle can hold any control and displays the most important information regarding the object that will always remain visible while scrolling.

Note: The actions aggregation accepts any UI5 control, but it`s recommended to use controls, suitable for sap.m.Toolbar and sap.m.OverflowToolbar.

If the toggleHeaderOnTitleClick property of the DynamicPage is set to true, the user can switch between the expanded/collapsed states of the DynamicPageHeader by clicking on the DynamicPageTitle. If set to false, the DynamicPageTitle is not clickable and the app must provide other means for expanding/collapsing the DynamicPageHeader, if necessary.

Responsive Behavior

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


Since: 1.42.
Constructor Summary
new sap.f.DynamicPageTitle(sId?, mSettings?)Constructor for a new DynamicPageTitle.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.f.DynamicPageTitle.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.f.DynamicPageTitle with name sClassName and enriches it with the information contained in oClassInfo.
sap.f.DynamicPageTitle.getMetadata()Returns a metadata object for class sap.f.DynamicPageTitle.
addAction(oAction)Adds some action to the aggregation actions.
addExpandedContent(oExpandedContent)Adds some expandedContent to the aggregation expandedContent.
addSnappedContent(oSnappedContent)Adds some snappedContent to the aggregation snappedContent.
destroyActions()Destroys all the actions in the aggregation actions.
destroyExpandedContent()Destroys all the expandedContent in the aggregation expandedContent.
destroyHeading()Destroys the heading in the aggregation heading.
destroySnappedContent()Destroys all the snappedContent in the aggregation snappedContent.
getActions()Gets content of aggregation actions.
getExpandedContent()Gets content of aggregation expandedContent.
getHeading()Gets content of aggregation heading.
getSnappedContent()Gets content of aggregation snappedContent.
indexOfAction(oAction)Checks for the provided sap.ui.core.Control in the aggregation actions.
indexOfExpandedContent(oExpandedContent)Checks for the provided sap.ui.core.Control in the aggregation expandedContent.
indexOfSnappedContent(oSnappedContent)Checks for the provided sap.ui.core.Control in the aggregation snappedContent.
insertAction(oAction, iIndex)Inserts a action into the aggregation actions.
insertExpandedContent(oExpandedContent, iIndex)Inserts a expandedContent into the aggregation expandedContent.
insertSnappedContent(oSnappedContent, iIndex)Inserts a snappedContent into the aggregation snappedContent.
removeAction(vAction)Removes a action from the aggregation actions.
removeAllActions()Removes all the controls from the aggregation actions.
removeAllExpandedContent()Removes all the controls from the aggregation expandedContent.
removeAllSnappedContent()Removes all the controls from the aggregation snappedContent.
removeExpandedContent(vExpandedContent)Removes a expandedContent from the aggregation expandedContent.
removeSnappedContent(vSnappedContent)Removes a snappedContent from the aggregation snappedContent.
setHeading(oHeading)Sets the aggregated heading.
Constructor Detail
new sap.f.DynamicPageTitle(sId?, mSettings?)

Constructor for a new DynamicPageTitle.

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:

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

Creates a new subclass of class sap.f.DynamicPageTitle 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.DynamicPageTitle.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.f.DynamicPageTitle.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAction(oAction): sap.f.DynamicPageTitle
Adds some action to the aggregation actions.
Parameters:
sap.ui.core.ControloActionthe action to add; if empty, nothing is inserted
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
addExpandedContent(oExpandedContent): sap.f.DynamicPageTitle
Adds some expandedContent to the aggregation expandedContent.
Parameters:
sap.ui.core.ControloExpandedContentthe expandedContent to add; if empty, nothing is inserted
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
addSnappedContent(oSnappedContent): sap.f.DynamicPageTitle
Adds some snappedContent to the aggregation snappedContent.
Parameters:
sap.ui.core.ControloSnappedContentthe snappedContent to add; if empty, nothing is inserted
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroyActions(): sap.f.DynamicPageTitle
Destroys all the actions in the aggregation actions.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroyExpandedContent(): sap.f.DynamicPageTitle
Destroys all the expandedContent in the aggregation expandedContent.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroyHeading(): sap.f.DynamicPageTitle
Destroys the heading in the aggregation heading.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroySnappedContent(): sap.f.DynamicPageTitle
Destroys all the snappedContent in the aggregation snappedContent.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
getActions(): sap.ui.core.Control[]

Gets content of aggregation actions.

The DynamicPageTitle actions.
Note: The actions aggregation accepts any UI5 control, but it`s recommended to use controls, suitable for sap.m.Toolbar and sap.m.OverflowToolbar.

Returns:
sap.ui.core.Control[]
getExpandedContent(): sap.ui.core.Control[]

Gets content of aggregation expandedContent.

The content that is displayed in the DynamicPageTitle in expanded state.

Returns:
sap.ui.core.Control[]
getHeading(): sap.ui.core.Control

Gets content of aggregation heading.

The title or any other UI5 control that serves as a heading for the object.

Returns:
sap.ui.core.Control
getSnappedContent(): sap.ui.core.Control[]

Gets content of aggregation snappedContent.

The content that is displayed in the DynamicPageTitle in collapsed (snapped) state.

Returns:
sap.ui.core.Control[]
indexOfAction(oAction): int
Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloActionThe action whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfExpandedContent(oExpandedContent): int
Checks for the provided sap.ui.core.Control in the aggregation expandedContent. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloExpandedContentThe expandedContent whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfSnappedContent(oSnappedContent): int
Checks for the provided sap.ui.core.Control in the aggregation snappedContent. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloSnappedContentThe snappedContent whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertAction(oAction, iIndex): sap.f.DynamicPageTitle
Inserts a action into the aggregation actions.
Parameters:
sap.ui.core.ControloActionthe action to insert; if empty, nothing is inserted
intiIndexthe 0-based index the action should be inserted at; for a negative value of iIndex, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
insertExpandedContent(oExpandedContent, iIndex): sap.f.DynamicPageTitle
Inserts a expandedContent into the aggregation expandedContent.
Parameters:
sap.ui.core.ControloExpandedContentthe expandedContent to insert; if empty, nothing is inserted
intiIndexthe 0-based index the expandedContent should be inserted at; for a negative value of iIndex, the expandedContent is inserted at position 0; for a value greater than the current size of the aggregation, the expandedContent is inserted at the last position
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
insertSnappedContent(oSnappedContent, iIndex): sap.f.DynamicPageTitle
Inserts a snappedContent into the aggregation snappedContent.
Parameters:
sap.ui.core.ControloSnappedContentthe snappedContent to insert; if empty, nothing is inserted
intiIndexthe 0-based index the snappedContent should be inserted at; for a negative value of iIndex, the snappedContent is inserted at position 0; for a value greater than the current size of the aggregation, the snappedContent is inserted at the last position
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
removeAction(vAction): sap.ui.core.Control
Removes a action from the aggregation actions.
Parameters:
int|string|sap.ui.core.ControlvActionThe action to remove or its index or id
Returns:
sap.ui.core.ControlThe removed action or null
removeAllActions(): sap.ui.core.Control[]

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAllExpandedContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation expandedContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAllSnappedContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation snappedContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeExpandedContent(vExpandedContent): sap.ui.core.Control
Removes a expandedContent from the aggregation expandedContent.
Parameters:
int|string|sap.ui.core.ControlvExpandedContentThe expandedContent to remove or its index or id
Returns:
sap.ui.core.ControlThe removed expandedContent or null
removeSnappedContent(vSnappedContent): sap.ui.core.Control
Removes a snappedContent from the aggregation snappedContent.
Parameters:
int|string|sap.ui.core.ControlvSnappedContentThe snappedContent to remove or its index or id
Returns:
sap.ui.core.ControlThe removed snappedContent or null
setHeading(oHeading): sap.f.DynamicPageTitle
Sets the aggregated heading.
Parameters:
sap.ui.core.ControloHeadingThe heading to set
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining