Class sap.me.TabContainerModule: sap/me/TabContainer

extends Control

The TabContainer allow to stack 1 to 4 contents in a view with corresponding icons

Deprecated API:Since version 1.15.0. The functionality of this control is merged with the sap.m.IconTabBar. Please use the sap.m.IconTabBar instead! This control will not be supported anymore.

Constructor Summary
new sap.me.TabContainer(sId?, mSettings?)Constructor for a new TabContainer.
Event Summary
collapse(oControlEvent)Indicates that the tab will collapse
expand(oControlEvent)Indicates that the tab will expand
select(oControlEvent)Indicates that the selected tab has changed
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.me.TabContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.me.TabContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.me.TabContainer.getMetadata()Returns a metadata object for class sap.me.TabContainer.
attachCollapse(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the collapse event of this sap.me.TabContainer.
attachExpand(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the expand event of this sap.me.TabContainer.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.me.TabContainer.
destroyContentAttachments()Destroys the contentAttachments in the aggregation contentAttachments.
destroyContentInfo()Destroys the contentInfo in the aggregation contentInfo.
destroyContentNotes()Destroys the contentNotes in the aggregation contentNotes.
destroyContentPeople()Destroys the contentPeople in the aggregation contentPeople.
detachCollapse(fnFunction, oListener)Detaches event handler fnFunction from the collapse event of this sap.me.TabContainer.
detachExpand(fnFunction, oListener)Detaches event handler fnFunction from the expand event of this sap.me.TabContainer.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.me.TabContainer.
fireCollapse(mArguments?)Fires event collapse to attached listeners.
fireExpand(mArguments?)Fires event expand to attached listeners.
fireSelect(mArguments?)Fires event select to attached listeners.
getBadgeAttachments()Gets current value of property badgeAttachments.
getBadgeInfo()Gets current value of property badgeInfo.
getBadgeNotes()Gets current value of property badgeNotes.
getBadgePeople()Gets current value of property badgePeople.
getContentAttachments()Gets content of aggregation contentAttachments.
getContentInfo()Gets content of aggregation contentInfo.
getContentNotes()Gets content of aggregation contentNotes.
getContentPeople()Gets content of aggregation contentPeople.
getExpandable()Gets current value of property expandable.
getExpanded()Gets current value of property expanded.
getSelectedTab()Gets current value of property selectedTab.
getVisible()Gets current value of property visible.
setBadgeAttachments(iBadgeAttachments)Sets a new value for property badgeAttachments.
setBadgeInfo(iBadgeInfo)Sets a new value for property badgeInfo.
setBadgeNotes(iBadgeNotes)Sets a new value for property badgeNotes.
setBadgePeople(iBadgePeople)Sets a new value for property badgePeople.
setContentAttachments(oContentAttachments)Sets the aggregated contentAttachments.
setContentInfo(oContentInfo)Sets the aggregated contentInfo.
setContentNotes(oContentNotes)Sets the aggregated contentNotes.
setContentPeople(oContentPeople)Sets the aggregated contentPeople.
setExpandable(bExpandable)Sets a new value for property expandable.
setExpanded(bExpanded)Sets a new value for property expanded.
setSelectedTab(iSelectedTab)Sets a new value for property selectedTab.
setVisible(bVisible)Sets a new value for property visible.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, 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, 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.me.TabContainer(sId?, mSettings?)
Constructor for a new TabContainer.

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.ui.core.Control 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
Deprecated:
Since version 1.15.0. The functionality of this control is merged with the sap.m.IconTabBar. Please use the sap.m.IconTabBar instead! This control will not be supported anymore.
Event Detail
collapse(oControlEvent)
Indicates that the tab will collapse
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
expand(oControlEvent)
Indicates that the tab will expand
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
select(oControlEvent)
Indicates that the selected tab has changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.me.TabContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.me.TabContainer 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.

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.me.TabContainer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.me.TabContainer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachCollapse(oData?, fnFunction, oListener?): sap.me.TabContainer
Attaches event handler fnFunction to the collapse event of this sap.me.TabContainer.

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.me.TabContainer itself.

Indicates that the tab will collapse

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.me.TabContainer itself
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
attachExpand(oData?, fnFunction, oListener?): sap.me.TabContainer
Attaches event handler fnFunction to the expand event of this sap.me.TabContainer.

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.me.TabContainer itself.

Indicates that the tab will expand

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.me.TabContainer itself
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.me.TabContainer
Attaches event handler fnFunction to the select event of this sap.me.TabContainer.

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.me.TabContainer itself.

Indicates that the selected tab has 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.me.TabContainer itself
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
destroyContentAttachments(): sap.me.TabContainer
Destroys the contentAttachments in the aggregation contentAttachments.
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
destroyContentInfo(): sap.me.TabContainer
Destroys the contentInfo in the aggregation contentInfo.
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
destroyContentNotes(): sap.me.TabContainer
Destroys the contentNotes in the aggregation contentNotes.
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
destroyContentPeople(): sap.me.TabContainer
Destroys the contentPeople in the aggregation contentPeople.
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
detachCollapse(fnFunction, oListener): sap.me.TabContainer
Detaches event handler fnFunction from the collapse event of this sap.me.TabContainer.

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.me.TabContainer} Reference to this in order to allow method chaining
detachExpand(fnFunction, oListener): sap.me.TabContainer
Detaches event handler fnFunction from the expand event of this sap.me.TabContainer.

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.me.TabContainer} Reference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.me.TabContainer
Detaches event handler fnFunction from the select event of this sap.me.TabContainer.

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.me.TabContainer} Reference to this in order to allow method chaining
fireCollapse(mArguments?): sap.me.TabContainer
Fires event collapse to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
fireExpand(mArguments?): sap.me.TabContainer
Fires event expand to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
fireSelect(mArguments?): boolean
Fires event select to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
getBadgeAttachments(): int
Gets current value of property badgeAttachments.

