Class sap.ui.commons.TabModule: sap/ui/commons/Tab

extends Panel

Represents a single tab in a TabStrip control.

Deprecated API:Since version 1.38. Instead, use the sap.m.TabContainer control.

Constructor Summary
new sap.ui.commons.Tab(sId?, mSettings?)Constructor for a new Tab.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.Tab.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.Tab with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.Tab.getMetadata()Returns a metadata object for class sap.ui.commons.Tab.
getClosable()Gets current value of property closable.
getHorizontalScrolling()Gets current value of property horizontalScrolling.
getVerticalScrolling()Gets current value of property verticalScrolling.
setClosable(bClosable)Sets a new value for property closable.
setHorizontalScrolling(sHorizontalScrolling)Sets a new value for property horizontalScrolling.
setVerticalScrolling(sVerticalScrolling)Sets a new value for property verticalScrolling.
getSelected()Gets current value of property selected.
setSelected(bSelected)Sets a new value for property selected.
Constructor Detail
new sap.ui.commons.Tab(sId?, mSettings?)
Constructor for a new Tab.

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.commons.Panel 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.38. Instead, use the sap.m.TabContainer control.
Method Detail
sap.ui.commons.Tab.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.Tab 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.commons.Panel.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.ui.commons.Tab.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.Tab.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getClosable(): boolean
Gets current value of property closable.

Specifies whether the tab contains a close button.

Default value is false.

Returns:
{boolean} Value of property closable
getHorizontalScrolling(): sap.ui.core.Scrolling
Gets current value of property horizontalScrolling.

Specifies the horizontal scrolling.

Default value is None.

Returns:
{sap.ui.core.Scrolling} Value of property horizontalScrolling
getVerticalScrolling(): sap.ui.core.Scrolling
Gets current value of property verticalScrolling.

Specifies the vertical scrolling.

Default value is None.

Returns:
{sap.ui.core.Scrolling} Value of property verticalScrolling
setClosable(bClosable): sap.ui.commons.Tab
Sets a new value for property closable.

Specifies whether the tab contains a close button.

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

Default value is false.

Parameters:
{boolean}bClosable New value for property closable
Returns:
{sap.ui.commons.Tab} Reference to this in order to allow method chaining
setHorizontalScrolling(sHorizontalScrolling): sap.ui.commons.Tab
Sets a new value for property horizontalScrolling.

Specifies the horizontal scrolling.

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

Default value is None.

Parameters:
{sap.ui.core.Scrolling}sHorizontalScrolling New value for property horizontalScrolling
Returns:
{sap.ui.commons.Tab} Reference to this in order to allow method chaining
setVerticalScrolling(sVerticalScrolling): sap.ui.commons.Tab
Sets a new value for property verticalScrolling.

Specifies the vertical scrolling.

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

Default value is None.

Parameters:
{sap.ui.core.Scrolling}sVerticalScrolling New value for property verticalScrolling
Returns:
{sap.ui.commons.Tab} Reference to this in order to allow method chaining
getSelected(): boolean
Gets current value of property selected.

Defines whether the tab is the active one.

Default value is false.

Deprecated:
AS of 0.17.0. This property is not used. To identify the selected tab in a TabStrip selectedIndex is used.
Returns:
{boolean} Value of property selected
setSelected(bSelected): sap.ui.commons.Tab
Sets a new value for property selected.

Defines whether the tab is the active one.

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

Default value is false.

Parameters:
{boolean}bSelected New value for property selected
Deprecated:
AS of 0.17.0. This property is not used. To identify the selected tab in a TabStrip selectedIndex is used.
Returns:
{sap.ui.commons.Tab} Reference to this in order to allow method chaining