class sap.ui.commons.Tab

Control sample: sap.ui.commons.Tab
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/Tab
Application Component: CA-UI5-CTR

Represents a single tab in a TabStrip control.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.commons.Tab(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
closable boolean false

Specifies whether the tab contains a close button.

Visibility: public
horizontalScrolling sap.ui.core.Scrolling None

Specifies the horizontal scrolling.

Visibility: public
selected boolean false

Defines whether the tab is the active one.

Visibility: public
verticalScrolling sap.ui.core.Scrolling None

Specifies the vertical scrolling.

Visibility: public

Borrowed Properties

Name Type Default Value Description
applyContentPadding boolean true

Determines whether the Panel will have padding. Padding is theme-dependent.

Visibility: public
areaDesign sap.ui.commons.enums.AreaDesign Fill

Determines the background color. Note that color settings are theme-dependent.

Visibility: public
borderDesign sap.ui.commons.enums.BorderDesign Box

Determines if the Panel can have a box as border. Note that displaying borders is theme-dependent.

Visibility: public
collapsed boolean false

Determines whether the Panel will be initially collapsed. When it is initially collapsed, the contents are not rendered. A collapsed Panel consumes less space than an expanded one.

Visibility: public
enabled boolean true

Represents the state of the of the Panel (enabled or disabled)

Visibility: public
height sap.ui.core.CSSSize

Determines the height of the Panel in CSS size. Per default, the height for the Panel is automatically adjusted to the content. Dimension allows to explicitly specify the height.

Visibility: public
scrollLeft int 0

Determines the scroll position from left to right. Value "0" means leftmost position.

Visibility: public
scrollTop int 0

Determines the scroll position from top to bottom. Value "0" means topmost position.

Visibility: public
showCollapseIcon boolean true

Determines whether the Panel will have an icon for collapsing/expanding, or not.

Visibility: public
text string

Specifies the text that is rendered in the Panel header. Can be used to create a simple titles that do not require an icon in the header.

Visibility: public
width sap.ui.core.CSSSize 100%

Determines the width of the Panel in CSS size.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
buttons 0..n sap.ui.commons.Button

The buttons that shall be displayed in the Panel header

content 0..n sap.ui.core.Control

Aggregates the controls that are contained in the Panel. It is recommended to use a layout control as single direct child. When the Panel dimensions are set, the child control may have width and height of 100%. When the dimensions are not set, the child defines the size of the Panel.

title 0..1 sap.ui.core.Title

Aggregates the title element of the Panel. For text titles only, you alternatively could use setText() which also creates a title in the background.


Methods Overview

Method Description
sap.ui.commons.Tab.extend

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.

getClosable

Gets current value of property closable.

Specifies whether the tab contains a close button.

Default value is false.

getHorizontalScrolling

Gets current value of property horizontalScrolling.

Specifies the horizontal scrolling.

Default value is None.

sap.ui.commons.Tab.getMetadata

Returns a metadata object for class sap.ui.commons.Tab.

getSelected

Gets current value of property selected.

Defines whether the tab is the active one.

Default value is false.

Since 0.17.0 This property is not used. To identify the selected tab in a TabStrip selectedIndex is used.
getVerticalScrolling

Gets current value of property verticalScrolling.

Specifies the vertical scrolling.

Default value is None.

setClosable

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.

setHorizontalScrolling

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.

setSelected

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.

Since 0.17.0 This property is not used. To identify the selected tab in a TabStrip selectedIndex is used.
setVerticalScrolling

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.

sap.ui.commons.Tab.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getClosable

Gets current value of property closable.

Specifies whether the tab contains a close button.

Default value is false.

getHorizontalScrolling

Gets current value of property horizontalScrolling.

Specifies the horizontal scrolling.

Default value is None.

sap.ui.commons.Tab.getMetadata

Returns a metadata object for class sap.ui.commons.Tab.

getSelected

Gets current value of property selected.

Defines whether the tab is the active one.

Default value is false.

Since 0.17.0 This property is not used. To identify the selected tab in a TabStrip selectedIndex is used.

getVerticalScrolling

Gets current value of property verticalScrolling.

Specifies the vertical scrolling.

Default value is None.

setClosable

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.

Param Type DefaultValue Description
bClosable boolean false

New value for property closable

setHorizontalScrolling

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.

Param Type DefaultValue Description
sHorizontalScrolling sap.ui.core.Scrolling None

New value for property horizontalScrolling

setSelected

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.

Since 0.17.0 This property is not used. To identify the selected tab in a TabStrip selectedIndex is used.
Param Type DefaultValue Description
bSelected boolean false

New value for property selected

setVerticalScrolling

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.

Param Type DefaultValue Description
sVerticalScrolling sap.ui.core.Scrolling None

New value for property verticalScrolling