class sap.f.DynamicPageTitle

Control sample: sap.f.DynamicPageTitle
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/f/DynamicPageTitle
Application Component: CA-UI5-CTR

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.


Constructor

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

new sap.f.DynamicPageTitle(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
areaShrinkRatio sap.f.DynamicPageTitleShrinkRatio 1:1.6:1.6

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.

Since: 1.54.

Visibility: public
backgroundDesign sap.m.BackgroundDesign

Determines the background color of the DynamicPageTitle.

Note: The default value of backgroundDesign property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

Since: 1.58.

Visibility: public
primaryArea sap.f.DynamicPageTitleArea Begin

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.

Since: 1.50.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_actionsToolbar 0..1 sap.m.OverflowToolbar

Internal OverflowToolbar for the DynamicPageTitle actions.

_expandButton 0..1 sap.m.Button

Visual indication for expanding.

Since: 1.52.

_navActionsToolbar 0..1 sap.m.Toolbar

Internal Toolbar for the DynamicPageTitle navigation actions.

Since: 1.52.

_navActionsToolbarSeparator 0..1 sap.m.ToolbarSeparator

Internal ToolbarSeparator to separate the actions and navigationActions.

Since: 1.52.

_snappedTitleOnMobileIcon 0..1 sap.ui.core.Icon

Visual indication for expanding while using SnappedTitleOnMobile.

Since: 1.63.

actions 0..n sap.ui.core.Control

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.

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

breadcrumbs 0..1 sap.m.IBreadcrumbs

The breadcrumbs displayed in the DynamicPageTitle top-left area.

Since: 1.52.

content 0..n sap.ui.core.Control

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

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

Since: 1.50.

expandedContent 0..n sap.ui.core.Control

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

expandedHeading 0..1 sap.ui.core.Control

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.

Since: 1.52.

heading 0..1 sap.ui.core.Control

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.

Notes:

  • 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.
  • If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

navigationActions 0..n sap.m.Button

The DynamicPageTitle navigation actions.

Notes:

  • 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.
  • If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.


Since: 1.52.

snappedContent 0..n sap.ui.core.Control

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

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

snappedHeading 0..1 sap.ui.core.Control

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.

Notes:

  • 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.
  • If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.


Since: 1.52.

snappedTitleOnMobile 0..1 sap.m.Title

The only content that is displayed in the DynamicPageTitle when it is viewed on a phone mobile device and the DynamicPageHeader is in collapsed (snapped) state.

Using this aggregation enables you to provide a simple, single-line title that takes less space on the smaller phone screens when the DynamicPageHeader is in its collapsed (snapped) state.

Note: The content set in this aggregation overrides all the other DynamicPageTitle aggregations and is only visible on phone mobile devices in collapsed (snapped) state of the DynamicPageHeader.

Since: 1.63.


Associations

Name Cardinality Type Description
ariaDescribedBy 0..n sap.ui.core.Control

Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby).

Since: 1.78.


Events Overview

Event Description
stateChange

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.

Since: 1.54.

stateChange

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.

Since: 1.54.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
isExpanded boolean

Whether the title was expanded (true) or collapsed (false).


Methods Overview

Method Description
addAction

Adds some action to the aggregation actions.

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

addContent

Adds some content to the aggregation content.

addExpandedContent

Adds some expandedContent to the aggregation expandedContent.

addNavigationAction

Adds some navigationAction to the aggregation navigationActions.

addSnappedContent

Adds some snappedContent to the aggregation snappedContent.

attachStateChange

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.

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.

destroySnappedTitleOnMobile

Destroys the snappedTitleOnMobile in the aggregation snappedTitleOnMobile.

detachStateChange

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.

sap.f.DynamicPageTitle.extend

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.

fireStateChange

Fires event stateChange to attached listeners.

getActions

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.

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getAreaShrinkRatio

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".

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getBackgroundDesign

Gets current value of property backgroundDesign.

Determines the background color of the DynamicPageTitle.

Note: The default value of backgroundDesign property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

getBreadcrumbs

Gets content of aggregation breadcrumbs.

The breadcrumbs displayed in the DynamicPageTitle top-left area.

getContent

Gets content of aggregation content.

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

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getExpandedContent

