Class sap.m.ViewSettingsCustomTabModule: sap/m/ViewSettingsCustomTab

extends Item

The ViewSettingsCustomTab control is used for adding custom tabs in the ViewSettingsDialog.


Since: 1.30.
Constructor Summary
new sap.m.ViewSettingsCustomTab(sId?, mSettings?)Constructor for a new ViewSettingsCustomTab.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.ViewSettingsCustomTab.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ViewSettingsCustomTab with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ViewSettingsCustomTab.getMetadata()Returns a metadata object for class sap.m.ViewSettingsCustomTab.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
getIcon()Gets current value of property icon.
getTabButton(oOptions)Gets or creates the sap.m.Button instance for the custom tab.
getTitle()Gets current value of property title.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setIcon(sIcon)Sets a new value for property icon.
setTitle(sTitle)Sets a new value for property title.
Methods borrowed from class sap.ui.core.Item
getEnabled, getKey, getText, getTextDirection, setEnabled, setKey, setText, setTextDirection
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.ViewSettingsCustomTab(sId?, mSettings?)
Constructor for a new ViewSettingsCustomTab.

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:

  • Properties
    • icon : sap.ui.core.URI (default: sap-icon://competitor)
    • title : string (default: )
  • Aggregations

In addition, all settings applicable to the base type sap.ui.core.Item 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.ViewSettingsCustomTab.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.ViewSettingsCustomTab 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.Item.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.ViewSettingsCustomTab.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ViewSettingsCustomTab.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.m.ViewSettingsCustomTab
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.m.ViewSettingsCustomTab} Reference to this in order to allow method chaining
destroyContent(): sap.m.ViewSettingsCustomTab
Destroys all the content in the aggregation content.
Returns:
{sap.m.ViewSettingsCustomTab} Reference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

The content of this Custom tab

Returns:
{sap.ui.core.Control[]}
getIcon(): sap.ui.core.URI
Gets current value of property icon.

Custom tab button icon

Default value is sap-icon://competitor.

Returns:
{sap.ui.core.URI} Value of property icon
getTabButton(oOptions): sap.m.Button
Gets or creates the sap.m.Button instance for the custom tab.
Parameters:
{object}oOptions
Returns:
{sap.m.Button}
getTitle(): string
Gets current value of property title.

Custom tab title

Default value is .

Returns:
{string} Value of property title
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.m.ViewSettingsCustomTab
Inserts a content into the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.m.ViewSettingsCustomTab} Reference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.core.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
setIcon(sIcon): sap.m.ViewSettingsCustomTab
Sets a new value for property icon.

Custom tab button icon

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

Default value is sap-icon://competitor.

Parameters:
{sap.ui.core.URI}sIcon New value for property icon
Returns:
{sap.m.ViewSettingsCustomTab} Reference to this in order to allow method chaining
setTitle(sTitle): sap.m.ViewSettingsCustomTab
Sets a new value for property title.

Custom tab title

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

Default value is .

Parameters:
{string}sTitle New value for property title
Returns:
{sap.m.ViewSettingsCustomTab} Reference to this in order to allow method chaining