Class sap.ui.comp.smartfilterbar.GroupConfigurationModule: sap/ui/comp/smartfilterbar/GroupConfiguration

extends Element

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 Summary
new sap.ui.comp.smartfilterbar.GroupConfiguration(sId?, mSettings?)Constructor for a new smartfilterbar/GroupConfiguration.
Event Summary
change(oControlEvent)Fired when the value of a property, for example label, has changed
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.smartfilterbar.GroupConfiguration.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartfilterbar.GroupConfiguration with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.smartfilterbar.GroupConfiguration.getMetadata()Returns a metadata object for class sap.ui.comp.smartfilterbar.GroupConfiguration.
attachChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the change event of this sap.ui.comp.smartfilterbar.GroupConfiguration.
detachChange(fnFunction, oListener)Detaches event handler fnFunction from the change event of this sap.ui.comp.smartfilterbar.GroupConfiguration.
fireChange(mArguments?)Fires event change to attached listeners.
getIndex()Gets current value of property index.
getKey()Gets current value of property key.
getLabel()Gets current value of property label.
setIndex(oIndex)Sets a new value for property index.
setKey(sKey)Sets a new value for property key.
setLabel(oLabel)Sets a new value for property label.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.comp.smartfilterbar.GroupConfiguration(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • key : string
    • index : any (default: undefined)
    • label : any (default: undefined)
  • Events
    • change : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Event Detail
change(oControlEvent)
Fired when the value of a property, for example label, has changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.propertyName Name of the changed property
Method Detail
sap.ui.comp.smartfilterbar.GroupConfiguration.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.comp.smartfilterbar.GroupConfiguration.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.smartfilterbar.GroupConfiguration.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachChange(oData?, fnFunction, oListener?): sap.ui.comp.smartfilterbar.GroupConfiguration
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

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.comp.smartfilterbar.GroupConfiguration itself
Returns:
{sap.ui.comp.smartfilterbar.GroupConfiguration} Reference to this in order to allow method chaining
detachChange(fnFunction, oListener): sap.ui.comp.smartfilterbar.GroupConfiguration
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.comp.smartfilterbar.GroupConfiguration} Reference to this in order to allow method chaining
fireChange(mArguments?): sap.ui.comp.smartfilterbar.GroupConfiguration
Fires event change to attached listeners.

Expects the following event parameters:

  • propertyName of type stringName of the changed property
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartfilterbar.GroupConfiguration} Reference to this in order to allow method chaining
getIndex(): any
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.

Returns:
{any} Value of property index
getKey(): string
Gets current value of property key.

The key property shall correspond to the name EntityTypeName from the OData service $metadata document.

Returns:
{string} Value of property key
getLabel(): any
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.

Returns:
{any} Value of property label
setIndex(oIndex): sap.ui.comp.smartfilterbar.GroupConfiguration
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.

Parameters:
{any}oIndex New value for property index
Returns:
{sap.ui.comp.smartfilterbar.GroupConfiguration} Reference to this in order to allow method chaining
setKey(sKey): sap.ui.comp.smartfilterbar.GroupConfiguration
Sets a new value for property key.

The key property shall correspond to the name EntityTypeName from the OData service $metadata document.

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

Parameters:
{string}sKey New value for property key
Returns:
{sap.ui.comp.smartfilterbar.GroupConfiguration} Reference to this in order to allow method chaining
setLabel(oLabel): sap.ui.comp.smartfilterbar.GroupConfiguration
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.

Parameters:
{any}oLabel New value for property label
Returns:
{sap.ui.comp.smartfilterbar.GroupConfiguration} Reference to this in order to allow method chaining