IconTabFilter

extends Item

implements IconTab

Represents a selectable item inside an IconTabBar.

Constructor Summary

new sap.m.IconTabFilter(sId?, mSettings?)Constructor for a new IconTabFilter.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.m.IconTabFilter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.IconTabFilter with name sClassName and enriches it with the information contained in oClassInfo.

sap.m.IconTabFilter.getMetadata()Returns a metadata object for class sap.m.IconTabFilter.

addContent(oContent)Adds some content to the aggregation content.

destroyContent()Destroys all the content in the aggregation content.

getContent()Gets content of aggregation content.

getCount()Gets current value of property count.

getDesign()Gets current value of property design.

getIcon()Gets current value of property icon.

getIconColor()Gets current value of property iconColor.

getIconDensityAware()Gets current value of property iconDensityAware.

getShowAll()Gets current value of property showAll.

getVisible()Gets current value of property visible.

indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.

insertContent(oContent, iIndex)Inserts a content into the aggregation content.

removeAllContent()Removes all the controls from the aggregation content.

removeContent(vContent)Removes a content from the aggregation content.

setCount(sCount)Sets a new value for property count.

setDesign(sDesign)Sets a new value for property design.

setIcon(sIcon)Sets a new value for property icon.

setIconColor(sIconColor)Sets a new value for property iconColor.

setIconDensityAware(bIconDensityAware)Sets a new value for property iconDensityAware.

setShowAll(bShowAll)Sets a new value for property showAll.

setVisible(bVisible)Sets a new value for property visible.

Methods borrowed from class sap.ui.core.Item

getEnabled, getKey, getText, getTextDirection, setEnabled, setKey, setText, setTextDirection

Methods borrowed from class sap.ui.core.Element

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, invalidate, 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.IconTabFilter(sId?, mSettings?)

Constructor for a new IconTabFilter.

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
- count : string (default: )
- showAll : boolean (default: false)
- icon : sap.ui.core.URI (default: )
- iconColor : sap.ui.core.IconColor (default: Default)
- iconDensityAware : boolean (default: true)
- visible : boolean (default: true)
- design : sap.m.IconTabFilterDesign (default: Vertical)
Aggregations
- content : sap.ui.core.Control[] (default)

In addition, all settings applicable to the base type sap.ui.core.Item 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

Method Detail

sap.m.IconTabFilter.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.IconTabFilter 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.Item.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.IconTabFilter.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addContent(oContent): sap.m.IconTabFilter

Adds some content to the aggregation content.

Parameters:

{sap.ui.core.Control}

oContent

the content to add; if empty, nothing is inserted

Since:: 1.15.0

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

destroyContent(): sap.m.IconTabFilter

Destroys all the content in the aggregation content.

Since:: 1.15.0

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The content displayed for this item (optional).

If this content is set, it is displayed instead of the general content inside the IconTabBar.

Since:: 1.15.0

Returns:

{sap.ui.core.Control[]}

getCount(): string

Gets current value of property count.

Represents the "count" text, which is displayed in the tab filter.

Default value is .

Returns:

{string} Value of property count

getDesign(): sap.m.IconTabFilterDesign

Gets current value of property design.

Specifies whether the icon and the texts are placed vertically or horizontally.

Default value is Vertical.

Returns:

{sap.m.IconTabFilterDesign} Value of property design

getIcon(): sap.ui.core.URI

Gets current value of property icon.

Specifies the icon to be displayed for the tab filter.

Default value is .

Returns:

{sap.ui.core.URI} Value of property icon

getIconColor(): sap.ui.core.IconColor

Gets current value of property iconColor.

Specifies the icon color.

If an icon font is used, the color can be chosen from the icon colors (sap.ui.core.IconColor). Possible semantic colors are: Neutral, Positive, Critical, Negative. Instead of the semantic icon color the brand color can be used, this is named Default. Semantic colors and brand colors should not be mixed up inside one IconTabBar.

Default value is Default.

Returns:

{sap.ui.core.IconColor} Value of property iconColor

getIconDensityAware(): boolean

Gets current value of property iconDensityAware.

If set to true, it sends one or more requests, trying to get the density perfect version of the image if this version of the image doesn't exist on the server. Default value is set to true.

If bandwidth is key for the application, set this value to false.

Default value is true.

Returns:

{boolean} Value of property iconDensityAware

getShowAll(): boolean

Gets current value of property showAll.

Enables special visualization for disabled filter (show all items).

Default value is false.

Returns:

{boolean} Value of property showAll

getVisible(): boolean

Gets current value of property visible.

Specifies whether the tab filter is rendered.

Default value is true.

Returns:

{boolean} Value of property visible

indexOfContent(oContent): int

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.core.Control}

oContent

The content whose index is looked for

Since:: 1.15.0

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertContent(oContent, iIndex): sap.m.IconTabFilter

Inserts a content into the aggregation content.

Parameters:

{sap.ui.core.Control}	oContent	the content to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position

Since:: 1.15.0

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

removeAllContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Since:: 1.15.0

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeContent(vContent): sap.ui.core.Control

Removes a content from the aggregation content.

Parameters:

{int|string|sap.ui.core.Control}

vContent

The contentto remove or its index or id

Since:: 1.15.0

Returns:

{sap.ui.core.Control} The removed content or null

setCount(sCount): sap.m.IconTabFilter

Sets a new value for property count.

Represents the "count" text, which is displayed in the tab filter.

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

Default value is .

Parameters:

{string} sCount New value for property count

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

setDesign(sDesign): sap.m.IconTabFilter

Sets a new value for property design.

Specifies whether the icon and the texts are placed vertically or horizontally.

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

Default value is Vertical.

Parameters:

{sap.m.IconTabFilterDesign} sDesign New value for property design

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

setIcon(sIcon): sap.m.IconTabFilter

Sets a new value for property icon.

Specifies the icon to be displayed for the tab filter.

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

Default value is .

Parameters:

{sap.ui.core.URI} sIcon New value for property icon

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

setIconColor(sIconColor): sap.m.IconTabFilter

Sets a new value for property iconColor.

Specifies the icon color.

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

Default value is Default.

Parameters:

{sap.ui.core.IconColor} sIconColor New value for property iconColor

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

setIconDensityAware(bIconDensityAware): sap.m.IconTabFilter

Sets a new value for property iconDensityAware.

If set to true, it sends one or more requests, trying to get the density perfect version of the image if this version of the image doesn't exist on the server. Default value is set to true.

If bandwidth is key for the application, set this value to false.

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

Default value is true.

Parameters:

{boolean} bIconDensityAware New value for property iconDensityAware

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

setShowAll(bShowAll): sap.m.IconTabFilter

Sets a new value for property showAll.

Enables special visualization for disabled filter (show all items).

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

Default value is false.

Parameters:

{boolean} bShowAll New value for property showAll

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining

setVisible(bVisible): sap.m.IconTabFilter

Sets a new value for property visible.

Specifies whether the tab filter 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

Returns:

{sap.m.IconTabFilter} Reference to this in order to allow method chaining