Class sap.m.IconTabHeaderModule: sap/m/IconTabHeader

extends Control

This control displays a number of IconTabFilters and IconTabSeparators. If the available horizontal space is exceeded, a horizontal scrolling appears.
Constructor Summary
new sap.m.IconTabHeader(sId?, mSettings?)Constructor for a new IconTabHeader.
Event Summary
select(oControlEvent)Fires when an item is selected.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.IconTabHeader.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.IconTabHeader with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.IconTabHeader.getMetadata()Returns a metadata object for class sap.m.IconTabHeader.
addItem(oItem)Adds some item to the aggregation items.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.m.IconTabHeader.
destroyItems()Destroys all the items in the aggregation items.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.m.IconTabHeader.
fireSelect(mParameters?)Fires event select to attached listeners.
getBackgroundDesign()Gets current value of property backgroundDesign.
getEnableTabReordering()Gets current value of property enableTabReordering.
getItems()Gets content of aggregation items.
getMode()Gets current value of property mode.
getSelectedKey()Gets current value of property selectedKey.
getShowOverflowSelectList()Gets current value of property showOverflowSelectList.
getVisible()Gets current value of property visible.
indexOfItem(oItem)Checks for the provided sap.m.IconTab in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setBackgroundDesign(sBackgroundDesign)Sets a new value for property backgroundDesign.
setEnableTabReordering(bEnableTabReordering)Sets a new value for property enableTabReordering.
setMode(sMode)Sets a new value for property mode.
setSelectedKey(sKey)Sets the selected item based on key.
setShowOverflowSelectList(bShowOverflowSelectList)Sets a new value for property showOverflowSelectList.
setVisible(bVisible)Sets a new value for property visible.
getShowSelection()Gets current value of property showSelection.
setShowSelection(bShowSelection)Sets a new value for property showSelection.
Constructor Detail
new sap.m.IconTabHeader(sId?, mSettings?)

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 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:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Event Detail
select(oControlEvent)
Fires when an item is selected.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.IconTabFilteroControlEvent.getParameters.itemThe selected item
stringoControlEvent.getParameters.keyThe key of the selected item
Method Detail
sap.m.IconTabHeader.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.IconTabHeader.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.IconTabHeader.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addItem(oItem): sap.m.IconTabHeader
Adds some item to the aggregation items.
Parameters:
sap.m.IconTaboItemthe item to add; if empty, nothing is inserted
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.m.IconTabHeader

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.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.IconTabHeader itself
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
destroyItems(): sap.m.IconTabHeader
Destroys all the items in the aggregation items.
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.m.IconTabHeader

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
fireSelect(mParameters?): sap.m.IconTabHeader
Fires event select to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.IconTabFiltermParameters.item?The selected item
stringmParameters.key?The key of the selected item
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
getBackgroundDesign(): sap.m.BackgroundDesign

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". Default is "Solid".

Default value is Solid.

Returns:
sap.m.BackgroundDesignValue of property backgroundDesign
Since:
1.44
getEnableTabReordering(): boolean

Gets current value of property enableTabReordering.

Specifies whether tab reordering is enabled. Relevant only for desktop devices.

Default value is false.

Returns:
booleanValue of property enableTabReordering
Since:
1.46
getItems(): sap.m.IconTab[]

Gets content of aggregation items.

The items displayed in the IconTabHeader.

Returns:
sap.m.IconTab[]

Gets current value of property mode.

Specifies the header mode. Note: The Inline mode works only if no icons are set.

Default value is Standard.

Returns:
sap.m.IconTabHeaderModeValue of property mode
Since:
1.40
getSelectedKey(): string

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.

Returns:
stringValue of property selectedKey
Since:
1.15.0
getShowOverflowSelectList(): boolean

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.

Returns:
booleanValue of property showOverflowSelectList
Since:
1.42
getVisible(): boolean

Gets current value of property visible.

Specifies whether the control is rendered.

Default value is true.

Returns:
booleanValue of property visible
Since:
1.15.0
indexOfItem(oItem): int
Checks for the provided sap.m.IconTab in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.m.IconTaboItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.m.IconTabHeader
Inserts a item into the aggregation items.
Parameters:
sap.m.IconTaboItemthe item to insert; if empty, nothing is inserted
intiIndexthe 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
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
removeAllItems(): sap.m.IconTab[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.m.IconTab[]An array of the removed elements (might be empty)
removeItem(vItem): sap.m.IconTab
Removes a item from the aggregation items.
Parameters:
int|string|sap.m.IconTabvItemThe item to remove or its index or id
Returns:
sap.m.IconTabThe removed item or null
setBackgroundDesign(sBackgroundDesign): sap.m.IconTabHeader

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". Default is "Solid".

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

Default value is Solid.

Parameters:
sap.m.BackgroundDesignsBackgroundDesignNew value for property backgroundDesign
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
Since:
1.44
setEnableTabReordering(bEnableTabReordering): sap.m.IconTabHeader

Sets a new value for property enableTabReordering.

Specifies whether tab reordering is enabled. Relevant only for desktop devices.

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

Default value is false.

Parameters:
booleanbEnableTabReorderingNew value for property enableTabReordering
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
Since:
1.46
setMode(sMode): sap.m.IconTabHeader

Sets a new value for property mode.

Specifies the header mode. Note: The Inline mode works only if no icons are set.

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

Default value is Standard.

Parameters:
sap.m.IconTabHeaderModesModeNew value for property mode
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
Since:
1.40
setSelectedKey(sKey): sap.m.IconTabHeader
Sets the selected item based on key.
Parameters:
stringsKeyThe key of the item to be selected
Returns:
sap.m.IconTabHeaderthis pointer for chaining
setShowOverflowSelectList(bShowOverflowSelectList): sap.m.IconTabHeader

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.

Parameters:
booleanbShowOverflowSelectListNew value for property showOverflowSelectList
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
Since:
1.42
setVisible(bVisible): sap.m.IconTabHeader

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.

Parameters:
booleanbVisibleNew value for property visible
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
Since:
1.15.0
getShowSelection(): boolean

Gets current value of property showSelection.

Defines whether the current selection is visualized.

Default value is true.

Returns:
booleanValue of property showSelection
Deprecated API:
As of 1.15.0. Regarding to changes of this control this property is not needed anymore.
setShowSelection(bShowSelection): sap.m.IconTabHeader

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.

Parameters:
booleanbShowSelectionNew value for property showSelection
Returns:
sap.m.IconTabHeaderReference to this in order to allow method chaining
Deprecated API:
As of 1.15.0. Regarding to changes of this control this property is not needed anymore.