class sap.ui.comp.smartfilterbar.GroupConfiguration

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/comp/smartfilterbar/GroupConfiguration
Application Component: CA-UI5-CMP

A GroupConfiguration can be used to add additional configurations for groups in the SmartFilterBar. A group in the SmartFilterBar is a group of filter fields in the advanced search.


Constructor

Constructor for a new smartfilterbar/GroupConfiguration.

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.comp.smartfilterbar.GroupConfiguration(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
index any undefined

Zero based integer index. The index can be used to specify the order of groups. If no index is specified, the order like in the OData metadata will be used.

Visibility: public
key string

The key property must correspond to the EntitySet name or FieldGroup Qualifier from the OData service $metadata document.

Visibility: public
label any undefined

Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar.

Visibility: public

Events Overview

Event Description
change

Fired when the value of a property, for example label, has changed

change

Fired when the value of a property, for example label, has changed

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

Name of the changed property


Methods Overview

Method Description
attachChange

Attaches event handler fnFunction to the change event of this sap.ui.comp.smartfilterbar.GroupConfiguration.

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.comp.smartfilterbar.GroupConfiguration itself.

Fired when the value of a property, for example label, has changed

detachChange

Detaches event handler fnFunction from the change event of this sap.ui.comp.smartfilterbar.GroupConfiguration.

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

sap.ui.comp.smartfilterbar.GroupConfiguration.extend

Creates a new subclass of class sap.ui.comp.smartfilterbar.GroupConfiguration 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.Element.extend.

fireChange

Fires event change to attached listeners.

getIndex

Gets current value of property index.

Zero based integer index. The index can be used to specify the order of groups. If no index is specified, the order like in the OData metadata will be used.

Default value is undefined.

getKey

Gets current value of property key.

The key property must correspond to the EntitySet name or FieldGroup Qualifier from the OData service $metadata document.

getLabel

Gets current value of property label.

Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar.

Default value is undefined.

sap.ui.comp.smartfilterbar.GroupConfiguration.getMetadata

Returns a metadata object for class sap.ui.comp.smartfilterbar.GroupConfiguration.

setIndex

Sets a new value for property index.

Zero based integer index. The index can be used to specify the order of groups. If no index is specified, the order like in the OData metadata will be used.

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

Default value is undefined.

setKey

Sets a new value for property key.

The key property must correspond to the EntitySet name or FieldGroup Qualifier from the OData service $metadata document.

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

setLabel

Sets a new value for property label.

Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar.

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

Default value is undefined.

attachChange

Attaches event handler fnFunction to the change event of this sap.ui.comp.smartfilterbar.GroupConfiguration.

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.comp.smartfilterbar.GroupConfiguration itself.

Fired when the value of a property, for example label, has changed

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.comp.smartfilterbar.GroupConfiguration itself

detachChange

Detaches event handler fnFunction from the change event of this sap.ui.comp.smartfilterbar.GroupConfiguration.

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.comp.smartfilterbar.GroupConfiguration.extend

Creates a new subclass of class sap.ui.comp.smartfilterbar.GroupConfiguration 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.Element.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

fireChange

Fires event change to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

propertyName string

Name of the changed property

getIndex

Gets current value of property index.

Zero based integer index. The index can be used to specify the order of groups. If no index is specified, the order like in the OData metadata will be used.

Default value is undefined.

getKey

Gets current value of property key.

The key property must correspond to the EntitySet name or FieldGroup Qualifier from the OData service $metadata document.

getLabel

Gets current value of property label.

Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar.

Default value is undefined.

sap.ui.comp.smartfilterbar.GroupConfiguration.getMetadata

Returns a metadata object for class sap.ui.comp.smartfilterbar.GroupConfiguration.

setIndex

Sets a new value for property index.

Zero based integer index. The index can be used to specify the order of groups. If no index is specified, the order like in the OData metadata will be used.

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

Default value is undefined.

Param Type DefaultValue Description
oIndex any

New value for property index

setKey

Sets a new value for property key.

The key property must correspond to the EntitySet name or FieldGroup Qualifier from the OData service $metadata document.

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

Param Type DefaultValue Description
sKey string

New value for property key

setLabel

Sets a new value for property label.

Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar.

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

Default value is undefined.

Param Type DefaultValue Description
oLabel any

New value for property label