Provides enhanced functionality by internally aggregating sap.f.DynamicPage and contains controls with semantic-specific meaning.
Content specified in the sap.f.semantic.SemanticPage
aggregations is automatically positioned in dedicated sections of the title or the footer of the page, depending on the control's semantics.
The actions in the SemanticPage
title are grouped to text actions or icon actions. When an aggregation is set, the actions appear in the following predefined order (from left to right):
titleMainAction
titleCustomTextActions
editAction
, deleteAction
, copyAction
and addAction
titleCustomIconActions
favoriteAction
and flagAction
sendEmailAction
discussInJamAction
shareInJamAction
sendMessageAction
printAction
customShareActions
fullScreenAction
, exitFullScreenAction
, and closeAction
The actions in the SemanticPage
footer are positioned either on its left or right area and have the following predefined order:
messagesIndicator
draftIndicator
footerMainAction
positiveAction
and negativeAction
footerCustomActions
Using the SemanticPage
facilitates the implementation of the SAP Fiori 2.0 design guidelines.
The responsive behavior of the SemanticPage
depends on the behavior of the content that is displayed. To adjust the SemanticPage
content padding, the sapUiContentPadding
, sapUiNoContentPadding
, and sapUiResponsiveContentPadding
CSS classes can be used.
Documentation links:
Constructor for a new SemanticPage
.
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.semantic.SemanticPage(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 |
Name | Type | Default Value | Description |
---|---|---|---|
fitContent | boolean | false | Optimizes Note: It is recommended to use this property when displaying content of adaptive controls that stretch to fill the available space. Such controls may be sap.ui.table.Table and sap.ui.table.AnalyticalTable depending on their settings. |
headerExpanded | boolean | true | Determines whether the header is expanded. The header can be also expanded/collapsed by user interaction, which requires the property to be internally mutated by the control to reflect the changed state. Note: Please be aware, that initially collapsed header state is not supported, so |
headerPinnable | boolean | true | Determines whether the header is pinnable. Visibility: public |
preserveHeaderStateOnScroll | boolean | false | Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded. Note: Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the title and the header are with height larger than a given threshold. Visibility: public |
showFooter | boolean | false | Determines whether the footer is visible. Visibility: public |
titleAreaShrinkRatio | sap.f.DynamicPageTitleShrinkRatio | 1:1.6:1.6 | Assigns shrinking ratio to the The value must be set in For example, if 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
|
titlePrimaryArea | sap.f.DynamicPageTitleArea | Begin | Determines which of the title areas (Begin, Middle) is primary. Note: The primary area is shrinking at a lower rate, remaining visible as long as it can. |
toggleHeaderOnTitleClick | boolean | true | Determines whether the user can switch between the expanded/collapsed states of the header by clicking on the title. If set to |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
_dynamicPage | 0..1 | sap.f.DynamicPage |
The aggregation holds |
addAction | 0..1 | sap.f.semantic.AddAction |
A semantic-specific button which is placed in the Note: If the |
closeAction | 0..1 | sap.f.semantic.CloseAction |
A semantic-specific button which is placed in the Note: If the |
content (default) | 0..1 | sap.ui.core.Control |
The Note: The SAP Fiori Design guidelines require that the Example:
Please keep in mind that the alignment is not possible when the controls are placed in a sap.ui.layout.Grid or in other layout controls that use |
copyAction | 0..1 | sap.f.semantic.CopyAction |
A semantic-specific button which is placed in the Note: If the |
customShareActions | 0..n | sap.m.Button |
The The text and icon of the button inside the Note: If the |
deleteAction | 0..1 | sap.f.semantic.DeleteAction |
A semantic-specific button which is placed in the Note: If the |
discussInJamAction | 0..1 | sap.f.semantic.DiscussInJamAction |
A semantic-specific button which is placed in the Note: If the |
draftIndicator | 0..1 | sap.m.DraftIndicator |
A semantic-specific button which is placed in the |
editAction | 0..1 | sap.f.semantic.EditAction |
A semantic-specific button which is placed in the Note: If the |
exitFullScreenAction | 0..1 | sap.f.semantic.ExitFullScreenAction |
A semantic-specific button which is placed in the Note: If the |
favoriteAction | 0..1 | sap.f.semantic.FavoriteAction |
A semantic-specific button which is placed in the Note: If the |
flagAction | 0..1 | sap.f.semantic.FlagAction |
A semantic-specific button which is placed in the Note: If the |
footerCustomActions | 0..n | sap.m.Button |
The Note: Buttons that are part of this aggregation will always have their |
footerMainAction | 0..1 | sap.f.semantic.FooterMainAction |
A semantic-specific button which is placed in the |
fullScreenAction | 0..1 | sap.f.semantic.FullScreenAction |
A semantic-specific button which is placed in the Note: If the |
headerContent | 0..n | sap.ui.core.Control |
The header content. |
landmarkInfo | 0..1 | sap.f.DynamicPageAccessibleLandmarkInfo |
Accessible landmark settings to be applied to the containers of the If not set, no landmarks will be written. |
messagesIndicator | 0..1 | sap.f.semantic.MessagesIndicator |
A semantic-specific button which is placed in the |
negativeAction | 0..1 | sap.f.semantic.NegativeAction |
A semantic-specific button which is placed in the |
positiveAction | 0..1 | sap.f.semantic.PositiveAction |
A semantic-specific button which is placed in the |
printAction | 0..1 | sap.f.semantic.PrintAction |
A semantic-specific button which is placed in the Note: If the |
saveAsTileAction | 0..1 | sap.m.Button |
A button which is placed in the Note: If the |
sendEmailAction | 0..1 | sap.f.semantic.SendEmailAction |
A semantic-specific button which is placed in the Note: If the |
sendMessageAction | 0..1 | sap.f.semantic.SendMessageAction |
A semantic-specific button which is placed in the Note: If the |
shareInJamAction | 0..1 | sap.f.semantic.ShareInJamAction |
A semantic-specific button which is placed in the Note: If the |
titleBreadcrumbs | 0..1 | sap.m.IBreadcrumbs |
The A typical usage is the Notes:
Since: 1.52. |
titleContent | 0..n | sap.ui.core.Control |
The content, displayed in the title. Notes:
Since: 1.52. |
titleCustomIconActions | 0..n | sap.m.OverflowToolbarButton |
The Note: If the |
titleCustomTextActions | 0..n | sap.m.Button |
The Notes:
|
titleExpandedContent | 0..n | sap.ui.core.Control |
The content,displayed in the title, when the header is in expanded state. Note: The controls will be placed in the title`s left area, under the |
titleExpandedHeading | 0..1 | sap.ui.core.Control |
The Note: In order for |
titleHeading | 0..1 | sap.ui.core.Control |
The A typical usage is the Notes:
|
titleMainAction | 0..1 | sap.f.semantic.TitleMainAction |
A semantic-specific button which is placed in the Note: If the |
titleSnappedContent | 0..n | sap.ui.core.Control |
The content, displayed in the title, when the header is in collapsed state. Notes:
|
titleSnappedHeading | 0..1 | sap.ui.core.Control |
The Notes:
Since: 1.58. |
titleSnappedOnMobile | 0..1 | sap.m.Title |
The only content that is displayed in the Using this aggregation enables you to provide a simple, single-line title that takes less space on the smaller phone screens when the Note: The content set in this aggregation overrides all the other |
Method | Description |
---|---|
addCustomShareAction |
Adds some customShareAction to the aggregation customShareActions. |
addFooterCustomAction |
Adds some footerCustomAction to the aggregation footerCustomActions. |
addHeaderContent |
Adds some headerContent to the aggregation headerContent. |
addTitleContent |
Adds some titleContent to the aggregation titleContent. |
addTitleCustomIconAction |
Adds some titleCustomIconAction to the aggregation titleCustomIconActions. |
addTitleCustomTextAction |
Adds some titleCustomTextAction to the aggregation titleCustomTextActions. |
addTitleExpandedContent |
Adds some titleExpandedContent to the aggregation titleExpandedContent. |
addTitleSnappedContent |
Adds some titleSnappedContent to the aggregation titleSnappedContent. |
destroyAddAction |
Destroys the addAction in the aggregation addAction. |
destroyCloseAction |
Destroys the closeAction in the aggregation closeAction. |
destroyContent |
Destroys the content in the aggregation content. |
destroyCopyAction |
Destroys the copyAction in the aggregation copyAction. |
destroyCustomShareActions |
Destroys all the customShareActions in the aggregation customShareActions. |
destroyDeleteAction |
Destroys the deleteAction in the aggregation deleteAction. |
destroyDiscussInJamAction |
Destroys the discussInJamAction in the aggregation discussInJamAction. |
destroyDraftIndicator |
Destroys the draftIndicator in the aggregation draftIndicator. |
destroyEditAction |
Destroys the editAction in the aggregation editAction. |
destroyExitFullScreenAction |
Destroys the exitFullScreenAction in the aggregation exitFullScreenAction. |
destroyFavoriteAction |
Destroys the favoriteAction in the aggregation favoriteAction. |
destroyFlagAction |
Destroys the flagAction in the aggregation flagAction. |
destroyFooterCustomActions |
Destroys all the footerCustomActions in the aggregation footerCustomActions. |
destroyFooterMainAction |
Destroys the footerMainAction in the aggregation footerMainAction. |
destroyFullScreenAction |
Destroys the fullScreenAction in the aggregation fullScreenAction. |
destroyHeaderContent |
Destroys all the headerContent in the aggregation headerContent. |
destroyLandmarkInfo |
Destroys the landmarkInfo in the aggregation landmarkInfo. |
destroyMessagesIndicator |
Destroys the messagesIndicator in the aggregation messagesIndicator. |
destroyNegativeAction |
Destroys the negativeAction in the aggregation negativeAction. |
destroyPositiveAction |
Destroys the positiveAction in the aggregation positiveAction. |
destroyPrintAction |
Destroys the printAction in the aggregation printAction. |
destroySaveAsTileAction |
Destroys the saveAsTileAction in the aggregation saveAsTileAction. |
destroySendEmailAction |
Destroys the sendEmailAction in the aggregation sendEmailAction. |
destroySendMessageAction |
Destroys the sendMessageAction in the aggregation sendMessageAction. |
destroyShareInJamAction |
Destroys the shareInJamAction in the aggregation shareInJamAction. |
destroyTitleBreadcrumbs |
Destroys the titleBreadcrumbs in the aggregation titleBreadcrumbs. |
destroyTitleContent |
Destroys all the titleContent in the aggregation titleContent. |
destroyTitleCustomIconActions |
Destroys all the titleCustomIconActions in the aggregation titleCustomIconActions. |
destroyTitleCustomTextActions |
Destroys all the titleCustomTextActions in the aggregation titleCustomTextActions. |
destroyTitleExpandedContent |
Destroys all the titleExpandedContent in the aggregation titleExpandedContent. |
destroyTitleExpandedHeading |
Destroys the titleExpandedHeading in the aggregation titleExpandedHeading. |
destroyTitleHeading |
Destroys the titleHeading in the aggregation titleHeading. |
destroyTitleMainAction |
Destroys the titleMainAction in the aggregation titleMainAction. |
destroyTitleSnappedContent |
Destroys all the titleSnappedContent in the aggregation titleSnappedContent. |
destroyTitleSnappedHeading |
Destroys the titleSnappedHeading in the aggregation titleSnappedHeading. |
destroyTitleSnappedOnMobile |
Destroys the titleSnappedOnMobile in the aggregation titleSnappedOnMobile. |
sap.f.semantic.SemanticPage.extend |
Creates a new subclass of class sap.f.semantic.SemanticPage with name
|
getAddAction |
Gets content of aggregation addAction. A semantic-specific button which is placed in the Note: If the |
getCloseAction |
Gets content of aggregation closeAction. A semantic-specific button which is placed in the Note: If the |
getContent |
Gets content of aggregation content. The Note: The SAP Fiori Design guidelines require that the Example:
Please keep in mind that the alignment is not possible when the controls are placed in a sap.ui.layout.Grid or in other layout controls that use |
getCopyAction |
Gets content of aggregation copyAction. A semantic-specific button which is placed in the Note: If the |
getCustomShareActions |
Gets content of aggregation customShareActions. The The text and icon of the button inside the Note: If the |
getDeleteAction |
Gets content of aggregation deleteAction. A semantic-specific button which is placed in the Note: If the |
getDiscussInJamAction |
Gets content of aggregation discussInJamAction. A semantic-specific button which is placed in the Note: If the |
getDraftIndicator |
Gets content of aggregation draftIndicator. A semantic-specific button which is placed in the |
getEditAction |
Gets content of aggregation editAction. A semantic-specific button which is placed in the Note: If the |
getExitFullScreenAction |
Gets content of aggregation exitFullScreenAction. A semantic-specific button which is placed in the Note: If the |
getFavoriteAction |
Gets content of aggregation favoriteAction. A semantic-specific button which is placed in the Note: If the |
getFitContent |
Gets current value of property fitContent. Optimizes Note: It is recommended to use this property when displaying content of adaptive controls that stretch to fill the available space. Such controls may be sap.ui.table.Table and sap.ui.table.AnalyticalTable depending on their settings. Default value is |
getFlagAction |
Gets content of aggregation flagAction. A semantic-specific button which is placed in the Note: If the |
getFooterCustomActions |
Gets content of aggregation footerCustomActions. The Note: Buttons that are part of this aggregation will always have their |
getFooterMainAction |
Gets content of aggregation footerMainAction. A semantic-specific button which is placed in the |
getFullScreenAction |
Gets content of aggregation fullScreenAction. A semantic-specific button which is placed in the Note: If the |
getHeaderContent |
Gets content of aggregation headerContent. The header content. |
getHeaderExpanded |
Gets current value of property headerExpanded. Determines whether the header is expanded. The header can be also expanded/collapsed by user interaction, which requires the property to be internally mutated by the control to reflect the changed state. Note: Please be aware, that initially collapsed header state is not supported, so Default value is |
getHeaderPinnable |
Gets current value of property headerPinnable. Determines whether the header is pinnable. Default value is |
getLandmarkInfo |
Gets content of aggregation landmarkInfo. Accessible landmark settings to be applied to the containers of the If not set, no landmarks will be written. |
getMessagesIndicator |
Gets content of aggregation messagesIndicator. A semantic-specific button which is placed in the |
sap.f.semantic.SemanticPage.getMetadata |
Returns a metadata object for class sap.f.semantic.SemanticPage. |
getNegativeAction |
Gets content of aggregation negativeAction. A semantic-specific button which is placed in the |
getPositiveAction |
Gets content of aggregation positiveAction. A semantic-specific button which is placed in the |
getPreserveHeaderStateOnScroll |
Gets current value of property preserveHeaderStateOnScroll. Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded. Note: Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the title and the header are with height larger than a given threshold. Default value is |
getPrintAction |
Gets content of aggregation printAction. A semantic-specific button which is placed in the Note: If the |
getSaveAsTileAction |
Gets content of aggregation saveAsTileAction. A button which is placed in the Note: If the |
getSendEmailAction |
Gets content of aggregation sendEmailAction. A semantic-specific button which is placed in the Note: If the |
getSendMessageAction |
Gets content of aggregation sendMessageAction. A semantic-specific button which is placed in the Note: If the |
getShareInJamAction |
Gets content of aggregation shareInJamAction. A semantic-specific button which is placed in the Note: If the |
getShowFooter |
Gets current value of property showFooter. Determines whether the footer is visible. Default value is |
getTitleAreaShrinkRatio |
Gets current value of property titleAreaShrinkRatio. Assigns shrinking ratio to the The value must be set in For example, if 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
Default value is |
getTitleBreadcrumbs |
Gets content of aggregation titleBreadcrumbs. The A typical usage is the Notes:
|
getTitleContent |
Gets content of aggregation titleContent. The content, displayed in the title. Notes:
|
getTitleCustomIconActions |
Gets content of aggregation titleCustomIconActions. The Note: If the |
getTitleCustomTextActions |
Gets content of aggregation titleCustomTextActions. The Notes:
|
getTitleExpandedContent |
Gets content of aggregation titleExpandedContent. The content,displayed in the title, when the header is in expanded state. Note: The controls will be placed in the title`s left area, under the |
getTitleExpandedHeading |
Gets content of aggregation titleExpandedHeading. The Note: In order for |
getTitleHeading |
Gets content of aggregation titleHeading. The A typical usage is the Notes:
|
getTitleMainAction |
Gets content of aggregation titleMainAction. A semantic-specific button which is placed in the Note: If the |
getTitlePrimaryArea |
Gets current value of property titlePrimaryArea. Determines which of the title areas (Begin, Middle) is primary. Note: The primary area is shrinking at a lower rate, remaining visible as long as it can. Default value is
Since 1.58 Please use the <code>titleAreaShrinkRatio</code> property instead. The value of <code>titleAreaShrinkRatio</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>titlePrimaryArea=Begin</code> can be achieved by setting a low number for the Heading area to <code>titleAreaShrinkRatio</code>, for example <code>1:1.6:1.6</code>.
<code>titlePrimaryArea=Middle</code> can be achieved by setting a low number for the Content area to <code>titleAreaShrinkRatio</code>, for example <code>1.6:1:1.6</code>.
|
getTitleSnappedContent |
Gets content of aggregation titleSnappedContent. The content, displayed in the title, when the header is in collapsed state. Notes:
|
getTitleSnappedHeading |
Gets content of aggregation titleSnappedHeading. The Notes:
|
getTitleSnappedOnMobile |
Gets content of aggregation titleSnappedOnMobile. The only content that is displayed in the Using this aggregation enables you to provide a simple, single-line title that takes less space on the smaller phone screens when the Note: The content set in this aggregation overrides all the other |
getToggleHeaderOnTitleClick |
Gets current value of property toggleHeaderOnTitleClick. Determines whether the user can switch between the expanded/collapsed states of the header by clicking on the title. If set to Default value is |
indexOfCustomShareAction |
Checks for the provided |
indexOfFooterCustomAction |
Checks for the provided |
indexOfHeaderContent |
Checks for the provided |
indexOfTitleContent |
Checks for the provided |
indexOfTitleCustomIconAction |
Checks for the provided |
indexOfTitleCustomTextAction |
Checks for the provided |
indexOfTitleExpandedContent |
Checks for the provided |
indexOfTitleSnappedContent |
Checks for the provided |
insertCustomShareAction |
Inserts a customShareAction into the aggregation customShareActions. |
insertFooterCustomAction |
Inserts a footerCustomAction into the aggregation footerCustomActions. |
insertHeaderContent |
Inserts a headerContent into the aggregation headerContent. |
insertTitleContent |
Inserts a titleContent into the aggregation titleContent. |
insertTitleCustomIconAction |
Inserts a titleCustomIconAction into the aggregation titleCustomIconActions. |
insertTitleCustomTextAction |
Inserts a titleCustomTextAction into the aggregation titleCustomTextActions. |
insertTitleExpandedContent |
Inserts a titleExpandedContent into the aggregation titleExpandedContent. |
insertTitleSnappedContent |
Inserts a titleSnappedContent into the aggregation titleSnappedContent. |
removeAllCustomShareActions |
Removes all the controls from the aggregation customShareActions. Additionally, it unregisters them from the hosting UIArea. |
removeAllFooterCustomActions |
Removes all the controls from the aggregation footerCustomActions. Additionally, it unregisters them from the hosting UIArea. |
removeAllHeaderContent |
Removes all the controls from the aggregation headerContent. Additionally, it unregisters them from the hosting UIArea. |
removeAllTitleContent |
Removes all the controls from the aggregation titleContent. Additionally, it unregisters them from the hosting UIArea. |
removeAllTitleCustomIconActions |
Removes all the controls from the aggregation titleCustomIconActions. Additionally, it unregisters them from the hosting UIArea. |
removeAllTitleCustomTextActions |
Removes all the controls from the aggregation titleCustomTextActions. Additionally, it unregisters them from the hosting UIArea. |
removeAllTitleExpandedContent |
Removes all the controls from the aggregation titleExpandedContent. Additionally, it unregisters them from the hosting UIArea. |
removeAllTitleSnappedContent |
Removes all the controls from the aggregation titleSnappedContent. Additionally, it unregisters them from the hosting UIArea. |
removeCustomShareAction |
Removes a customShareAction from the aggregation customShareActions. |
removeFooterCustomAction |
Removes a footerCustomAction from the aggregation footerCustomActions. |
removeHeaderContent |
Removes a headerContent from the aggregation headerContent. |
removeTitleContent |
Removes a titleContent from the aggregation titleContent. |
removeTitleCustomIconAction |
Removes a titleCustomIconAction from the aggregation titleCustomIconActions. |
removeTitleCustomTextAction |
Removes a titleCustomTextAction from the aggregation titleCustomTextActions. |
removeTitleExpandedContent |
Removes a titleExpandedContent from the aggregation titleExpandedContent. |
removeTitleSnappedContent |
Removes a titleSnappedContent from the aggregation titleSnappedContent. |
setAddAction |
Sets the aggregated addAction. |
setCloseAction |
Sets the aggregated closeAction. |
setContent |
Sets the aggregated content. |
setCopyAction |
Sets the aggregated copyAction. |
setDeleteAction |
Sets the aggregated deleteAction. |
setDiscussInJamAction |
Sets the aggregated discussInJamAction. |
setDraftIndicator |
Sets the aggregated draftIndicator. |
setEditAction |
Sets the aggregated editAction. |
setExitFullScreenAction |
Sets the aggregated exitFullScreenAction. |
setFavoriteAction |
Sets the aggregated favoriteAction. |
setFitContent |
Sets a new value for property fitContent. Optimizes Note: It is recommended to use this property when displaying content of adaptive controls that stretch to fill the available space. Such controls may be sap.ui.table.Table and sap.ui.table.AnalyticalTable depending on their settings. When called with a value of Default value is |
setFlagAction |
Sets the aggregated flagAction. |
setFooterMainAction |
Sets the aggregated footerMainAction. |
setFullScreenAction |
Sets the aggregated fullScreenAction. |
setHeaderExpanded |
Sets a new value for property headerExpanded. Determines whether the header is expanded. The header can be also expanded/collapsed by user interaction, which requires the property to be internally mutated by the control to reflect the changed state. Note: Please be aware, that initially collapsed header state is not supported, so When called with a value of Default value is |
setHeaderPinnable |
Sets a new value for property headerPinnable. Determines whether the header is pinnable. When called with a value of Default value is |
setLandmarkInfo |
Sets the aggregated landmarkInfo. |
setMessagesIndicator |
Sets the aggregated messagesIndicator. |
setNegativeAction |
Sets the aggregated negativeAction. |
setPositiveAction |
Sets the aggregated positiveAction. |
setPreserveHeaderStateOnScroll |
Sets a new value for property preserveHeaderStateOnScroll. Preserves the current header state when scrolling. For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded. Note: Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the title and the header are with height larger than a given threshold. When called with a value of Default value is |
setPrintAction |
Sets the aggregated printAction. |
setSaveAsTileAction |
Sets the aggregated saveAsTileAction. |
setSendEmailAction |
Sets the aggregated sendEmailAction. |
setSendMessageAction |
Sets the aggregated sendMessageAction. |
setShareInJamAction |
Sets the aggregated shareInJamAction. |
setShowFooter |
Sets a new value for property showFooter. Determines whether the footer is visible. When called with a value of Default value is |
setTitleAreaShrinkRatio |
Sets a new value for property titleAreaShrinkRatio. Assigns shrinking ratio to the The value must be set in For example, if 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
When called with a value of Default value is |
setTitleBreadcrumbs |
Sets the aggregated titleBreadcrumbs. |
setTitleExpandedHeading |
Sets the aggregated titleExpandedHeading. |
setTitleHeading |
Sets the aggregated titleHeading. |
setTitleMainAction |
Sets the aggregated titleMainAction. |
setTitlePrimaryArea |
Sets a new value for property titlePrimaryArea. Determines which of the title areas (Begin, Middle) is primary. Note: The primary area is shrinking at a lower rate, remaining visible as long as it can. When called with a value of Default value is
Since 1.58 Please use the <code>titleAreaShrinkRatio</code> property instead. The value of <code>titleAreaShrinkRatio</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>titlePrimaryArea=Begin</code> can be achieved by setting a low number for the Heading area to <code>titleAreaShrinkRatio</code>, for example <code>1:1.6:1.6</code>.
<code>titlePrimaryArea=Middle</code> can be achieved by setting a low number for the Content area to <code>titleAreaShrinkRatio</code>, for example <code>1.6:1:1.6</code>.
|
setTitleSnappedHeading |
Sets the aggregated titleSnappedHeading. |
setTitleSnappedOnMobile |
Sets the aggregated titleSnappedOnMobile. |
setToggleHeaderOnTitleClick |
Sets a new value for property toggleHeaderOnTitleClick. Determines whether the user can switch between the expanded/collapsed states of the header by clicking on the title. If set to When called with a value of Default value is |
Adds some headerContent to the aggregation headerContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContent | sap.ui.core.Control |
The headerContent to add; if empty, nothing is inserted |
Adds some titleContent to the aggregation titleContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleContent | sap.ui.core.Control |
The titleContent to add; if empty, nothing is inserted |
Adds some titleCustomIconAction to the aggregation titleCustomIconActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleCustomIconAction | sap.m.OverflowToolbarButton |
The titleCustomIconAction to add; if empty, nothing is inserted |
Adds some titleCustomTextAction to the aggregation titleCustomTextActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleCustomTextAction | sap.m.Button |
The titleCustomTextAction to add; if empty, nothing is inserted |
Adds some titleExpandedContent to the aggregation titleExpandedContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleExpandedContent | sap.ui.core.Control |
The titleExpandedContent to add; if empty, nothing is inserted |
Adds some titleSnappedContent to the aggregation titleSnappedContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleSnappedContent | sap.ui.core.Control |
The titleSnappedContent to add; if empty, nothing is inserted |
Destroys the exitFullScreenAction in the aggregation exitFullScreenAction.
Destroys all the titleCustomIconActions in the aggregation titleCustomIconActions.
Destroys all the titleCustomTextActions in the aggregation titleCustomTextActions.
Destroys all the titleExpandedContent in the aggregation titleExpandedContent.
Destroys the titleExpandedHeading in the aggregation titleExpandedHeading.
Destroys all the titleSnappedContent in the aggregation titleSnappedContent.
Destroys the titleSnappedOnMobile in the aggregation titleSnappedOnMobile.
Creates a new subclass of class sap.f.semantic.SemanticPage 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 |
Gets content of aggregation addAction.
A semantic-specific button which is placed in the TextActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation closeAction.
A semantic-specific button which is placed in the IconActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation content.
The SemanticPage
content.
Note: The SAP Fiori Design guidelines require that the SemanticPage
's header content and the SemanticPage
's content are aligned vertically. When using sap.ui.layout.form.Form, sap.m.Panel, sap.m.Table and sap.m.List in the content area of SemanticPage
, if the content is not already aligned, you need to adjust their left text offset to achieve the vertical alignment. To do this, apply the sapFSemanticPageAlignContent
CSS class to them and set their width
property to auto
(if not set by default).
Example:
<Panel class=“sapFSemanticPageAlignContent” width=“auto”></Panel>
Please keep in mind that the alignment is not possible when the controls are placed in a sap.ui.layout.Grid or in other layout controls that use overflow:hidden
CSS property.
Gets content of aggregation copyAction.
A semantic-specific button which is placed in the TextActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation deleteAction.
A semantic-specific button which is placed in the TextActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation discussInJamAction.
A semantic-specific button which is placed in the ShareMenu
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation draftIndicator.
A semantic-specific button which is placed in the FooterLeft
area of the SemanticPage
footer as a second action.
Gets content of aggregation editAction.
A semantic-specific button which is placed in the TextActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation exitFullScreenAction.
A semantic-specific button which is placed in the IconActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation favoriteAction.
A semantic-specific button which is placed in the IconActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets current value of property fitContent.
Optimizes SemanticPage
responsiveness on small screens and behavior when expanding/collapsing the SemanticPageHeader
.
Note: It is recommended to use this property when displaying content of adaptive controls that stretch to fill the available space. Such controls may be sap.ui.table.Table and sap.ui.table.AnalyticalTable depending on their settings.
Default value is false
.
Gets content of aggregation flagAction.
A semantic-specific button which is placed in the IconActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation fullScreenAction.
A semantic-specific button which is placed in the IconActions
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets current value of property headerExpanded.
Determines whether the header is expanded.
The header can be also expanded/collapsed by user interaction, which requires the property to be internally mutated by the control to reflect the changed state.
Note: Please be aware, that initially collapsed header state is not supported, so headerExpanded
should not be set to false
when initializing the control.
Default value is true
.
Gets current value of property headerPinnable.
Determines whether the header is pinnable.
Default value is true
.
Gets content of aggregation landmarkInfo.
Accessible landmark settings to be applied to the containers of the sap.f.SemanticPage
control.
If not set, no landmarks will be written.
Gets content of aggregation messagesIndicator.
A semantic-specific button which is placed in the FooterLeft
area of the SemanticPage
footer as a first action.
Returns a metadata object for class sap.f.semantic.SemanticPage.
Gets content of aggregation negativeAction.
A semantic-specific button which is placed in the FooterRight
area of the SemanticPage
footer with default text value set to Reject
.
Gets content of aggregation positiveAction.
A semantic-specific button which is placed in the FooterRight
area of the SemanticPage
footer with default text value set to Accept
.
Gets current value of property preserveHeaderStateOnScroll.
Preserves the current header state when scrolling.
For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.
Note: Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the title and the header are with height larger than a given threshold.
Default value is false
.
Gets content of aggregation printAction.
A semantic-specific button which is placed in the ShareMenu
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation saveAsTileAction.
A button which is placed in the ShareMenu
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation sendEmailAction.
A semantic-specific button which is placed in the ShareMenu
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation sendMessageAction.
A semantic-specific button which is placed in the ShareMenu
area of the SemanticPage
title.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets current value of property titleAreaShrinkRatio.
Assigns shrinking ratio to the SemanticPage
title 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 be 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
.
titlePrimaryArea
property has no effect.
Default value is "1:1.6:1.6"
.
Gets content of aggregation titleBreadcrumbs.
The SemanticPage
breadcrumbs.
A typical usage is the sap.m.Breadcrumbs
control or any other UI5 control, that implements the sap.m.IBreadcrumbs
interface.
Notes:
titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.Gets content of aggregation titleContent.
The content, displayed in the title.
Notes:
titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.Gets content of aggregation titleCustomIconActions.
The titleCustomIconActions
are placed in the IconActions
area of the SemanticPage
title, right before the semantic icon action.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets content of aggregation titleCustomTextActions.
The titleCustomTextActions
are placed in the TextActions
area of the SemanticPage
title, right before the semantic text action.
Notes:
titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.type
property set to Transparent
by design.Gets content of aggregation titleExpandedContent.
The content,displayed in the title, when the header is in expanded state.
Note: The controls will be placed in the title`s left area, under the titleHeading
aggregation.
Gets content of aggregation titleExpandedHeading.
The titleExpandedHeading
is positioned in the SemanticPage
title 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 titleExpandedHeading
to be taken into account, titleHeading
has to be empty. Combine titleExpandedHeading
with titleSnappedHeading
to switch content when the header switches state.
Gets content of aggregation titleHeading.
The SemanticPage
heading.
A typical usage is the sap.m.Title
or any other UI5 control, that serves as a heading for an object.
Notes:
titleHeading
is mutually exclusive with titleSnappedHeading
and titleExpandedHeading
. If titleHeading
is provided, both titleSnappedHeading
and titleExpandedHeading
are ignored. titleHeading
is useful when the content of titleSnappedHeading
and titleExpandedHeading
needs to be the same as it replaces them both.titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.Gets content of aggregation titleMainAction.
A semantic-specific button which is placed in the SemanticPage
title as first action.
Note: If the titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.
Gets current value of property titlePrimaryArea.
Determines which of the title areas (Begin, Middle) is primary.
Note: The primary area is shrinking at a lower rate, remaining visible as long as it can.
Default value is Begin
.
Gets content of aggregation titleSnappedContent.
The content, displayed in the title, when the header is in collapsed state.
Notes:
titleHeading
aggregation.titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.Gets content of aggregation titleSnappedHeading.
The titleSnappedHeading
is positioned in the SemanticPage
title 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:
titleSnappedHeading
to be taken into account, titleHeading
has to be empty. Combine titleSnappedHeading
with titleExpandedHeading
to switch content when the header switches state.titleSnappedOnMobile
aggregation is set, its content overrides this aggregation when the control is viewed on a phone mobile device and the SemanticPage
header is in its collapsed (snapped) state.Gets content of aggregation titleSnappedOnMobile.
The only content that is displayed in the SemanticPage
title when it is viewed on a phone mobile device and the SemanticPage
header 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 SemanticPage
header is in its collapsed (snapped) state.
Note: The content set in this aggregation overrides all the other SemanticPage
aggregations displayed in the title and is only visible on phone mobile devices in collapsed (snapped) state of the SemanticPage
header.
Gets current value of property toggleHeaderOnTitleClick.
Determines whether the user can switch between the expanded/collapsed states of the header by clicking on the title.
If set to false
, the title is not clickable and the application must provide other means for expanding/collapsing the header, if necessary.
Default value is true
.
Checks for the provided sap.ui.core.Control
in the aggregation headerContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContent | sap.ui.core.Control |
The headerContent whose index is looked for |
Checks for the provided sap.ui.core.Control
in the aggregation titleContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleContent | sap.ui.core.Control |
The titleContent whose index is looked for |
Checks for the provided sap.m.OverflowToolbarButton
in the aggregation titleCustomIconActions. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleCustomIconAction | sap.m.OverflowToolbarButton |
The titleCustomIconAction whose index is looked for |
Checks for the provided sap.m.Button
in the aggregation titleCustomTextActions. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleCustomTextAction | sap.m.Button |
The titleCustomTextAction whose index is looked for |
Checks for the provided sap.ui.core.Control
in the aggregation titleExpandedContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleExpandedContent | sap.ui.core.Control |
The titleExpandedContent whose index is looked for |
Checks for the provided sap.ui.core.Control
in the aggregation titleSnappedContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleSnappedContent | sap.ui.core.Control |
The titleSnappedContent whose index is looked for |
Inserts a headerContent into the aggregation headerContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderContent | sap.ui.core.Control |
The headerContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a titleContent into the aggregation titleContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleContent | sap.ui.core.Control |
The titleContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a titleCustomIconAction into the aggregation titleCustomIconActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleCustomIconAction | sap.m.OverflowToolbarButton |
The titleCustomIconAction to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a titleCustomTextAction into the aggregation titleCustomTextActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleCustomTextAction | sap.m.Button |
The titleCustomTextAction to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a titleExpandedContent into the aggregation titleExpandedContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleExpandedContent | sap.ui.core.Control |
The titleExpandedContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a titleSnappedContent into the aggregation titleSnappedContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleSnappedContent | sap.ui.core.Control |
The titleSnappedContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation headerContent.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation titleContent.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation titleCustomIconActions.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation titleCustomTextActions.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation titleExpandedContent.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation titleSnappedContent.
Additionally, it unregisters them from the hosting UIArea.
Removes a headerContent from the aggregation headerContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vHeaderContent | int string sap.ui.core.Control |
The headerContent to remove or its index or id |
Removes a titleContent from the aggregation titleContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vTitleContent | int string sap.ui.core.Control |
The titleContent to remove or its index or id |
Removes a titleCustomIconAction from the aggregation titleCustomIconActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vTitleCustomIconAction | int string sap.m.OverflowToolbarButton |
The titleCustomIconAction to remove or its index or id |
Removes a titleCustomTextAction from the aggregation titleCustomTextActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vTitleCustomTextAction | int string sap.m.Button |
The titleCustomTextAction to remove or its index or id |
Removes a titleExpandedContent from the aggregation titleExpandedContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vTitleExpandedContent | int string sap.ui.core.Control |
The titleExpandedContent to remove or its index or id |
Removes a titleSnappedContent from the aggregation titleSnappedContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vTitleSnappedContent | int string sap.ui.core.Control |
The titleSnappedContent to remove or its index or id |
Sets the aggregated addAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAddAction | sap.f.semantic.AddAction |
The addAction to set |
Sets the aggregated closeAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCloseAction | sap.f.semantic.CloseAction |
The closeAction to set |
Sets the aggregated content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to set |
Sets the aggregated copyAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCopyAction | sap.f.semantic.CopyAction |
The copyAction to set |
Sets the aggregated deleteAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDeleteAction | sap.f.semantic.DeleteAction |
The deleteAction to set |
Sets the aggregated discussInJamAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDiscussInJamAction | sap.f.semantic.DiscussInJamAction |
The discussInJamAction to set |
Sets the aggregated draftIndicator.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDraftIndicator | sap.m.DraftIndicator |
The draftIndicator to set |
Sets the aggregated editAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oEditAction | sap.f.semantic.EditAction |
The editAction to set |
Sets the aggregated exitFullScreenAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oExitFullScreenAction | sap.f.semantic.ExitFullScreenAction |
The exitFullScreenAction to set |
Sets the aggregated favoriteAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFavoriteAction | sap.f.semantic.FavoriteAction |
The favoriteAction to set |
Sets a new value for property fitContent.
Optimizes SemanticPage
responsiveness on small screens and behavior when expanding/collapsing the SemanticPageHeader
.
Note: It is recommended to use this property when displaying content of adaptive controls that stretch to fill the available space. Such controls may be sap.ui.table.Table and sap.ui.table.AnalyticalTable depending on their settings.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFitContent | boolean | false |
New value for property |
Sets the aggregated flagAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFlagAction | sap.f.semantic.FlagAction |
The flagAction to set |
Sets the aggregated fullScreenAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFullScreenAction | sap.f.semantic.FullScreenAction |
The fullScreenAction to set |
Sets a new value for property headerExpanded.
Determines whether the header is expanded.
The header can be also expanded/collapsed by user interaction, which requires the property to be internally mutated by the control to reflect the changed state.
Note: Please be aware, that initially collapsed header state is not supported, so headerExpanded
should not be set to false
when initializing the control.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bHeaderExpanded | boolean | true |
New value for property |
Sets a new value for property headerPinnable.
Determines whether the header is pinnable.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bHeaderPinnable | boolean | true |
New value for property |
Sets the aggregated landmarkInfo.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLandmarkInfo | sap.f.DynamicPageAccessibleLandmarkInfo |
The landmarkInfo to set |
Sets the aggregated messagesIndicator.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMessagesIndicator | sap.f.semantic.MessagesIndicator |
The messagesIndicator to set |
Sets the aggregated negativeAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oNegativeAction | sap.f.semantic.NegativeAction |
The negativeAction to set |
Sets the aggregated positiveAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPositiveAction | sap.f.semantic.PositiveAction |
The positiveAction to set |
Sets a new value for property preserveHeaderStateOnScroll.
Preserves the current header state when scrolling.
For example, if the user expands the header by clicking on the title and then scrolls down the page, the header will remain expanded.
Note: Based on internal rules, the value of the property is not always taken into account - for example, when the control is rendered on tablet or mobile and the title and the header are with height larger than a given threshold.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bPreserveHeaderStateOnScroll | boolean | false |
New value for property |
Sets the aggregated printAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPrintAction | sap.f.semantic.PrintAction |
The printAction to set |
Sets the aggregated saveAsTileAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSaveAsTileAction | sap.m.Button |
The saveAsTileAction to set |
Sets the aggregated sendEmailAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSendEmailAction | sap.f.semantic.SendEmailAction |
The sendEmailAction to set |
Sets the aggregated sendMessageAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSendMessageAction | sap.f.semantic.SendMessageAction |
The sendMessageAction to set |
Sets a new value for property titleAreaShrinkRatio.
Assigns shrinking ratio to the SemanticPage
title 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 be 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
.
titlePrimaryArea
property has no effect.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "1:1.6:1.6"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleAreaShrinkRatio | sap.f.DynamicPageTitleShrinkRatio | "1:1.6:1.6" |
New value for property |
Sets the aggregated titleBreadcrumbs.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleBreadcrumbs | sap.m.IBreadcrumbs |
The titleBreadcrumbs to set |
Sets the aggregated titleExpandedHeading.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleExpandedHeading | sap.ui.core.Control |
The titleExpandedHeading to set |
Sets the aggregated titleHeading.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleHeading | sap.ui.core.Control |
The titleHeading to set |
Sets the aggregated titleMainAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleMainAction | sap.f.semantic.TitleMainAction |
The titleMainAction to set |
Sets a new value for property titlePrimaryArea.
Determines which of the title areas (Begin, Middle) is primary.
Note: The primary area is shrinking at a lower rate, remaining visible as long 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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitlePrimaryArea | sap.f.DynamicPageTitleArea | Begin |
New value for property |
Sets the aggregated titleSnappedHeading.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleSnappedHeading | sap.ui.core.Control |
The titleSnappedHeading to set |
Sets the aggregated titleSnappedOnMobile.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTitleSnappedOnMobile | sap.m.Title |
The titleSnappedOnMobile to set |
Sets a new value for property toggleHeaderOnTitleClick.
Determines whether the user can switch between the expanded/collapsed states of the header by clicking on the title.
If set to false
, the title is not clickable and the application must provide other means for expanding/collapsing the header, if necessary.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bToggleHeaderOnTitleClick | boolean | true |
New value for property |