Class sap.ui.ux3.FacetFilterListModule: sap/ui/ux3/FacetFilterList

extends Control

List to be used with the FacetFilter control. The control is not intended to be used stand alone.
Deprecated API:
Since version 1.38. Instead, use the sap.m.FacetFilter control.
Constructor Summary
new sap.ui.ux3.FacetFilterList(sId?, mSettings?)Constructor for a new FacetFilterList.
Event Summary
select(oControlEvent)On Select event.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.FacetFilterList.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.FacetFilterList with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.FacetFilterList.getMetadata()Returns a metadata object for class sap.ui.ux3.FacetFilterList.
addItem(oItem)Adds some item to the aggregation items.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.ux3.FacetFilterList.
destroyItems()Destroys all the items in the aggregation items.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.ux3.FacetFilterList.
fireSelect(mParameters?)Fires event select to attached listeners.
getDisplaySecondaryValues()Gets current value of property displaySecondaryValues.
getItems()Gets content of aggregation items.
getMultiSelect()Gets current value of property multiSelect.
getSelectedKeys()Gets current value of property selectedKeys.
getShowCounter()Gets current value of property showCounter.
getTitle()Gets current value of property title.
indexOfItem(oItem)Checks for the provided sap.ui.core.ListItem 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.
setDisplaySecondaryValues(bDisplaySecondaryValues)Sets a new value for property displaySecondaryValues.
setMultiSelect(bMultiSelect)Sets a new value for property multiSelect.
setSelectedKeys(sSelectedKeys)Sets a new value for property selectedKeys.
setShowCounter(bShowCounter)Sets a new value for property showCounter.
setTitle(sTitle)Sets a new value for property title.
Constructor Detail
new sap.ui.ux3.FacetFilterList(sId?, mSettings?)

Constructor for a new FacetFilterList.

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:

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
Event Detail
select(oControlEvent)
On Select event.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.idId of the FacetFilterList taht fires the event.
int[]oControlEvent.getParameters.selectedIndicesArray of selected Indices.
sap.ui.core.ListItem[]oControlEvent.getParameters.selectedItemsArray of selected Items.
booleanoControlEvent.getParameters.allIf it is true, then Item All is selected. That means all items in the list are selected - no filter is set.
Method Detail
sap.ui.ux3.FacetFilterList.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.ux3.FacetFilterList 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.FacetFilterList.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.FacetFilterList.
Returns:
sap.ui.base.MetadataMetadata object describing this class
Adds some item to the aggregation items.
Parameters:
sap.ui.core.ListItemoItemthe item to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.ui.ux3.FacetFilterList

Attaches event handler fnFunction to the select event of this sap.ui.ux3.FacetFilterList.

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.ui.ux3.FacetFilterList itself.

On Select event.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.FacetFilterList itself
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
Destroys all the items in the aggregation items.
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.ui.ux3.FacetFilterList

Detaches event handler fnFunction from the select event of this sap.ui.ux3.FacetFilterList.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
fireSelect(mParameters?): sap.ui.ux3.FacetFilterList
Fires event select to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.id?Id of the FacetFilterList taht fires the event.
int[]mParameters.selectedIndices?Array of selected Indices.
sap.ui.core.ListItem[]mParameters.selectedItems?Array of selected Items.
booleanmParameters.all?If it is true, then Item All is selected. That means all items in the list are selected - no filter is set.
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
getDisplaySecondaryValues(): boolean

Gets current value of property displaySecondaryValues.

Specifies whether the text values from the additionalText property (see sap.ui.core.ListItems) shall be displayed.

Default value is false.

Returns:
booleanValue of property displaySecondaryValues
Since:
1.9.0
getItems(): sap.ui.core.ListItem[]

Gets content of aggregation items.

The filter values that are presented as a list.

Returns:
sap.ui.core.ListItem[]
getMultiSelect(): boolean

Gets current value of property multiSelect.

Specifies whether multiple or single selection is used.

Default value is true.

Returns:
booleanValue of property multiSelect
getSelectedKeys(): string[]

Gets current value of property selectedKeys.

Array of type string containing the selected keys.

Returns:
string[]Value of property selectedKeys
getShowCounter(): boolean

Gets current value of property showCounter.

Specifies whether the counter for all entries is shown.

Default value is true.

Returns:
booleanValue of property showCounter
getTitle(): string

Gets current value of property title.

The title of this list.

Returns:
stringValue of property title
indexOfItem(oItem): int
Checks for the provided sap.ui.core.ListItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ListItemoItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.ux3.FacetFilterList
Inserts a item into the aggregation items.
Parameters:
sap.ui.core.ListItemoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 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.ui.ux3.FacetFilterListReference to this in order to allow method chaining
removeAllItems(): sap.ui.core.ListItem[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.ListItem[]An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.core.ListItem
Removes a item from the aggregation items.
Parameters:
int|string|sap.ui.core.ListItemvItemThe item to remove or its index or id
Returns:
sap.ui.core.ListItemThe removed item or null
setDisplaySecondaryValues(bDisplaySecondaryValues): sap.ui.ux3.FacetFilterList

Sets a new value for property displaySecondaryValues.

Specifies whether the text values from the additionalText property (see sap.ui.core.ListItems) shall be displayed.

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

Default value is false.

Parameters:
booleanbDisplaySecondaryValuesNew value for property displaySecondaryValues
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
Since:
1.9.0
setMultiSelect(bMultiSelect): sap.ui.ux3.FacetFilterList

Sets a new value for property multiSelect.

Specifies whether multiple or single selection is used.

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

Default value is true.

Parameters:
booleanbMultiSelectNew value for property multiSelect
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
setSelectedKeys(sSelectedKeys): sap.ui.ux3.FacetFilterList

Sets a new value for property selectedKeys.

Array of type string containing the selected keys.

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

Parameters:
string[]sSelectedKeysNew value for property selectedKeys
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
setShowCounter(bShowCounter): sap.ui.ux3.FacetFilterList

Sets a new value for property showCounter.

Specifies whether the counter for all entries is shown.

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

Default value is true.

Parameters:
booleanbShowCounterNew value for property showCounter
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining
setTitle(sTitle): sap.ui.ux3.FacetFilterList

Sets a new value for property title.

The title of this list.

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

Parameters:
stringsTitleNew value for property title
Returns:
sap.ui.ux3.FacetFilterListReference to this in order to allow method chaining