Class sap.ui.ux3.FacetFilterModule: sap/ui/ux3/FacetFilter

extends Control

FacetFilter Control.
Deprecated API:
Since version 1.38. Instead, use the sap.m.FacetFilter control.
Constructor Summary
new sap.ui.ux3.FacetFilter(sId?, mSettings?)Constructor for a new FacetFilter.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.FacetFilter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.FacetFilter with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.FacetFilter.getMetadata()Returns a metadata object for class sap.ui.ux3.FacetFilter.
addList(oList)Adds some list to the aggregation lists.
destroyLists()Destroys all the lists in the aggregation lists.
getLists()Gets content of aggregation lists.
getVisibleItemCountMode()Gets current value of property visibleItemCountMode.
indexOfList(oList)Checks for the provided sap.ui.ux3.FacetFilterList in the aggregation lists.
insertList(oList, iIndex)Inserts a list into the aggregation lists.
removeAllLists()Removes all the controls from the aggregation lists.
removeList(vList)Removes a list from the aggregation lists.
setVisibleItemCountMode(sVisibleItemCountMode)Sets a new value for property visibleItemCountMode.
Constructor Detail
new sap.ui.ux3.FacetFilter(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

    • lists : sap.ui.ux3.FacetFilterList[]

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
Method Detail
sap.ui.ux3.FacetFilter.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.ui.ux3.FacetFilter.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.FacetFilter.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addList(oList): sap.ui.ux3.FacetFilter
Adds some list to the aggregation lists.
Parameters:
sap.ui.ux3.FacetFilterListoListthe list to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.FacetFilterReference to this in order to allow method chaining
destroyLists(): sap.ui.ux3.FacetFilter
Destroys all the lists in the aggregation lists.
Returns:
sap.ui.ux3.FacetFilterReference to this in order to allow method chaining

Gets content of aggregation lists.

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

Returns:
sap.ui.ux3.FacetFilterList[]
getVisibleItemCountMode(): sap.ui.ux3.VisibleItemCountMode

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.

Returns:
sap.ui.ux3.VisibleItemCountModeValue of property visibleItemCountMode
indexOfList(oList): int
Checks for the provided sap.ui.ux3.FacetFilterList in the aggregation lists. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.ux3.FacetFilterListoListThe list whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertList(oList, iIndex): sap.ui.ux3.FacetFilter
Inserts a list into the aggregation lists.
Parameters:
sap.ui.ux3.FacetFilterListoListthe list to insert; if empty, nothing is inserted
intiIndexthe 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
Returns:
sap.ui.ux3.FacetFilterReference to this in order to allow method chaining
removeAllLists(): sap.ui.ux3.FacetFilterList[]

Removes all the controls from the aggregation lists.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.ux3.FacetFilterList[]An array of the removed elements (might be empty)
removeList(vList): sap.ui.ux3.FacetFilterList
Removes a list from the aggregation lists.
Parameters:
int|string|sap.ui.ux3.FacetFilterListvListThe list to remove or its index or id
Returns:
sap.ui.ux3.FacetFilterListThe removed list or null
setVisibleItemCountMode(sVisibleItemCountMode): sap.ui.ux3.FacetFilter

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.

Parameters:
sap.ui.ux3.VisibleItemCountModesVisibleItemCountModeNew value for property visibleItemCountMode
Returns:
sap.ui.ux3.FacetFilterReference to this in order to allow method chaining