Represents a selectable item inside an IconTabBar.
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#constructor for a general description of the syntax of the settings object.
new sap.m.IconTabFilter(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 |
Name | Type | Default Value | Description |
---|---|---|---|
count | string | empty string | Represents the "count" text, which is displayed in the tab filter. Visibility: public |
design | sap.m.IconTabFilterDesign | Vertical | Specifies whether the icon and the texts are placed vertically or horizontally. Visibility: public |
icon | sap.ui.core.URI | empty string | Specifies the icon to be displayed for the tab filter. Visibility: public |
iconColor | sap.ui.core.IconColor | Default | 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. Visibility: public |
iconDensityAware | boolean | true | 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. Visibility: public |
showAll | boolean | false | Enables special visualization for disabled filter (show all items). Note: You can use this property when you use |
visible | boolean | true | Specifies whether the tab filter is rendered. Visibility: public |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
_expandButton | 0..1 | sap.m.Button |
The expand button if there are sub filters |
_expandButtonBadge | 0..1 | sap.ui.core.Control |
The badge of the expand button |
content (default) | 0..n | sap.ui.core.Control |
The content displayed for this item (optional). If this content is set, it is displayed instead of the general content inside the IconTabBar. |
items | 0..n | sap.m.IconTab |
The sub items of this filter (optional). |
Method | Description |
---|---|
addContent |
Adds some content to the aggregation content. |
addItem |
Adds some item to the aggregation items. |
destroyContent |
Destroys all the content in the aggregation content. |
destroyItems |
Destroys all the items in the aggregation items. |
sap.m.IconTabFilter.extend |
Creates a new subclass of class sap.m.IconTabFilter with name
|
getContent |
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. |
getCount |
Gets current value of property count. Represents the "count" text, which is displayed in the tab filter. Default value is |
getDesign |
Gets current value of property design. Specifies whether the icon and the texts are placed vertically or horizontally. Default value is |
getIcon |
Gets current value of property icon. Specifies the icon to be displayed for the tab filter. Default value is |
getIconColor |
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 |
getIconDensityAware |
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 |
getItems |
Gets content of aggregation items. The sub items of this filter (optional). |
sap.m.IconTabFilter.getMetadata |
Returns a metadata object for class sap.m.IconTabFilter. |
getShowAll |
Gets current value of property showAll. Enables special visualization for disabled filter (show all items). Note: You can use this property when you use Default value is |
getVisible |
Gets current value of property visible. Specifies whether the tab filter is rendered. Default value is |
indexOfContent |
Checks for the provided |
indexOfItem |
Checks for the provided |
insertContent |
Inserts a content into the aggregation content. |
insertItem |
Inserts a item into the aggregation items. |
removeAllContent |
Removes all the controls from the aggregation content. Additionally, it unregisters them from the hosting UIArea. |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeContent |
Removes a content from the aggregation content. |
removeItem |
Removes a item from the aggregation items. |
render |
Renders this item in the IconTabHeader. |
renderInSelectList |
Renders this item in the IconTabSelectList. |
setCount |
Sets a new value for property count. Represents the "count" text, which is displayed in the tab filter. When called with a value of Default value is |
setDesign |
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 Default value is |
setIcon |
Sets a new value for property icon. Specifies the icon to be displayed for the tab filter. When called with a value of Default value is |
setIconColor |
Sets a new value for 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. When called with a value of Default value is |
setIconDensityAware |
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 Default value is |
setShowAll |
Sets a new value for property showAll. Enables special visualization for disabled filter (show all items). Note: You can use this property when you use When called with a value of Default value is |
setVisible |
Sets a new value for property visible. Specifies whether the tab filter is rendered. When called with a value of Default value is |
Adds some content to the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to add; if empty, nothing is inserted |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.m.IconTab |
The item to add; if empty, nothing is inserted |
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.
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 |
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.
Gets current value of property count.
Represents the "count" text, which is displayed in the tab filter.
Default value is empty string
.
Gets current value of property design.
Specifies whether the icon and the texts are placed vertically or horizontally.
Default value is Vertical
.
Gets current value of property icon.
Specifies the icon to be displayed for the tab filter.
Default value is empty string
.
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
.
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
.
Gets current value of property showAll.
Enables special visualization for disabled filter (show all items). Note: You can use this property when you use IconTabBar
as a filter. In order for it to be displayed correctly, the other tabs in the filter should consist of an icon, text and an optional count. It can be set to true for the first tab filter. You can find more detailed information in the UX Guidelines
.
Default value is false
.
Gets current value of property visible.
Specifies whether the tab filter is rendered.
Default value is true
.
Checks for the provided sap.ui.core.Control
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content whose index is looked for |
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 |
Inserts a content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
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 |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.core.Control |
The content to remove or its index or id |
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 |
Renders this item in the IconTabHeader.
Param | Type | DefaultValue | Description |
---|---|---|---|
oRM | sap.ui.core.RenderManager |
the RenderManager that can be used for writing to the render output buffer |
|
iVisibleIndex | int |
the visible index within the parent control |
|
iVisibleItemsCount | int |
the visible items count |
Renders this item in the IconTabSelectList.
Param | Type | DefaultValue | Description |
---|---|---|---|
oRM | sap.ui.core.RenderManager |
RenderManager used for writing to the render output buffer |
|
oSelectList | sap.m.IconTabBarSelectList |
the select list in which this filter is rendered |
|
iIndexInSet | int |
this item's index within the aggregation of items |
|
iSetSize | int |
total length of the aggregation of items |
|
fPaddingValue | float |
the padding with which the item should be indented |
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 empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sCount | string | '' |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDesign | sap.m.IconTabFilterDesign | Vertical |
New value for property |
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 empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI | '' |
New value for property |
Sets a new value for 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.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Default
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIconColor | sap.ui.core.IconColor | Default |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIconDensityAware | boolean | true |
New value for property |
Sets a new value for property showAll.
Enables special visualization for disabled filter (show all items). Note: You can use this property when you use IconTabBar
as a filter. In order for it to be displayed correctly, the other tabs in the filter should consist of an icon, text and an optional count. It can be set to true for the first tab filter. You can find more detailed information in the UX Guidelines
.
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 |
---|---|---|---|
bShowAll | boolean | false |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bVisible | boolean | true |
New value for property |