The number to display in the badge for the attachments tab

Returns:
{int} Value of property badgeAttachments
getBadgeInfo(): int
Gets current value of property badgeInfo.

The number to display in the badge for the info tab

Returns:
{int} Value of property badgeInfo
getBadgeNotes(): int
Gets current value of property badgeNotes.

The number to display in the badge for the notes tab

Returns:
{int} Value of property badgeNotes
getBadgePeople(): int
Gets current value of property badgePeople.

The number to display in the badge for the people tab

Returns:
{int} Value of property badgePeople
getContentAttachments(): sap.ui.core.Control
Gets content of aggregation contentAttachments.

The attachments tab

Returns:
{sap.ui.core.Control}
getContentInfo(): sap.ui.core.Control
Gets content of aggregation contentInfo.

The info tab

Returns:
{sap.ui.core.Control}
getContentNotes(): sap.ui.core.Control
Gets content of aggregation contentNotes.

The notes tab

Returns:
{sap.ui.core.Control}
getContentPeople(): sap.ui.core.Control
Gets content of aggregation contentPeople.

The people tab

Returns:
{sap.ui.core.Control}
getExpandable(): boolean
Gets current value of property expandable.

Indicates if the tab can be collapsed and expanded

Default value is true.

Returns:
{boolean} Value of property expandable
getExpanded(): boolean
Gets current value of property expanded.

Indicates if the actual tab is expanded or not

Default value is true.

Returns:
{boolean} Value of property expanded
getSelectedTab(): int
Gets current value of property selectedTab.

Return the index of the selected tab

Returns:
{int} Value of property selectedTab
getVisible(): boolean
Gets current value of property visible.

setter for visible property

Default value is true.

Returns:
{boolean} Value of property visible
setBadgeAttachments(iBadgeAttachments): sap.me.TabContainer
Sets a new value for property badgeAttachments.

The number to display in the badge for the attachments tab

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

Parameters:
{int}iBadgeAttachments New value for property badgeAttachments
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setBadgeInfo(iBadgeInfo): sap.me.TabContainer
Sets a new value for property badgeInfo.

The number to display in the badge for the info tab

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

Parameters:
{int}iBadgeInfo New value for property badgeInfo
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setBadgeNotes(iBadgeNotes): sap.me.TabContainer
Sets a new value for property badgeNotes.

The number to display in the badge for the notes tab

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

Parameters:
{int}iBadgeNotes New value for property badgeNotes
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setBadgePeople(iBadgePeople): sap.me.TabContainer
Sets a new value for property badgePeople.

The number to display in the badge for the people tab

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

Parameters:
{int}iBadgePeople New value for property badgePeople
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setContentAttachments(oContentAttachments): sap.me.TabContainer
Sets the aggregated contentAttachments.
Parameters:
{sap.ui.core.Control}oContentAttachments The contentAttachments to set
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setContentInfo(oContentInfo): sap.me.TabContainer
Sets the aggregated contentInfo.
Parameters:
{sap.ui.core.Control}oContentInfo The contentInfo to set
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setContentNotes(oContentNotes): sap.me.TabContainer
Sets the aggregated contentNotes.
Parameters:
{sap.ui.core.Control}oContentNotes The contentNotes to set
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setContentPeople(oContentPeople): sap.me.TabContainer
Sets the aggregated contentPeople.
Parameters:
{sap.ui.core.Control}oContentPeople The contentPeople to set
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setExpandable(bExpandable): sap.me.TabContainer
Sets a new value for property expandable.

Indicates if the tab can be collapsed and expanded

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

Default value is true.

Parameters:
{boolean}bExpandable New value for property expandable
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setExpanded(bExpanded): sap.me.TabContainer
Sets a new value for property expanded.

Indicates if the actual tab is expanded or not

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

Default value is true.

Parameters:
{boolean}bExpanded New value for property expanded
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setSelectedTab(iSelectedTab): sap.me.TabContainer
Sets a new value for property selectedTab.

Return the index of the selected tab

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

Parameters:
{int}iSelectedTab New value for property selectedTab
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining
setVisible(bVisible): sap.me.TabContainer
Sets a new value for property visible.

setter for visible property

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

Default value is true.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.me.TabContainer} Reference to this in order to allow method chaining