class sap.ui.mdc.filterbar.vh.CollectiveSearchSelect

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/mdc/filterbar/vh/CollectiveSearchSelect
Application Component: CA-UI5-MDC

Can be used to manage the CollectiveSearchSelect contro search items.


Constructor

Constructor for a new CollectiveSearchSelect.

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.mdc.filterbar.vh.CollectiveSearchSelect(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
_currentItemText string Visibility: public
selectedItemKey string

The key of the selected item of the CollectiveSearchSelect.

The selectedItemKey must be set to the initially selected item key. When the user changes the selection, the property will change and reflect the key of the newly selected item.

Visibility: public
title string

The title of the CollectiveSearchSelect.

The title will be shown on the popover of the control on top of the List.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
items 0..n sap.ui.core.Item

Items displayed by the CollectiveSearchSelect control.


Events Overview

Event Description
select

This event is fired when a new item is selected.

select

This event is fired when a new item is selected.

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

Item key


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.mdc.filterbar.vh.CollectiveSearchSelect.

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.mdc.filterbar.vh.CollectiveSearchSelect itself.

This event is fired when a new item is selected.

destroyItems

Destroys all the items in the aggregation items.

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.

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

sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.extend

Creates a new subclass of class sap.ui.mdc.filterbar.vh.CollectiveSearchSelect 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.

get_currentItemText

Gets current value of property _currentItemText.

getItems

Gets content of aggregation items.

Items displayed by the CollectiveSearchSelect control.

sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.getMetadata

Returns a metadata object for class sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.

getSelectedItemKey

Gets current value of property selectedItemKey.

The key of the selected item of the CollectiveSearchSelect.

The selectedItemKey must be set to the initially selected item key. When the user changes the selection, the property will change and reflect the key of the newly selected item.

getTitle

Gets current value of property title.

The title of the CollectiveSearchSelect.

The title will be shown on the popover of the control on top of the List.

indexOfItem

Checks for the provided sap.ui.core.Item 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.

set_currentItemText

Sets a new value for property _currentItemText.

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

setSelectedItemKey

Sets a new value for property selectedItemKey.

The key of the selected item of the CollectiveSearchSelect.

The selectedItemKey must be set to the initially selected item key. When the user changes the selection, the property will change and reflect the key of the newly selected item.

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

setTitle

Sets a new value for property title.

The title of the CollectiveSearchSelect.

The title will be shown on the popover of the control on top of the 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.Item

The item to add; if empty, nothing is inserted

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.

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.mdc.filterbar.vh.CollectiveSearchSelect itself.

This event is fired when a new item is selected.

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.mdc.filterbar.vh.CollectiveSearchSelect itself

destroyItems

Destroys all the items in the aggregation items.

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.

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.mdc.filterbar.vh.CollectiveSearchSelect.extend

Creates a new subclass of class sap.ui.mdc.filterbar.vh.CollectiveSearchSelect 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

key string

Item key

get_currentItemText

Gets current value of property _currentItemText.

getItems

Gets content of aggregation items.

Items displayed by the CollectiveSearchSelect control.

sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.getMetadata

Returns a metadata object for class sap.ui.mdc.filterbar.vh.CollectiveSearchSelect.

getSelectedItemKey

Gets current value of property selectedItemKey.

The key of the selected item of the CollectiveSearchSelect.

The selectedItemKey must be set to the initially selected item key. When the user changes the selection, the property will change and reflect the key of the newly selected item.

getTitle

Gets current value of property title.

The title of the CollectiveSearchSelect.

The title will be shown on the popover of the control on top of the List.

indexOfItem

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

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

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

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

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.Item

The item to remove or its index or id

set_currentItemText

Sets a new value for property _currentItemText.

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

Param Type DefaultValue Description
s_currentItemText string

New value for property _currentItemText

setSelectedItemKey

Sets a new value for property selectedItemKey.

The key of the selected item of the CollectiveSearchSelect.

The selectedItemKey must be set to the initially selected item key. When the user changes the selection, the property will change and reflect the key of the newly selected item.

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

Param Type DefaultValue Description
sSelectedItemKey string

New value for property selectedItemKey

setTitle

Sets a new value for property title.

The title of the CollectiveSearchSelect.

The title will be shown on the popover of the control on top of the 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