class sap.ui.ux3.FacetFilter

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

FacetFilter Control.


Constructor

Constructor for a new FacetFilter.

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.ui.ux3.FacetFilter(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
visibleItemCountMode sap.ui.ux3.VisibleItemCountMode Fixed

If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
lists 0..n sap.ui.ux3.FacetFilterList

Facet Filter list represents the list of the filter values and the title of this list.


Methods Overview

Method Description
addList

Adds some list to the aggregation lists.

destroyLists

Destroys all the lists in the aggregation lists.

sap.ui.ux3.FacetFilter.extend

Creates a new subclass of class sap.ui.ux3.FacetFilter 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.

getLists

Gets content of aggregation lists.

Facet Filter list represents the list of the filter values and the title of this list.

sap.ui.ux3.FacetFilter.getMetadata

Returns a metadata object for class sap.ui.ux3.FacetFilter.

getVisibleItemCountMode

Gets current value of property visibleItemCountMode.

If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.

Default value is Fixed.

indexOfList

Checks for the provided sap.ui.ux3.FacetFilterList in the aggregation lists. and returns its index if found or -1 otherwise.

insertList

Inserts a list into the aggregation lists.

removeAllLists

Removes all the controls from the aggregation lists.

Additionally, it unregisters them from the hosting UIArea.

removeList

Removes a list from the aggregation lists.

setVisibleItemCountMode

Sets a new value for property visibleItemCountMode.

If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.

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

Default value is Fixed.

addList

Adds some list to the aggregation lists.

Param Type DefaultValue Description
oList sap.ui.ux3.FacetFilterList

The list to add; if empty, nothing is inserted

destroyLists

Destroys all the lists in the aggregation lists.

sap.ui.ux3.FacetFilter.extend

Creates a new subclass of class sap.ui.ux3.FacetFilter 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

getLists

Gets content of aggregation lists.

Facet Filter list represents the list of the filter values and the title of this list.

sap.ui.ux3.FacetFilter.getMetadata

Returns a metadata object for class sap.ui.ux3.FacetFilter.

getVisibleItemCountMode

Gets current value of property visibleItemCountMode.

If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.

Default value is Fixed.

indexOfList

Checks for the provided sap.ui.ux3.FacetFilterList in the aggregation lists. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oList sap.ui.ux3.FacetFilterList

The list whose index is looked for

insertList

Inserts a list into the aggregation lists.

Param Type DefaultValue Description
oList sap.ui.ux3.FacetFilterList

The list to insert; if empty, nothing is inserted

iIndex int

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

removeAllLists

Removes all the controls from the aggregation lists.

Additionally, it unregisters them from the hosting UIArea.

removeList

Removes a list from the aggregation lists.

Param Type DefaultValue Description
vList int string sap.ui.ux3.FacetFilterList

The list to remove or its index or id

setVisibleItemCountMode

Sets a new value for property visibleItemCountMode.

If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.

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

Default value is Fixed.

Param Type DefaultValue Description
sVisibleItemCountMode sap.ui.ux3.VisibleItemCountMode Fixed

New value for property visibleItemCountMode