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

extends Control
known direct subclasses: ObjectPageDynamicHeaderTitle

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 or by using the expand/collapse visual indicators, positioned at the bottom of the DynamicPageTitle and the DynamicPageHeader.

If set to false, the DynamicPageTitle is not clickable, the visual indicators are not available, 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.
Event Summary
stateChange(oControlEvent)Fired when the title state (expanded/collapsed) is toggled by user interaction.
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.
addContent(oContent)Adds some content to the aggregation content.
addExpandedContent(oExpandedContent)Adds some expandedContent to the aggregation expandedContent.
addNavigationAction(oNavigationAction)Adds some navigationAction to the aggregation navigationActions.
addSnappedContent(oSnappedContent)Adds some snappedContent to the aggregation snappedContent.
attachStateChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the stateChange event of this sap.f.DynamicPageTitle.
destroyActions()Destroys all the actions in the aggregation actions.
destroyBreadcrumbs()Destroys the breadcrumbs in the aggregation breadcrumbs.
destroyContent()Destroys all the content in the aggregation content.
destroyExpandedContent()Destroys all the expandedContent in the aggregation expandedContent.
destroyExpandedHeading()Destroys the expandedHeading in the aggregation expandedHeading.
destroyHeading()Destroys the heading in the aggregation heading.
destroyNavigationActions()Destroys all the navigationActions in the aggregation navigationActions.
destroySnappedContent()Destroys all the snappedContent in the aggregation snappedContent.
destroySnappedHeading()Destroys the snappedHeading in the aggregation snappedHeading.
detachStateChange(fnFunction, oListener)Detaches event handler fnFunction from the stateChange event of this sap.f.DynamicPageTitle.
fireStateChange(mParameters?)Fires event stateChange to attached listeners.
getActions()Gets content of aggregation actions.
getAreaShrinkRatio()Gets current value of property areaShrinkRatio.
getBreadcrumbs()Gets content of aggregation breadcrumbs.
getContent()Gets content of aggregation content.
getExpandedContent()Gets content of aggregation expandedContent.
getExpandedHeading()Gets content of aggregation expandedHeading.
getHeading()Gets content of aggregation heading.
getNavigationActions()Gets content of aggregation navigationActions.
getSnappedContent()Gets content of aggregation snappedContent.
getSnappedHeading()Gets content of aggregation snappedHeading.
indexOfAction(oAction)Checks for the provided sap.ui.core.Control in the aggregation actions.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
indexOfExpandedContent(oExpandedContent)Checks for the provided sap.ui.core.Control in the aggregation expandedContent.
indexOfNavigationAction(oNavigationAction)Checks for the provided sap.m.Button in the aggregation navigationActions.
indexOfSnappedContent(oSnappedContent)Checks for the provided sap.ui.core.Control in the aggregation snappedContent.
insertAction(oAction, iIndex)Inserts a action into the aggregation actions.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
insertExpandedContent(oExpandedContent, iIndex)Inserts a expandedContent into the aggregation expandedContent.
insertNavigationAction(oNavigationAction, iIndex)Inserts a navigationAction into the aggregation navigationActions.
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.
removeAllContent()Removes all the controls from the aggregation content.
removeAllExpandedContent()Removes all the controls from the aggregation expandedContent.
removeAllNavigationActions()Removes all the controls from the aggregation navigationActions.
removeAllSnappedContent()Removes all the controls from the aggregation snappedContent.
removeContent(vContent)Removes a content from the aggregation content.
removeExpandedContent(vExpandedContent)Removes a expandedContent from the aggregation expandedContent.
removeNavigationAction(vNavigationAction)Removes a navigationAction from the aggregation navigationActions.
removeSnappedContent(vSnappedContent)Removes a snappedContent from the aggregation snappedContent.
setAreaShrinkRatio(sAreaShrinkRatio)Sets the value of the areaShrinkRatio property.
setBreadcrumbs(oBreadcrumbs)Sets the aggregated breadcrumbs.
setExpandedHeading(oExpandedHeading)Sets the aggregated expandedHeading.
setHeading(oHeading)Sets the aggregated heading.
setSnappedHeading(oSnappedHeading)Sets the aggregated snappedHeading.
getPrimaryArea()Gets current value of property primaryArea.
setPrimaryArea(sPrimaryArea)Sets a new value for property primaryArea.
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
Event Detail
stateChange(oControlEvent)

Fired when the title state (expanded/collapsed) is toggled by user interaction. For example, scrolling, title clicking/tapping, using expand/collapse button.

Also fired when the developer toggles the title state by programmatically changing the scroll position of the scrollbar of DynamicPage.

Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
booleanoControlEvent.getParameters.isExpandedWhether the title was expanded (true) or collapsed (false).
Since:
1.54
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
addContent(oContent): sap.f.DynamicPageTitle
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentThe content to add; if empty, nothing is inserted
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.50
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
addNavigationAction(oNavigationAction): sap.f.DynamicPageTitle
Adds some navigationAction to the aggregation navigationActions.
Parameters:
sap.m.ButtonoNavigationActionThe navigationAction to add; if empty, nothing is inserted
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
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
attachStateChange(oData?, fnFunction, oListener?): sap.f.DynamicPageTitle

