Class sap.m.TabContainerItemModule: sap/m/TabContainerItem

extends Element

An item to be used in a TabContainer.


Since: 1.34.
Constructor Summary
new sap.m.TabContainerItem(sId?, mSettings?)Constructor for a new TabContainerItem.
Event Summary
itemPropertyChanged(oControlEvent)Sends information that some of the properties have changed.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.TabContainerItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.TabContainerItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.TabContainerItem.getMetadata()Returns a metadata object for class sap.m.TabContainerItem.
addContent(oContent)Adds some content to the aggregation content.
attachItemPropertyChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the itemPropertyChanged event of this sap.m.TabContainerItem.
destroyContent()Destroys all the content in the aggregation content.
detachItemPropertyChanged(fnFunction, oListener)Detaches event handler fnFunction from the itemPropertyChanged event of this sap.m.TabContainerItem.
fireItemPropertyChanged(mArguments?)Fires event itemPropertyChanged to attached listeners.
getContent()Gets content of aggregation content.
getKey()Gets current value of property key.
getModified()Gets current value of property modified.
getName()Gets current value of property name.
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.
setKey(sKey)Sets a new value for property key.
setModified(bModified)Sets a new value for property modified.
setName(sName)Sets a new value for property name.
setProperty(sName, vValue, bSuppressInvalidation)Overwrites the method in order to suppress invalidation for some properties.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, 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, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.TabContainerItem(sId?, mSettings?)
Constructor for a new TabContainerItem.

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
  • Aggregations
  • Events
    • itemPropertyChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element 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
Event Detail
itemPropertyChanged(oControlEvent)
Sends information that some of the properties have changed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.m.TabContainerItem}oControlEvent.getParameters.itemChanged The item changed.
{string}oControlEvent.getParameters.propertyKey The key of the property.
{mixed}oControlEvent.getParameters.propertyValue The value of the property.
Method Detail
sap.m.TabContainerItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.TabContainerItem 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.Element.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.TabContainerItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.TabContainerItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.m.TabContainerItem
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.TabContainerItem} Reference to this in order to allow method chaining
attachItemPropertyChanged(oData?, fnFunction, oListener?): sap.m.TabContainerItem
Attaches event handler fnFunction to the itemPropertyChanged event of this sap.m.TabContainerItem.

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.m.TabContainerItem itself.

Sends information that some of the properties have changed.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.TabContainerItem itself
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
destroyContent(): sap.m.TabContainerItem
Destroys all the content in the aggregation content.
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
detachItemPropertyChanged(fnFunction, oListener): sap.m.TabContainerItem
Detaches event handler fnFunction from the itemPropertyChanged event of this sap.m.TabContainerItem.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
fireItemPropertyChanged(mArguments?): sap.m.TabContainerItem
Fires event itemPropertyChanged to attached listeners.

Expects the following event parameters:

  • itemChanged of type sap.m.TabContainerItemThe item changed.
  • propertyKey of type stringThe key of the property.
  • propertyValue of type mixedThe value of the property.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

The content displayed for this item.

Returns:
{sap.ui.core.Control[]}
getKey(): string
Gets current value of property key.

Determines the name of the item. Can be used as input for subsequent actions.

Returns:
{string} Value of property key
getModified(): boolean
Gets current value of property modified.

Shows if a control is edited (default is false). Items that are marked as modified have a * symbol to indicate that they haven't been saved.

Default value is false.

Returns:
{boolean} Value of property modified
getName(): string
Gets current value of property name.

Determines the text to be displayed for the item.

Default value is .

Returns:
{string} Value of property name
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.TabContainerItem
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.TabContainerItem} 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
setKey(sKey): sap.m.TabContainerItem
Sets a new value for property key.

Determines the name of the item. Can be used as input for subsequent actions.

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

Parameters:
{string}sKey New value for property key
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
setModified(bModified): sap.m.TabContainerItem
Sets a new value for property modified.

Shows if a control is edited (default is false). Items that are marked as modified have a * symbol to indicate that they haven't been saved.

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

Default value is false.

Parameters:
{boolean}bModified New value for property modified
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
setName(sName): sap.m.TabContainerItem
Sets a new value for property name.

Determines the text to be displayed for the item.

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

Default value is .

Parameters:
{string}sName New value for property name
Returns:
{sap.m.TabContainerItem} Reference to this in order to allow method chaining
setProperty(sName, vValue, bSuppressInvalidation): sap.m.TabContainerItem
Overwrites the method in order to suppress invalidation for some properties.
Parameters:
{string}sName Property name to be set
{boolean|string|object}vValue Property value to be set
{boolean}bSuppressInvalidation Whether invalidation to be suppressed
Returns:
{sap.m.TabContainerItem} This instance for chaining