Gets content of aggregation expandedContent.

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

getExpandedHeading

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.

getHeading

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.

Notes:

  • 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.
  • If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

sap.f.DynamicPageTitle.getMetadata

Returns a metadata object for class sap.f.DynamicPageTitle.

getNavigationActions

Gets content of aggregation navigationActions.

The DynamicPageTitle navigation actions.

Notes:

  • 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.
  • If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getPrimaryArea

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.

Since 1.54 Please use the <code>areaShrinkRatio</code> property instead. The value of <code>areaShrinkRatio</code> must be set in <code>Heading:Content:Actions</code> 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. <code>primaryArea=Begin</code> can be achieved by setting a low number for the Heading area to <code>areaShrinkRatio</code>, for example <code>1:1.6:1.6</code>. <code>primaryArea=Middle</code> can be achieved by setting a low number for the Content area to <code>areaShrinkRatio</code>, for example <code>1.6:1:1.6</code>.
getSnappedContent

Gets content of aggregation snappedContent.

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

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getSnappedHeading

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.

Notes:

  • 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.
  • If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getSnappedTitleOnMobile

Gets content of aggregation snappedTitleOnMobile.

The only content that is displayed in the DynamicPageTitle when it is viewed on a phone mobile device and the DynamicPageHeader is in collapsed (snapped) state.

Using this aggregation enables you to provide a simple, single-line title that takes less space on the smaller phone screens when the DynamicPageHeader is in its collapsed (snapped) state.

Note: The content set in this aggregation overrides all the other DynamicPageTitle aggregations and is only visible on phone mobile devices in collapsed (snapped) state of the DynamicPageHeader.

indexOfAction

Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

indexOfExpandedContent

Checks for the provided sap.ui.core.Control in the aggregation expandedContent. and returns its index if found or -1 otherwise.

indexOfNavigationAction

Checks for the provided sap.m.Button in the aggregation navigationActions. and returns its index if found or -1 otherwise.

indexOfSnappedContent

Checks for the provided sap.ui.core.Control in the aggregation snappedContent. and returns its index if found or -1 otherwise.

insertAction

Inserts a action into the aggregation actions.

insertContent

Inserts a content into the aggregation content.

insertExpandedContent

Inserts a expandedContent into the aggregation expandedContent.

insertNavigationAction

Inserts a navigationAction into the aggregation navigationActions.

insertSnappedContent

Inserts a snappedContent into the aggregation snappedContent.

removeAction

Removes a action from the aggregation actions.

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllExpandedContent

Removes all the controls from the aggregation expandedContent.

Additionally, it unregisters them from the hosting UIArea.

removeAllNavigationActions

Removes all the controls from the aggregation navigationActions.

Additionally, it unregisters them from the hosting UIArea.

removeAllSnappedContent

Removes all the controls from the aggregation snappedContent.

Additionally, it unregisters them from the hosting UIArea.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

removeContent

Removes a content from the aggregation content.

removeExpandedContent

Removes a expandedContent from the aggregation expandedContent.

removeNavigationAction

Removes a navigationAction from the aggregation navigationActions.

removeSnappedContent

Removes a snappedContent from the aggregation snappedContent.

setAreaShrinkRatio

Sets the value of the areaShrinkRatio property.

setBackgroundDesign

Sets a new value for property backgroundDesign.

Determines the background color of the DynamicPageTitle.

Note: The default value of backgroundDesign property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

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

setBreadcrumbs

Sets the aggregated breadcrumbs.

setExpandedHeading

Sets the aggregated expandedHeading.

setHeading

Sets the aggregated heading.

setPrimaryArea

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.

Since 1.54 Please use the <code>areaShrinkRatio</code> property instead. The value of <code>areaShrinkRatio</code> must be set in <code>Heading:Content:Actions</code> 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. <code>primaryArea=Begin</code> can be achieved by setting a low number for the Heading area to <code>areaShrinkRatio</code>, for example <code>1:1.6:1.6</code>. <code>primaryArea=Middle</code> can be achieved by setting a low number for the Content area to <code>areaShrinkRatio</code>, for example <code>1.6:1:1.6</code>.
setSnappedHeading

Sets the aggregated snappedHeading.