Attaches event handler fnFunction to the stateChange event of this sap.f.DynamicPageTitle.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.f.DynamicPageTitle itself.

Fired when the title state (expanded/collapsed) is toggled by user interaction. For example, scrolling, title clicking/tapping, using expand/collapse button.

Also fired when the developer toggles the title state by programmatically changing the scroll position of the scrollbar of DynamicPage.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.f.DynamicPageTitle itself
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.54
destroyActions(): sap.f.DynamicPageTitle
Destroys all the actions in the aggregation actions.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroyBreadcrumbs(): sap.f.DynamicPageTitle
Destroys the breadcrumbs in the aggregation breadcrumbs.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
destroyContent(): sap.f.DynamicPageTitle
Destroys all the content in the aggregation content.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.50
destroyExpandedContent(): sap.f.DynamicPageTitle
Destroys all the expandedContent in the aggregation expandedContent.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroyExpandedHeading(): sap.f.DynamicPageTitle
Destroys the expandedHeading in the aggregation expandedHeading.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
destroyHeading(): sap.f.DynamicPageTitle
Destroys the heading in the aggregation heading.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroyNavigationActions(): sap.f.DynamicPageTitle
Destroys all the navigationActions in the aggregation navigationActions.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
destroySnappedContent(): sap.f.DynamicPageTitle
Destroys all the snappedContent in the aggregation snappedContent.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
destroySnappedHeading(): sap.f.DynamicPageTitle
Destroys the snappedHeading in the aggregation snappedHeading.
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
detachStateChange(fnFunction, oListener): sap.f.DynamicPageTitle

Detaches event handler fnFunction from the stateChange event of this sap.f.DynamicPageTitle.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.54
fireStateChange(mParameters?): sap.f.DynamicPageTitle
Fires event stateChange to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
booleanmParameters.isExpanded?Whether the title was expanded (true) or collapsed (false).
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.54
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[]
getAreaShrinkRatio(): sap.f.DynamicPageTitleShrinkRatio

Gets current value of property areaShrinkRatio.

Assigns shrinking ratio to the DynamicPageTitle areas (Heading, Content, Actions). The greater value a section has the faster it shrinks when the screen size is being reduced.

The value must be set in Heading:Content:Actions format where Title, Content and Actions are numbers greater than or equal to 0. If set to 0, the respective area will not shrink.

For example, if 2:7:1 is set, the Content area will shrink seven times faster than the Actions area. So, when all three areas have width of 500px and the available space is reduced by 100px the Title area will reduced by 20px, the Content area - by 70px and the Actions area - by 10px.

If all the areas have assigned values greater than 1, the numbers are scaled so that at least one of them is equal to 1. For example, value of 2:4:8 is equal to 1:2:4.

When this property is set the primaryArea property has no effect.

Default value is 1:1.6:1.6.

Returns:
sap.f.DynamicPageTitleShrinkRatioValue of property areaShrinkRatio
Since:
1.54
getBreadcrumbs(): sap.m.IBreadcrumbs

Gets content of aggregation breadcrumbs.

The breadcrumbs displayed in the DynamicPageTitle top-left area.

Returns:
sap.m.IBreadcrumbs
Since:
1.52
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The content is positioned in the DynamicPageTitle middle area and displayed in both expanded and collapsed (snapped) states.

Returns:
sap.ui.core.Control[]
Since:
1.50
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[]
getExpandedHeading(): sap.ui.core.Control

Gets content of aggregation expandedHeading.

The expandedHeading is positioned in the DynamicPageTitle left area and is displayed when the header is in expanded state only. Use this aggregation to display a title (or any other UI5 control that serves as a heading) that has to be present in expanded state only.

Note: In order for expandedHeading to be taken into account, heading has to be empty. Combine expandedHeading with snappedHeading to switch content when the header switches state.

Returns:
sap.ui.core.Control
Since:
1.52
getHeading(): sap.ui.core.Control

Gets content of aggregation heading.

The heading is positioned in the DynamicPageTitle left area and is displayed in both expanded and collapsed (snapped) states of the header. Use this aggregation to display a title (or any other UI5 control that serves as a heading) that has to be present in both expanded and collapsed states of the header.

Note:heading is mutually exclusive with snappedHeading and expandedHeading. If heading is provided, both snappedHeading and expandedHeading are ignored. heading is useful when the content of snappedHeading and expandedHeading needs to be the same as it replaces them both.

Returns:
sap.ui.core.Control
getNavigationActions(): sap.m.Button[]

Gets content of aggregation navigationActions.

The DynamicPageTitle navigation actions.

Note: The navigationActions position depends on the control size. If the control size is 1280px or bigger, they are rendered right next to the actions. Otherwise, they are rendered in the top-right area, above the actions. If a large number of elements(buttons) are used, there could be visual degradations as the space for the navigationActions is limited.

