class sap.m.semantic.ShareMenuPage

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/semantic/ShareMenuPage
Application Component: CA-UI5-CTR

A ShareMenuPage is a sap.m.semantic.SemanticPage with support for "share" menu in the footer.


Constructor

Constructor for a new ShareMenuPage

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.m.semantic.ShareMenuPage(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

Borrowed Properties

Name Type Default Value Description
backgroundDesign sap.m.PageBackgroundDesign Standard

Determines the backgound color of the page. For more information, see sap.m.Page#backgroundDesign.

Since: 1.52.

Visibility: public
enableScrolling boolean true

See sap.m.Page#enableScrolling

Visibility: public
floatingFooter boolean false

Determines whether the floating footer behavior is enabled. If set to true, the content is visible when it's underneath the footer.

Since: 1.40.1.

Visibility: public
semanticRuleSet sap.m.semantic.SemanticRuleSetType Classic

Declares the type of semantic ruleset that will govern the styling and positioning of semantic content.

Since: 1.44.

Visibility: public
showFooter boolean true

Hides or shows the page footer

Visibility: public
showNavButton boolean false

See sap.m.Page#showNavButton

Visibility: public
showSubHeader boolean true

See sap.m.Page#showSubHeader

Visibility: public
title string

See sap.m.Page#title

Visibility: public
titleLevel sap.ui.core.TitleLevel Auto

See sap.m.Page#titleLevel

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_actionSheet 0..1 sap.m.ActionSheet

Wrapped instance of sap.m.ActionSheet

customShareMenuContent 0..n sap.m.Button

Custom share menu buttons

Borrowed Aggregations

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

See sap.m.Page#content

customFooterContent 0..n sap.m.Button

Custom footer buttons

customHeaderContent 0..n sap.m.Button

Custom header buttons

landmarkInfo 0..1 sap.m.PageAccessibleLandmarkInfo

Accessible landmark settings to be applied to the containers of the sap.m.Page control.

If not set, no landmarks will be written.

subHeader 0..1 sap.m.IBar

See sap.m.Page#subHeader


Methods Overview

Method Description
addCustomShareMenuContent

Adds some customShareMenuContent to the aggregation customShareMenuContent.

destroyCustomShareMenuContent

Destroys all the customShareMenuContent in the aggregation customShareMenuContent.

sap.m.semantic.ShareMenuPage.extend

Creates a new subclass of class sap.m.semantic.ShareMenuPage with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.semantic.SemanticPage.extend.

getCustomShareMenuContent

Gets content of aggregation customShareMenuContent.

Custom share menu buttons

sap.m.semantic.ShareMenuPage.getMetadata

Returns a metadata object for class sap.m.semantic.ShareMenuPage.

indexOfCustomShareMenuContent

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

insertCustomShareMenuContent

Inserts a customShareMenuContent into the aggregation customShareMenuContent.

removeAllCustomShareMenuContent

Removes all the controls from the aggregation customShareMenuContent.

Additionally, it unregisters them from the hosting UIArea.

removeCustomShareMenuContent

Removes a customShareMenuContent from the aggregation customShareMenuContent.

addCustomShareMenuContent

Adds some customShareMenuContent to the aggregation customShareMenuContent.

Param Type DefaultValue Description
oCustomShareMenuContent sap.m.Button

The customShareMenuContent to add; if empty, nothing is inserted

destroyCustomShareMenuContent

Destroys all the customShareMenuContent in the aggregation customShareMenuContent.

sap.m.semantic.ShareMenuPage.extend

Creates a new subclass of class sap.m.semantic.ShareMenuPage with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.semantic.SemanticPage.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

getCustomShareMenuContent

Gets content of aggregation customShareMenuContent.

Custom share menu buttons

sap.m.semantic.ShareMenuPage.getMetadata

Returns a metadata object for class sap.m.semantic.ShareMenuPage.

indexOfCustomShareMenuContent

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

Param Type DefaultValue Description
oCustomShareMenuContent sap.m.Button

The customShareMenuContent whose index is looked for

insertCustomShareMenuContent

Inserts a customShareMenuContent into the aggregation customShareMenuContent.

Param Type DefaultValue Description
oCustomShareMenuContent sap.m.Button

The customShareMenuContent to insert; if empty, nothing is inserted

iIndex int

The 0-based index the customShareMenuContent should be inserted at; for a negative value of iIndex, the customShareMenuContent is inserted at position 0; for a value greater than the current size of the aggregation, the customShareMenuContent is inserted at the last position

removeAllCustomShareMenuContent

Removes all the controls from the aggregation customShareMenuContent.

Additionally, it unregisters them from the hosting UIArea.

removeCustomShareMenuContent

Removes a customShareMenuContent from the aggregation customShareMenuContent.

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

The customShareMenuContent to remove or its index or id