Class sap.m.semantic.ShareMenuPageModule: sap/m/semantic/ShareMenuPage

extends SemanticPage
known direct subclasses: DetailPage, FullscreenPage

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


Since: 1.30.0.
Constructor Summary
new sap.m.semantic.ShareMenuPage(sId?, mSettings?)Constructor for a new ShareMenuPage

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.semantic.ShareMenuPage.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.semantic.ShareMenuPage with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.semantic.ShareMenuPage.getMetadata()Returns a metadata object for class sap.m.semantic.ShareMenuPage.
addCustomShareMenuContent(oCustomShareMenuContent)Adds some customShareMenuContent to the aggregation customShareMenuContent.
destroyCustomShareMenuContent()Destroys all the customShareMenuContent in the aggregation customShareMenuContent.
getCustomShareMenuContent()Gets content of aggregation customShareMenuContent.
indexOfCustomShareMenuContent(oCustomShareMenuContent)Checks for the provided sap.m.Button in the aggregation customShareMenuContent.
insertCustomShareMenuContent(oCustomShareMenuContent, iIndex)Inserts a customShareMenuContent into the aggregation customShareMenuContent.
removeAllCustomShareMenuContent()Removes all the controls from the aggregation customShareMenuContent.
removeCustomShareMenuContent(vCustomShareMenuContent)Removes a customShareMenuContent from the aggregation customShareMenuContent.
Constructor Detail
new sap.m.semantic.ShareMenuPage(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.m.semantic.SemanticPage can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.m.semantic.ShareMenuPage.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.semantic.ShareMenuPage.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.semantic.ShareMenuPage.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addCustomShareMenuContent(oCustomShareMenuContent): sap.m.semantic.ShareMenuPage
Adds some customShareMenuContent to the aggregation customShareMenuContent.
Parameters:
{sap.m.Button}oCustomShareMenuContent the customShareMenuContent to add; if empty, nothing is inserted
Returns:
{sap.m.semantic.ShareMenuPage} Reference to this in order to allow method chaining
destroyCustomShareMenuContent(): sap.m.semantic.ShareMenuPage
Destroys all the customShareMenuContent in the aggregation customShareMenuContent.
Returns:
{sap.m.semantic.ShareMenuPage} Reference to this in order to allow method chaining
getCustomShareMenuContent(): sap.m.Button[]
Gets content of aggregation customShareMenuContent.

Custom share menu buttons

Returns:
{sap.m.Button[]}
indexOfCustomShareMenuContent(oCustomShareMenuContent): int
Checks for the provided sap.m.Button in the aggregation customShareMenuContent. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.Button}oCustomShareMenuContent The customShareMenuContent whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertCustomShareMenuContent(oCustomShareMenuContent, iIndex): sap.m.semantic.ShareMenuPage
Inserts a customShareMenuContent into the aggregation customShareMenuContent.
Parameters:
{sap.m.Button}oCustomShareMenuContent the customShareMenuContent to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.m.semantic.ShareMenuPage} Reference to this in order to allow method chaining
removeAllCustomShareMenuContent(): sap.m.Button[]
Removes all the controls from the aggregation customShareMenuContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.m.Button[]} An array of the removed elements (might be empty)
removeCustomShareMenuContent(vCustomShareMenuContent): sap.m.Button
Removes a customShareMenuContent from the aggregation customShareMenuContent.
Parameters:
{int|string|sap.m.Button}vCustomShareMenuContent The customShareMenuContentto remove or its index or id
Returns:
{sap.m.Button} The removed customShareMenuContent or null