Returns:
sap.m.Button[]
Since:
1.52
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[]
getSnappedHeading(): sap.ui.core.Control

Gets content of aggregation snappedHeading.

The snappedHeading is positioned in the DynamicPageTitle left area and is displayed when the header is in collapsed (snapped) state only. Use this aggregation to display a title (or any other UI5 control that serves as a heading) that has to be present in collapsed state only.

Note: In order for snappedHeading to be taken into account, heading has to be empty. Combine snappedHeading with expandedHeading to switch content when the header switches state.

Returns:
sap.ui.core.Control
Since:
1.52
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
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
Since:
1.50
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
indexOfNavigationAction(oNavigationAction): int
Checks for the provided sap.m.Button in the aggregation navigationActions. and returns its index if found or -1 otherwise.
Parameters:
sap.m.ButtonoNavigationActionThe navigationAction whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
Since:
1.52
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
insertContent(oContent, iIndex): sap.f.DynamicPageTitle
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.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.50
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
insertNavigationAction(oNavigationAction, iIndex): sap.f.DynamicPageTitle
Inserts a navigationAction into the aggregation navigationActions.
Parameters:
sap.m.ButtonoNavigationActionThe navigationAction to insert; if empty, nothing is inserted
intiIndexThe 0-based index the navigationAction should be inserted at; for a negative value of iIndex, the navigationAction is inserted at position 0; for a value greater than the current size of the aggregation, the navigationAction is inserted at the last position
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
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)
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)
Since:
1.50
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)
removeAllNavigationActions(): sap.m.Button[]

Removes all the controls from the aggregation navigationActions.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.Button[]An array of the removed elements (might be empty)
Since:
1.52
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)
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
Since:
1.50
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
removeNavigationAction(vNavigationAction): sap.m.Button
Removes a navigationAction from the aggregation navigationActions.
Parameters:
int|string|sap.m.ButtonvNavigationActionThe navigationAction to remove or its index or id
Returns:
sap.m.ButtonThe removed navigationAction or null
Since:
1.52
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
setAreaShrinkRatio(sAreaShrinkRatio): sap.f.DynamicPageTitle
Sets the value of the areaShrinkRatio property.
Parameters:
sap.f.DynamicPageTitleShrinkRatiosAreaShrinkRationew value of the areaShrinkRatio
Returns:
sap.f.DynamicPageTitlethis to allow method chaining
Since:
1.54
setBreadcrumbs(oBreadcrumbs): sap.f.DynamicPageTitle
Sets the aggregated breadcrumbs.
Parameters:
sap.m.IBreadcrumbsoBreadcrumbsThe breadcrumbs to set
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
setExpandedHeading(oExpandedHeading): sap.f.DynamicPageTitle
Sets the aggregated expandedHeading.
Parameters:
sap.ui.core.ControloExpandedHeadingThe expandedHeading to set
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
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
setSnappedHeading(oSnappedHeading): sap.f.DynamicPageTitle
Sets the aggregated snappedHeading.
Parameters:
sap.ui.core.ControloSnappedHeadingThe snappedHeading to set
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Since:
1.52
getPrimaryArea(): sap.f.DynamicPageTitleArea

Gets current value of property primaryArea.

Determines which of the DynamicPageTitle areas (Begin, Middle) is primary.

Note: The primary area is shrinking at lower rate, remaining visible as much as it can.

Default value is Begin.

Returns:
sap.f.DynamicPageTitleAreaValue of property primaryArea
Deprecated API:

Since version 1.54. Please use the areaShrinkRatio property instead. The value of areaShrinkRatio must be set in Heading:Content:Actions format where Heading, Content and Actions are numbers greater than or equal to 0. The greater value a section has the faster it shrinks when the screen size is being reduced.

primaryArea=Begin can be achieved by setting a low number for the Heading area to areaShrinkRatio, for example 1:1.6:1.6.

primaryArea=Middle can be achieved by setting a low number for the Content area to areaShrinkRatio, for example 1.6:1:1.6.

Since:
1.50
setPrimaryArea(sPrimaryArea): sap.f.DynamicPageTitle

Sets a new value for property primaryArea.

Determines which of the DynamicPageTitle areas (Begin, Middle) is primary.

Note: The primary area is shrinking at lower rate, remaining visible as much as it can.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Begin.

Parameters:
sap.f.DynamicPageTitleAreasPrimaryAreaNew value for property primaryArea
Returns:
sap.f.DynamicPageTitleReference to this in order to allow method chaining
Deprecated API:

Since version 1.54. Please use the areaShrinkRatio property instead. The value of areaShrinkRatio must be set in Heading:Content:Actions format where Heading, Content and Actions are numbers greater than or equal to 0. The greater value a section has the faster it shrinks when the screen size is being reduced.

primaryArea=Begin can be achieved by setting a low number for the Heading area to areaShrinkRatio, for example 1:1.6:1.6.

primaryArea=Middle can be achieved by setting a low number for the Content area to areaShrinkRatio, for example 1.6:1:1.6.

Since:
1.50