setSnappedTitleOnMobile

Sets the aggregated snappedTitleOnMobile.

addAction

Adds some action to the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.core.Control

The action to add; if empty, nothing is inserted

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to add; if empty, nothing is inserted

addContent

Adds some content to the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to add; if empty, nothing is inserted

addExpandedContent

Adds some expandedContent to the aggregation expandedContent.

Param Type DefaultValue Description
oExpandedContent sap.ui.core.Control

The expandedContent to add; if empty, nothing is inserted

addNavigationAction

Adds some navigationAction to the aggregation navigationActions.

Param Type DefaultValue Description
oNavigationAction sap.m.Button

The navigationAction to add; if empty, nothing is inserted

addSnappedContent

Adds some snappedContent to the aggregation snappedContent.

Param Type DefaultValue Description
oSnappedContent sap.ui.core.Control

The snappedContent to add; if empty, nothing is inserted

attachStateChange

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.f.DynamicPageTitle itself

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.

destroySnappedTitleOnMobile

Destroys the snappedTitleOnMobile in the aggregation snappedTitleOnMobile.

detachStateChange

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.f.DynamicPageTitle.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireStateChange

Fires event stateChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

isExpanded boolean

Whether the title was expanded (true) or collapsed (false).

getActions

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.

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getAreaShrinkRatio

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".

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getBackgroundDesign

Gets current value of property backgroundDesign.

Determines the background color of the DynamicPageTitle.

Note: The default value of backgroundDesign property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

getBreadcrumbs

Gets content of aggregation breadcrumbs.

The breadcrumbs displayed in the DynamicPageTitle top-left area.

getContent

Gets content of aggregation content.

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

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getExpandedContent

Gets content of aggregation expandedContent.

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

getExpandedHeading

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.

getHeading

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.

Notes:

sap.f.DynamicPageTitle.getMetadata

Returns a metadata object for class sap.f.DynamicPageTitle.

getNavigationActions

Gets content of aggregation navigationActions.

The DynamicPageTitle navigation actions.

Notes:

getPrimaryArea

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.

Since 1.54 Please use the <code>areaShrinkRatio</code> property instead. The value of <code>areaShrinkRatio</code> must be set in <code>Heading:Content:Actions</code> 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. <code>primaryArea=Begin</code> can be achieved by setting a low number for the Heading area to <code>areaShrinkRatio</code>, for example <code>1:1.6:1.6</code>. <code>primaryArea=Middle</code> can be achieved by setting a low number for the Content area to <code>areaShrinkRatio</code>, for example <code>1.6:1:1.6</code>.

getSnappedContent

Gets content of aggregation snappedContent.

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

Note: If the snappedTitleOnMobile aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the DynamicPageHeader is in its collapsed (snapped) state.

getSnappedHeading

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.

Notes:

getSnappedTitleOnMobile

Gets content of aggregation snappedTitleOnMobile.

The only content that is displayed in the DynamicPageTitle when it is viewed on a phone mobile device and the DynamicPageHeader is in collapsed (snapped) state.

Using this aggregation enables you to provide a simple, single-line title that takes less space on the smaller phone screens when the DynamicPageHeader is in its collapsed (snapped) state.

Note: The content set in this aggregation overrides all the other DynamicPageTitle aggregations and is only visible on phone mobile devices in collapsed (snapped) state of the DynamicPageHeader.

indexOfAction

Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oAction sap.ui.core.Control

The action whose index is looked for

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content whose index is looked for

indexOfExpandedContent

Checks for the provided sap.ui.core.Control in the aggregation expandedContent. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oExpandedContent sap.ui.core.Control

The expandedContent whose index is looked for

indexOfNavigationAction

Checks for the provided sap.m.Button in the aggregation navigationActions. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oNavigationAction sap.m.Button

The navigationAction whose index is looked for

indexOfSnappedContent

Checks for the provided sap.ui.core.Control in the aggregation snappedContent. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oSnappedContent sap.ui.core.Control

The snappedContent whose index is looked for

insertAction

Inserts a action into the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.core.Control

The action to insert; if empty, nothing is inserted

iIndex int

The 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

insertContent

Inserts a content into the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to insert; if empty, nothing is inserted

iIndex int

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

