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
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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(mArguments?)Fires event select to attached listeners.
getItems()Gets content of aggregation items.
getSelectedKey()Gets current value of property selectedKey.
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.
setSelectedKey(sKey)Sets the selected item based on key.
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.
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, 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.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:

  • Properties
  • Aggregations
  • Events
    • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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
Event Detail
select(oControlEvent)
Fires when an item is selected.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.m.IconTabFilter}oControlEvent.getParameters.item The selected item
{string}oControlEvent.getParameters.key The 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:
{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.m.IconTabHeader.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.IconTabHeader.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.m.IconTabHeader
Adds some item to the aggregation items.
Parameters:
{sap.m.IconTab}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.m.IconTabHeader} Reference 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:
{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.m.IconTabHeader itself
Returns:
{sap.m.IconTabHeader} Reference to this in order to allow method chaining
destroyItems(): sap.m.IconTabHeader
Destroys all the items in the aggregation items.
Returns:
{sap.m.IconTabHeader} Reference 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:
{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.m.IconTabHeader} Reference to this in order to allow method chaining
fireSelect(mArguments?): sap.m.IconTabHeader
Fires event select to attached listeners.

Expects the following event parameters:

  • item of type sap.m.IconTabFilterThe selected item
  • key of type stringThe key of the selected item
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.IconTabHeader} Reference to this in order to allow method chaining
getItems(): sap.m.IconTab[]
Gets content of aggregation items.

The items displayed in the IconTabHeader.

Returns:
{sap.m.IconTab[]}
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.

Since:
1.15.0
Returns:
{string} Value of property selectedKey
getVisible(): boolean
Gets current value of property visible.

Specifies whether the control is rendered.

Default value is true.

Since:
1.15.0
Returns:
{boolean} Value of property visible
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.IconTab}oItem The item whose index is looked for
Returns:
{int} The 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.IconTab}oItem the item to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.m.IconTabHeader} Reference 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.IconTab}vItem The itemto remove or its index or id
Returns:
{sap.m.IconTab} The removed item or null
setSelectedKey(sKey): sap.m.IconTabHeader
Sets the selected item based on key.
Parameters:
{string}sKey The key of the item to be selected
Returns:
{sap.m.IconTabHeader} this pointer for chaining
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:
{boolean}bVisible New value for property visible
Since:
1.15.0
Returns:
{sap.m.IconTabHeader} Reference to this in order to allow method chaining
getShowSelection(): boolean
Gets current value of property showSelection.

Defines whether the current selection is visualized.

Default value is true.

Deprecated:
As of 1.15.0. Regarding to changes of this control this property is not needed anymore.
Returns:
{boolean} Value of property showSelection
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:
{boolean}bShowSelection New value for property showSelection
Deprecated:
As of 1.15.0. Regarding to changes of this control this property is not needed anymore.
Returns:
{sap.m.IconTabHeader} Reference to this in order to allow method chaining