class sap.ui.ux3.FacetFilterList

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

List to be used with the FacetFilter control. The control is not intended to be used stand alone.


Constructor

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

new sap.ui.ux3.FacetFilterList(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
displaySecondaryValues boolean false

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

Since: 1.9.0.

Visibility: public
multiSelect boolean true

Specifies whether multiple or single selection is used.

Visibility: public
selectedKeys string[]

Array of type string containing the selected keys.

Visibility: public
showCounter boolean true

Specifies whether the counter for all entries is shown.

Visibility: public
title string

The title of this list.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
controls 0..n sap.ui.commons.ListBox

ListBoxes that are managed by this FacetFilterList

items 0..n sap.ui.core.ListItem

The filter values that are presented as a list.


Events Overview

Event Description
select

On Select event.

select

On Select event.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
id string

Id of the FacetFilterList taht fires the event.

selectedIndices int[]

Array of selected Indices.

selectedItems sap.ui.core.ListItem[]

Array of selected Items.

all boolean

If it is true, then Item All is selected. That means all items in the list are selected - no filter is set.


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

attachSelect

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.

destroyItems

Destroys all the items in the aggregation items.

detachSelect

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.

sap.ui.ux3.FacetFilterList.extend

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.

fireSelect

Fires event select to attached listeners.

getDisplaySecondaryValues

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.

getItems

Gets content of aggregation items.

The filter values that are presented as a list.

sap.ui.ux3.FacetFilterList.getMetadata

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

getMultiSelect

Gets current value of property multiSelect.

Specifies whether multiple or single selection is used.

Default value is true.

getSelectedKeys

Gets current value of property selectedKeys.

Array of type string containing the selected keys.

getShowCounter

Gets current value of property showCounter.

Specifies whether the counter for all entries is shown.

Default value is true.

getTitle

Gets current value of property title.

The title of this list.

indexOfItem

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

insertItem

Inserts a item into the aggregation items.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setDisplaySecondaryValues

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.

setMultiSelect

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.

setSelectedKeys

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.

setShowCounter

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.

setTitle

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.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.core.ListItem

The item to add; if empty, nothing is inserted

attachSelect

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.FacetFilterList itself

destroyItems

Destroys all the items in the aggregation items.

detachSelect

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.ux3.FacetFilterList.extend

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.

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

fireSelect

Fires event select to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

id string

Id of the FacetFilterList taht fires the event.

selectedIndices int[]

Array of selected Indices.

selectedItems sap.ui.core.ListItem[]

Array of selected Items.

all boolean

If it is true, then Item All is selected. That means all items in the list are selected - no filter is set.

getDisplaySecondaryValues

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.

getItems

Gets content of aggregation items.

The filter values that are presented as a list.

sap.ui.ux3.FacetFilterList.getMetadata

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

getMultiSelect

Gets current value of property multiSelect.

Specifies whether multiple or single selection is used.

Default value is true.

getSelectedKeys

Gets current value of property selectedKeys.

Array of type string containing the selected keys.

getShowCounter

Gets current value of property showCounter.

Specifies whether the counter for all entries is shown.

Default value is true.

getTitle

Gets current value of property title.

The title of this list.

indexOfItem

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

Param Type DefaultValue Description
oItem sap.ui.core.ListItem

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.core.ListItem

The item to insert; if empty, nothing is inserted

iIndex int

The 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

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.ui.core.ListItem

The item to remove or its index or id

setDisplaySecondaryValues

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.

Param Type DefaultValue Description
bDisplaySecondaryValues boolean false

New value for property displaySecondaryValues

setMultiSelect

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.

Param Type DefaultValue Description
bMultiSelect boolean true

New value for property multiSelect

setSelectedKeys

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.

Param Type DefaultValue Description
sSelectedKeys string[]

New value for property selectedKeys

setShowCounter

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.

Param Type DefaultValue Description
bShowCounter boolean true

New value for property showCounter

setTitle

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.

Param Type DefaultValue Description
sTitle string

New value for property title