class sap.m.IconTabHeader

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

This control displays a number of IconTabFilters and IconTabSeparators. If the available horizontal space is exceeded, an overflow tab appears.

Usage

Use IconTabHeader if you need it as a standalone header. If you need to manage content use sap.m.IconTabBar instead.


Constructor

Constructor for a new IconTabHeader.

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.m.IconTabHeader(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
ariaTexts object

Specifies optional texts for the screen reader.

The given object can contain the following keys: headerLabel - text to serve as a label for the header, headerDescription - text to serve as a description for the header.

Since: 1.80.

Visibility: public
backgroundDesign sap.m.BackgroundDesign Solid

Specifies the background color of the header.

Depending on the theme, you can change the state of the background color to "Solid", "Translucent", or "Transparent". Note: In SAP Belize Deep (sap_belize_plus) theme this property should be set to "Solid".

Since: 1.44.

Visibility: public
enableTabReordering boolean false

Specifies whether tab reordering is enabled. Relevant only for desktop devices. The sap.m.IconTabSeparator cannot be dragged and dropped Items can be moved around sap.m.IconTabSeparator

Since: 1.46.

Visibility: public
maxNestingLevel int 0

Specifies the allowed level of tabs nesting within one another using drag and drop. Default value is 0 which means nesting via interaction is not allowed. Maximum value is 100. This property allows nesting via user interaction only, and does not restrict adding items to the items aggregation of sap.m.IconTabFilter.

Since: 1.79.

Visibility: public
mode sap.m.IconTabHeaderMode Standard

Specifies the header mode.

Since: 1.40.

Visibility: public
selectedKey string

Key of the selected item.

If the key has no corresponding aggregated item, no changes will apply. If duplicate keys exists the first item matching, the key is used.

Since: 1.15.0.

Visibility: public
showOverflowSelectList boolean false

Specifies if the overflow select list is displayed.

The overflow select list represents a list, where all tab filters are displayed, so the user can select specific tab filter easier.

Visibility: public
showSelection boolean true

Defines whether the current selection is visualized.

Visibility: public
tabDensityMode sap.m.IconTabDensityMode Cozy

Specifies the visual density mode of the tabs.

The values that can be applied are Cozy, Compact and Inherit. Cozy and Compact render the control in one of these modes independent of the global density settings. The Inherit value follows the global density settings which are applied. For compatibility reasons, the default value is Cozy.

Since: 1.56.

Visibility: public
tabsOverflowMode sap.m.TabsOverflowMode End

Specifies the overflow mode of the header.

The default End mode shows as many tabs that can fit on the screen, then shows one overflow at the end containing the remaining items. The StartAndEnd is used to keep the order of tabs intact and offers overflow tabs on both ends of the bar.

Since: 1.90.

Visibility: public
visible boolean true

Specifies whether the control is rendered.

Since: 1.15.0.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_overflow 0..1 sap.m.IconTabFilter

Internal aggregation for managing the overflow tab.

_startOverflow 0..1 sap.m.IconTabFilter

Internal aggregation for managing the start overflow tab.

items 0..n sap.m.IconTab

The items displayed in the IconTabHeader.


Events Overview

Event Description
select

Fires when an item is selected.

select

Fires when an item is selected.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
item sap.m.IconTabFilter

The selected item

Since: 1.15.0.

key string

The key of the selected item

Since: 1.15.0.

previousKey string

The key of the previous selected item

Since: 1.96.


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

attachSelect

Attaches event handler fnFunction to the select event of this sap.m.IconTabHeader.

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.IconTabHeader itself.

Fires when an item is selected.

destroyItems

Destroys all the items in the aggregation items.

detachSelect

Detaches event handler fnFunction from the select event of this sap.m.IconTabHeader.

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

sap.m.IconTabHeader.extend

Creates a new subclass of class sap.m.IconTabHeader 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.

fireSelect

Fires event select to attached listeners.

getAriaTexts

Gets current value of property ariaTexts.

Specifies optional texts for the screen reader.

The given object can contain the following keys: headerLabel - text to serve as a label for the header, headerDescription - text to serve as a description for the header.

getBackgroundDesign

Gets current value of property backgroundDesign.

Specifies the background color of the header.

Depending on the theme, you can change the state of the background color to "Solid", "Translucent", or "Transparent". Note: In SAP Belize Deep (sap_belize_plus) theme this property should be set to "Solid".

Default value is Solid.

getEnableTabReordering

Gets current value of property enableTabReordering.

Specifies whether tab reordering is enabled. Relevant only for desktop devices. The sap.m.IconTabSeparator cannot be dragged and dropped Items can be moved around sap.m.IconTabSeparator

Default value is false.

getItems

Gets content of aggregation items.

The items displayed in the IconTabHeader.

getMaxNestingLevel

Gets current value of property maxNestingLevel.

Specifies the allowed level of tabs nesting within one another using drag and drop. Default value is 0 which means nesting via interaction is not allowed. Maximum value is 100. This property allows nesting via user interaction only, and does not restrict adding items to the items aggregation of sap.m.IconTabFilter.

Default value is 0.

sap.m.IconTabHeader.getMetadata

Returns a metadata object for class sap.m.IconTabHeader.

getMode

Gets current value of property mode.

Specifies the header mode.

Default value is Standard.

getSelectedKey

Gets current value of property selectedKey.

Key of the selected item.

If the key has no corresponding aggregated item, no changes will apply. If duplicate keys exists the first item matching, the key is used.

getShowOverflowSelectList

Gets current value of property showOverflowSelectList.

Specifies if the overflow select list is displayed.

The overflow select list represents a list, where all tab filters are displayed, so the user can select specific tab filter easier.

Default value is false.

getShowSelection

Gets current value of property showSelection.

Defines whether the current selection is visualized.

Default value is true.

Since 1.15.0 Regarding to changes of this control this property is not needed anymore.
getTabDensityMode

Gets current value of property tabDensityMode.

Specifies the visual density mode of the tabs.

The values that can be applied are Cozy, Compact and Inherit. Cozy and Compact render the control in one of these modes independent of the global density settings. The Inherit value follows the global density settings which are applied. For compatibility reasons, the default value is Cozy.

Default value is Cozy.

getTabsOverflowMode

Gets current value of property tabsOverflowMode.

Specifies the overflow mode of the header.

The default End mode shows as many tabs that can fit on the screen, then shows one overflow at the end containing the remaining items. The StartAndEnd is used to keep the order of tabs intact and offers overflow tabs on both ends of the bar.

Default value is End.

getVisible

Gets current value of property visible.

Specifies whether the control is rendered.

Default value is true.

indexOfItem

Checks for the provided sap.m.IconTab in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setAriaTexts

Sets a new value for property ariaTexts.

Specifies optional texts for the screen reader.

The given object can contain the following keys: headerLabel - text to serve as a label for the header, headerDescription - text to serve as a description for the header.

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

setBackgroundDesign

Sets a new value for property backgroundDesign.

Specifies the background color of the header.

Depending on the theme, you can change the state of the background color to "Solid", "Translucent", or "Transparent". Note: In SAP Belize Deep (sap_belize_plus) theme this property should be set to "Solid".

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

Default value is Solid.

setEnableTabReordering

Sets a new value for property enableTabReordering.

Specifies whether tab reordering is enabled. Relevant only for desktop devices. The sap.m.IconTabSeparator cannot be dragged and dropped Items can be moved around sap.m.IconTabSeparator

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

Default value is false.

setMaxNestingLevel

Sets a new value for property maxNestingLevel.

Specifies the allowed level of tabs nesting within one another using drag and drop. Default value is 0 which means nesting via interaction is not allowed. Maximum value is 100. This property allows nesting via user interaction only, and does not restrict adding items to the items aggregation of sap.m.IconTabFilter.

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

Default value is 0.

setMode

Sets a new value for property mode.

Specifies the header mode.

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

Default value is Standard.

setSelectedKey

Sets the selected item based on key.

setShowOverflowSelectList

Sets a new value for property showOverflowSelectList.

Specifies if the overflow select list is displayed.

The overflow select list represents a list, where all tab filters are displayed, so the user can select specific tab filter easier.

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

Default value is false.

setShowSelection

Sets a new value for property showSelection.

Defines whether the current selection is visualized.

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

Default value is true.

Since 1.15.0 Regarding to changes of this control this property is not needed anymore.
setTabDensityMode

Sets a new value for property tabDensityMode.

Specifies the visual density mode of the tabs.

The values that can be applied are Cozy, Compact and Inherit. Cozy and Compact render the control in one of these modes independent of the global density settings. The Inherit value follows the global density settings which are applied. For compatibility reasons, the default value is Cozy.

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

Default value is Cozy.

setTabsOverflowMode

Sets a new value for property tabsOverflowMode.

Specifies the overflow mode of the header.

The default End mode shows as many tabs that can fit on the screen, then shows one overflow at the end containing the remaining items. The StartAndEnd is used to keep the order of tabs intact and offers overflow tabs on both ends of the bar.

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

Default value is End.

setVisible

Sets a new value for property visible.

Specifies whether the control is rendered.

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

Default value is true.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.m.IconTab

The item to add; if empty, nothing is inserted

attachSelect

Attaches event handler fnFunction to the select event of this sap.m.IconTabHeader.

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.IconTabHeader itself.

Fires when an item is selected.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.IconTabHeader itself

destroyItems

Destroys all the items in the aggregation items.

detachSelect

Detaches event handler fnFunction from the select event of this sap.m.IconTabHeader.

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

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.IconTabHeader.extend

Creates a new subclass of class sap.m.IconTabHeader 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.

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

fireSelect

Fires event select to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

item sap.m.IconTabFilter

The selected item

key string

The key of the selected item

previousKey string

The key of the previous selected item

getAriaTexts

Gets current value of property ariaTexts.

Specifies optional texts for the screen reader.

The given object can contain the following keys: headerLabel - text to serve as a label for the header, headerDescription - text to serve as a description for the header.

getBackgroundDesign

Gets current value of property backgroundDesign.

Specifies the background color of the header.

Depending on the theme, you can change the state of the background color to "Solid", "Translucent", or "Transparent". Note: In SAP Belize Deep (sap_belize_plus) theme this property should be set to "Solid".

Default value is Solid.

getEnableTabReordering

Gets current value of property enableTabReordering.

Specifies whether tab reordering is enabled. Relevant only for desktop devices. The sap.m.IconTabSeparator cannot be dragged and dropped Items can be moved around sap.m.IconTabSeparator

Default value is false.

getItems

Gets content of aggregation items.

The items displayed in the IconTabHeader.

getMaxNestingLevel

Gets current value of property maxNestingLevel.

Specifies the allowed level of tabs nesting within one another using drag and drop. Default value is 0 which means nesting via interaction is not allowed. Maximum value is 100. This property allows nesting via user interaction only, and does not restrict adding items to the items aggregation of sap.m.IconTabFilter.

Default value is 0.

sap.m.IconTabHeader.getMetadata

Returns a metadata object for class sap.m.IconTabHeader.

getMode

Gets current value of property mode.

Specifies the header mode.

Default value is Standard.

getSelectedKey

Gets current value of property selectedKey.

Key of the selected item.

If the key has no corresponding aggregated item, no changes will apply. If duplicate keys exists the first item matching, the key is used.

getShowOverflowSelectList

Gets current value of property showOverflowSelectList.

Specifies if the overflow select list is displayed.

The overflow select list represents a list, where all tab filters are displayed, so the user can select specific tab filter easier.

Default value is false.

getShowSelection

Gets current value of property showSelection.

Defines whether the current selection is visualized.

Default value is true.

Since 1.15.0 Regarding to changes of this control this property is not needed anymore.

getTabDensityMode

Gets current value of property tabDensityMode.

Specifies the visual density mode of the tabs.

The values that can be applied are Cozy, Compact and Inherit. Cozy and Compact render the control in one of these modes independent of the global density settings. The Inherit value follows the global density settings which are applied. For compatibility reasons, the default value is Cozy.

Default value is Cozy.

getTabsOverflowMode

Gets current value of property tabsOverflowMode.

Specifies the overflow mode of the header.

The default End mode shows as many tabs that can fit on the screen, then shows one overflow at the end containing the remaining items. The StartAndEnd is used to keep the order of tabs intact and offers overflow tabs on both ends of the bar.

Default value is End.

getVisible

Gets current value of property visible.

Specifies whether the control is rendered.

Default value is true.

indexOfItem

Checks for the provided sap.m.IconTab in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.m.IconTab

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.m.IconTab

The item to insert; if empty, nothing is inserted

iIndex int

The 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.m.IconTab

The item to remove or its index or id

setAriaTexts

Sets a new value for property ariaTexts.

Specifies optional texts for the screen reader.

The given object can contain the following keys: headerLabel - text to serve as a label for the header, headerDescription - text to serve as a description for the header.

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

Param Type DefaultValue Description
oAriaTexts object

New value for property ariaTexts

setBackgroundDesign

Sets a new value for property backgroundDesign.

Specifies the background color of the header.

Depending on the theme, you can change the state of the background color to "Solid", "Translucent", or "Transparent". Note: In SAP Belize Deep (sap_belize_plus) theme this property should be set to "Solid".

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

Default value is Solid.

Param Type DefaultValue Description
sBackgroundDesign sap.m.BackgroundDesign Solid

New value for property backgroundDesign

setEnableTabReordering

Sets a new value for property enableTabReordering.

Specifies whether tab reordering is enabled. Relevant only for desktop devices. The sap.m.IconTabSeparator cannot be dragged and dropped Items can be moved around sap.m.IconTabSeparator

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
bEnableTabReordering boolean false

New value for property enableTabReordering

setMaxNestingLevel

Sets a new value for property maxNestingLevel.

Specifies the allowed level of tabs nesting within one another using drag and drop. Default value is 0 which means nesting via interaction is not allowed. Maximum value is 100. This property allows nesting via user interaction only, and does not restrict adding items to the items aggregation of sap.m.IconTabFilter.

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

Default value is 0.

Param Type DefaultValue Description
iMaxNestingLevel int 0

New value for property maxNestingLevel

setMode

Sets a new value for property mode.

Specifies the header mode.

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

Default value is Standard.

Param Type DefaultValue Description
sMode sap.m.IconTabHeaderMode Standard

New value for property mode

setSelectedKey

Sets the selected item based on key.

Param Type DefaultValue Description
sKey string

The key of the item to be selected

setShowOverflowSelectList

Sets a new value for property showOverflowSelectList.

Specifies if the overflow select list is displayed.

The overflow select list represents a list, where all tab filters are displayed, so the user can select specific tab filter easier.

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
bShowOverflowSelectList boolean false

New value for property showOverflowSelectList

setShowSelection

Sets a new value for property showSelection.

Defines whether the current selection is visualized.

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

Default value is true.

Since 1.15.0 Regarding to changes of this control this property is not needed anymore.
Param Type DefaultValue Description
bShowSelection boolean true

New value for property showSelection

setTabDensityMode

Sets a new value for property tabDensityMode.

Specifies the visual density mode of the tabs.

The values that can be applied are Cozy, Compact and Inherit. Cozy and Compact render the control in one of these modes independent of the global density settings. The Inherit value follows the global density settings which are applied. For compatibility reasons, the default value is Cozy.

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

Default value is Cozy.

Param Type DefaultValue Description
sTabDensityMode sap.m.IconTabDensityMode Cozy

New value for property tabDensityMode

setTabsOverflowMode

Sets a new value for property tabsOverflowMode.

Specifies the overflow mode of the header.

The default End mode shows as many tabs that can fit on the screen, then shows one overflow at the end containing the remaining items. The StartAndEnd is used to keep the order of tabs intact and offers overflow tabs on both ends of the bar.

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

Default value is End.

Param Type DefaultValue Description
sTabsOverflowMode sap.m.TabsOverflowMode End

New value for property tabsOverflowMode

setVisible

Sets a new value for property visible.

Specifies whether the control is rendered.

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

Default value is true.

Param Type DefaultValue Description
bVisible boolean true

New value for property visible