insertExpandedContent

Inserts a expandedContent into the aggregation expandedContent.

Param Type DefaultValue Description
oExpandedContent sap.ui.core.Control

The expandedContent to insert; if empty, nothing is inserted

iIndex int

The 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

insertNavigationAction

Inserts a navigationAction into the aggregation navigationActions.

Param Type DefaultValue Description
oNavigationAction sap.m.Button

The navigationAction to insert; if empty, nothing is inserted

iIndex int

The 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

insertSnappedContent

Inserts a snappedContent into the aggregation snappedContent.

Param Type DefaultValue Description
oSnappedContent sap.ui.core.Control

The snappedContent to insert; if empty, nothing is inserted

iIndex int

The 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

removeAction

Removes a action from the aggregation actions.

Param Type DefaultValue Description
vAction int string sap.ui.core.Control

The action to remove or its index or id

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllExpandedContent

Removes all the controls from the aggregation expandedContent.

Additionally, it unregisters them from the hosting UIArea.

removeAllNavigationActions

Removes all the controls from the aggregation navigationActions.

Additionally, it unregisters them from the hosting UIArea.

removeAllSnappedContent

Removes all the controls from the aggregation snappedContent.

Additionally, it unregisters them from the hosting UIArea.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy int sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to be removed or its index or ID

removeContent

Removes a content from the aggregation content.

Param Type DefaultValue Description
vContent int string sap.ui.core.Control

The content to remove or its index or id

removeExpandedContent

Removes a expandedContent from the aggregation expandedContent.

Param Type DefaultValue Description
vExpandedContent int string sap.ui.core.Control

The expandedContent to remove or its index or id

removeNavigationAction

Removes a navigationAction from the aggregation navigationActions.

Param Type DefaultValue Description
vNavigationAction int string sap.m.Button

The navigationAction to remove or its index or id

removeSnappedContent

Removes a snappedContent from the aggregation snappedContent.

Param Type DefaultValue Description
vSnappedContent int string sap.ui.core.Control

The snappedContent to remove or its index or id

setAreaShrinkRatio

Sets the value of the areaShrinkRatio property.

Param Type DefaultValue Description
sAreaShrinkRatio sap.f.DynamicPageTitleShrinkRatio

new value of the areaShrinkRatio

setBackgroundDesign

Sets a new value for property backgroundDesign.

Determines the background color of the DynamicPageTitle.

Note: The default value of backgroundDesign property is null. If the property is not set, the color of the background is @sapUiObjectHeaderBackground, which depends on the specific theme.

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

Param Type DefaultValue Description
sBackgroundDesign sap.m.BackgroundDesign

New value for property backgroundDesign

setBreadcrumbs

Sets the aggregated breadcrumbs.

Param Type DefaultValue Description
oBreadcrumbs sap.m.IBreadcrumbs

The breadcrumbs to set

setExpandedHeading

Sets the aggregated expandedHeading.

Param Type DefaultValue Description
oExpandedHeading sap.ui.core.Control

The expandedHeading to set

setHeading

Sets the aggregated heading.

Param Type DefaultValue Description
oHeading sap.ui.core.Control

The heading to set

setPrimaryArea

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.

Since 1.54 Please use the <code>areaShrinkRatio</code> property instead. The value of <code>areaShrinkRatio</code> must be set in <code>Heading:Content:Actions</code> 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. <code>primaryArea=Begin</code> can be achieved by setting a low number for the Heading area to <code>areaShrinkRatio</code>, for example <code>1:1.6:1.6</code>. <code>primaryArea=Middle</code> can be achieved by setting a low number for the Content area to <code>areaShrinkRatio</code>, for example <code>1.6:1:1.6</code>.
Param Type DefaultValue Description
sPrimaryArea sap.f.DynamicPageTitleArea Begin

New value for property primaryArea

setSnappedHeading

Sets the aggregated snappedHeading.

Param Type DefaultValue Description
oSnappedHeading sap.ui.core.Control

The snappedHeading to set

setSnappedTitleOnMobile

Sets the aggregated snappedTitleOnMobile.

Param Type DefaultValue Description
oSnappedTitleOnMobile sap.m.Title

The snappedTitleOnMobile to set