Class sap.ui.comp.filterbar.FilterBarModule: sap/ui/comp/filterbar/FilterBar

extends Grid
known direct subclasses: SmartFilterBar

The control displays filters in a user-friendly manner to populate values for a query. The FilterBar consists of a row containing the VariantManagement control, the related buttons, and an area underneath displaying the filters. The filters are arranged in a logical row that is divided depending on the space available and the width of the filters. The area containing the filters can be hidden or shown using the Hide Filter Bar / Show Filter Bar button. The Go button triggers the search event, and the Filters button shows the filter dialog.
In this dialog, the consumer has full control over the filter bar. The filters in this dialog are displayed in one column and organized in groups. The filter items of the filterItems aggregation are grouped in the Basic group . Each filter can be marked as visible in the filter bar by selecting Add to Filter Bar. In addition, the items in the filterGroupItems aggregation can be marked as part of the current variant. The FilterBar also supports a different UI layout when used inside a value help dialog. In this case the FilterBar consists of two logical areas, one containing the general search button and in the Advanced Search area. The Advanced Search is a collapsible area displaying the advanced filters in two columns.

Constructor Summary
new sap.ui.comp.filterbar.FilterBar(sId?, mSettings?)Constructor for a new FilterBar.
Event Summary
afterVariantLoad(oControlEvent)This event is fired after a variant has been loaded and applied to the FilterBar.
afterVariantSave(oControlEvent)This event is fired after a variant has been saved.
assignedFiltersChanged(oControlEvent)This event is fired when the filters information has changed.
beforeVariantFetch(oControlEvent)This event is fired before a variant is fetched.
beforeVariantSave(oControlEvent)This event is fired before a variant is saved.
cancel(oControlEvent)This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked as dirty.
clear(oControlEvent)This event is fired when the Clear button is pressed.
filterChange(oControlEvent)This event is fired when a filter has changed.
filtersDialogClosed(oControlEvent)This event is fired after the filters dialog is closed.
initialise(oControlEvent)This event is fired when the filter bar is initialized.
initialized(oControlEvent)This event is fired after the filter bar was initialized and the standard variant was obtained.
reset(oControlEvent)This event is fired when the Restore button is pressed.
search(oControlEvent)This event is fired when the Go button is pressed.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.filterbar.FilterBar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.filterbar.FilterBar with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.filterbar.FilterBar.getMetadata()Returns a metadata object for class sap.ui.comp.filterbar.FilterBar.
_getFilterInformation()Provides filter information for lazy instantiation
addFilterGroupItem(oFilterGroupItem)Adds a FilterGroupItem element to the aggregation filterGroupItems.
addFilterItem(oFilterItem)Adds a FilterItem element to the aggregation filterItems.
applyVariant(oVariant, sContext, bInitial)Applies the variant.
attachAfterVariantLoad(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantLoad event of this sap.ui.comp.filterbar.FilterBar.
attachAfterVariantSave(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantSave event of this sap.ui.comp.filterbar.FilterBar.
attachAssignedFiltersChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the assignedFiltersChanged event of this sap.ui.comp.filterbar.FilterBar.
attachBeforeVariantFetch(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeVariantFetch event of this sap.ui.comp.filterbar.FilterBar.
attachBeforeVariantSave(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeVariantSave event of this sap.ui.comp.filterbar.FilterBar.
attachCancel(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cancel event of this sap.ui.comp.filterbar.FilterBar.
attachClear(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the clear event of this sap.ui.comp.filterbar.FilterBar.
attachFilterChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the filterChange event of this sap.ui.comp.filterbar.FilterBar.
attachFiltersDialogClosed(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the filtersDialogClosed event of this sap.ui.comp.filterbar.FilterBar.
attachInitialise(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the initialise event of this sap.ui.comp.filterbar.FilterBar.
attachInitialized(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the initialized event of this sap.ui.comp.filterbar.FilterBar.
attachReset(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the reset event of this sap.ui.comp.filterbar.FilterBar.
attachSearch(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the search event of this sap.ui.comp.filterbar.FilterBar.
clearVariantSelection()Resets the current selection in the variant management control to standard.
destroy()Destroys the control.
destroyFilterGroupItems()Destroys all the filterGroupItems in the aggregation filterGroupItems.
destroyFilterItems()Destroys all the filterItems in the aggregation filterItems.
detachAfterVariantLoad(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantLoad event of this sap.ui.comp.filterbar.FilterBar.
detachAfterVariantSave(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantSave event of this sap.ui.comp.filterbar.FilterBar.
detachAssignedFiltersChanged(fnFunction, oListener)Detaches event handler fnFunction from the assignedFiltersChanged event of this sap.ui.comp.filterbar.FilterBar.
detachBeforeVariantFetch(fnFunction, oListener)Detaches event handler fnFunction from the beforeVariantFetch event of this sap.ui.comp.filterbar.FilterBar.
detachBeforeVariantSave(fnFunction, oListener)Detaches event handler fnFunction from the beforeVariantSave event of this sap.ui.comp.filterbar.FilterBar.
detachCancel(fnFunction, oListener)Detaches event handler fnFunction from the cancel event of this sap.ui.comp.filterbar.FilterBar.
detachClear(fnFunction, oListener)Detaches event handler fnFunction from the clear event of this sap.ui.comp.filterbar.FilterBar.
detachFilterChange(fnFunction, oListener)Detaches event handler fnFunction from the filterChange event of this sap.ui.comp.filterbar.FilterBar.
detachFiltersDialogClosed(fnFunction, oListener)Detaches event handler fnFunction from the filtersDialogClosed event of this sap.ui.comp.filterbar.FilterBar.
detachInitialise(fnFunction, oListener)Detaches event handler fnFunction from the initialise event of this sap.ui.comp.filterbar.FilterBar.
detachInitialized(fnFunction, oListener)Detaches event handler fnFunction from the initialized event of this sap.ui.comp.filterbar.FilterBar.
detachReset(fnFunction, oListener)Detaches event handler fnFunction from the reset event of this sap.ui.comp.filterbar.FilterBar.
detachSearch(fnFunction, oListener)Detaches event handler fnFunction from the search event of this sap.ui.comp.filterbar.FilterBar.
determineControlByFilterItem(oFilterItem)Retrieves the control associated to the filter.
determineControlByName(sName, sGroupName)Retrieves the control based on the name and group name.
determineMandatoryFilterItems()Retrieves the mandatory filters.
fetchVariant(bConsiderInvisibleFilters)Creates and returns the variant representation.
fireAfterVariantSave(mArguments?)Fires event afterVariantSave to attached listeners.
fireAssignedFiltersChanged()Notifies about a filter change.
fireBeforeVariantFetch(mArguments?)Fires event beforeVariantFetch to attached listeners.
fireCancel(mArguments?)Fires event cancel to attached listeners.
fireClear(mArguments?)Fires event clear to attached listeners.
fireFiltersDialogClosed(mArguments?)Fires event filtersDialogClosed to attached listeners.
fireInitialise()This method has to be called by the consumer to indicate that the data model is available.
fireInitialized()This method will be called by the smart variant mangement and it indicates, that the standard variant was obtained.
fireReset(mArguments?)Fires event reset to attached listeners.
fireSearch(mArguments?)Fires event search to attached listeners.
getAdvancedMode()Gets current value of property advancedMode.
getAllFilterItems(bConsiderOnlyVisibleFields)Retrieves filters belonging to the current variant.
getBasicSearch()ID of the element which is the current target of the association basicSearch, or null.
getConsiderGroupTitle()Gets current value of property considerGroupTitle.
getCurrentVariantId()Retrieves the current variant ID.
getDataSuiteFormat(bConsiderAllFilters)Retrieves the current variant as selection variant for UI navigation
getDeltaVariantMode()Gets current value of property deltaVariantMode.
getFilterBarExpanded()Gets current value of property filterBarExpanded.
getFilterContainerWidth()Gets current value of property filterContainerWidth.
getFilterGroupItems()Gets content of aggregation filterGroupItems.
getFilterItems()Gets content of aggregation filterItems.
getHeader()Gets current value of property header.
getPersistencyKey()Gets current value of property persistencyKey.
getShowClearButton()Gets current value of property showClearButton.
getShowClearOnFB()Gets current value of property showClearOnFB.
getShowFilterConfiguration()Gets current value of property showFilterConfiguration.
getShowGoOnFB()Gets current value of property showGoOnFB.
getShowRestoreButton()Gets current value of property showRestoreButton.
getShowRestoreOnFB()Gets current value of property showRestoreOnFB.
getUseToolbar()Gets current value of property useToolbar.
indexOfFilterGroupItem(oFilterGroupItem)Checks for the provided sap.ui.comp.filterbar.FilterGroupItem in the aggregation filterGroupItems.
indexOfFilterItem(oFilterItem)Checks for the provided sap.ui.comp.filterbar.FilterItem in the aggregation filterItems.
insertFilterGroupItem(oFilterGroupItem, iIndex)Inserts a filterGroupItem into the aggregation filterGroupItems.
insertFilterItem(oFilterItem, iIndex)Inserts a filterItem into the aggregation filterItems.
registerApplyData(fCallBack)Registration of a callback function.
registerFetchData(fCallBack)Registration of a callback function.
registerGetFiltersWithValues(fCallBack)Registration of a callback function.
removeAllFilterGroupItems()Removes all entries in the aggregation filterGroupItems.
removeAllFilterItems()Removes all entries in the aggregation filterItems.
removeAllFilters()Removes all entries in the aggregations filterItems, filterGroupItems, basicSearch
removeBasicSearch()Removes the association basicSearch.
removeFilterGroupItem(vFilterGroupItem)Removes a filterGroupItem from the aggregation filterGroupItems.
removeFilterItem(vFilterItem)Removes a filterItem from the aggregation filterItems.
retrieveFiltersWithValues()Retrieves the labels of all visible filters that belongs to the current variant and have an assigned value.
retrieveFiltersWithValuesAsText()Retrieves the labels of all visible filters that belongs to the current variant and have an assigned value.
setAdvancedMode(bFlag)The advanced mode is only relevant for the value help scenario.
setBasicSearch(oBasicSearchField)Adds a basic search field to the toolbar.
setConsiderGroupTitle(bConsiderGroupTitle)Sets a new value for property considerGroupTitle.
setCurrentVariantId(sVariantId, bDoNotApplyVariant)Sets the current variant ID.
setDataSuiteFormat(sSuiteData, bReplace)Sets the selection variant for UI navigation to FilterBar.
setDeltaVariantMode(bDeltaVariantMode)Sets a new value for property deltaVariantMode.
setFilterBarExpanded(bShowExpanded)Sets filterbar in collapsed/expanded mode.
setFilterContainerWidth(sFilterContainerWidth)Sets a new value for property filterContainerWidth.
setHeader(sHeader)Sets a new value for property header.
setPersistencyKey(sPersistenceKey)Sets the persistency key.
setShowClearButton(bShowClearButton)Sets a new value for property showClearButton.
setShowClearOnFB(bFlag)Handles the visibility for the Clear button in the filter bar.
setShowGoOnFB(bFlag)Handles the visibility of the Go button on filter bar.
setShowRestoreButton(bShowRestoreButton)Sets a new value for property showRestoreButton.
setShowRestoreOnFB(bFlag)Handles the visibility of the Restore button in the filter bar.
setUseToolbar(bUseToolbar)Sets a new value for property useToolbar.
getSearchEnabled()Gets current value of property searchEnabled.
Methods borrowed from class sap.ui.layout.Grid
addAriaLabelledBy, addContent, destroyContent, getAccessibilityInfo, getAriaLabelledBy, getContainerQuery, getContent, getDefaultIndent, getDefaultSpan, getHSpacing, getPosition, getVSpacing, getWidth, indexOfContent, insertContent, removeAllAriaLabelledBy, removeAllContent, removeAriaLabelledBy, removeContent, setContainerQuery, setDefaultIndent, setDefaultSpan, setHSpacing, setPosition, setVSpacing, setWidth
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, 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, 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.filterbar.FilterBar(sId?, mSettings?)
Constructor for a new FilterBar.

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
  • Aggregations
  • Events
    • cancel : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • reset : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • search : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • beforeVariantSave : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • beforeVariantFetch : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • afterVariantLoad : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • filterChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • clear : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • initialise : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • initialized : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • afterVariantSave : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • filtersDialogClosed : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • assignedFiltersChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.layout.Grid 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
afterVariantLoad(oControlEvent)
This event is fired after a variant has been loaded and applied to the FilterBar. The event can be used to adapt custom filters with data from the variant.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.context Context of the event. Can also be null or undefined
afterVariantSave(oControlEvent)
This event is fired after a variant has been saved. ID of the saved variant.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
assignedFiltersChanged(oControlEvent)
This event is fired when the filters information has changed. It indicates specifically that the count of assigned filters may be changed. One of the intended reaction to this event would be to call retrieveFiltersWithValuesAsText method.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.38.0
beforeVariantFetch(oControlEvent)
This event is fired before a variant is fetched.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.28.13
beforeVariantSave(oControlEvent)
This event is fired before a variant is saved. The event can be used to adapt the data of the custom filters, which will be saved as variant later.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.context Context of the event. Can also be null or undefined
cancel(oControlEvent)
This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked as dirty.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
clear(oControlEvent)
This event is fired when the Clear button is pressed. The consumer has to clear all filters.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Control[]}oControlEvent.getParameters.selectionSet Visible controls
filterChange(oControlEvent)
This event is fired when a filter has changed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
filtersDialogClosed(oControlEvent)
This event is fired after the filters dialog is closed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.34.0
initialise(oControlEvent)
This event is fired when the filter bar is initialized.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
initialized(oControlEvent)
This event is fired after the filter bar was initialized and the standard variant was obtained. Eventual navigation related actions should be triggered by this event.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.38.0
reset(oControlEvent)
This event is fired when the Restore button is pressed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Control[]}oControlEvent.getParameters.selectionSet Visible controls
search(oControlEvent)
This event is fired when the Go button is pressed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Control[]}oControlEvent.getParameters.selectionSet Visible controls
Method Detail
sap.ui.comp.filterbar.FilterBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.comp.filterbar.FilterBar 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.layout.Grid.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.filterbar.FilterBar.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.filterbar.FilterBar.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
_getFilterInformation(): array
Provides filter information for lazy instantiation
Returns:
{array} of filter information
addFilterGroupItem(oFilterGroupItem)
Adds a FilterGroupItem element to the aggregation filterGroupItems.
Parameters:
{sap.ui.comp.filterbar.FilterGroupItem}oFilterGroupItem Belongs to any group other than basic
addFilterItem(oFilterItem)
Adds a FilterItem element to the aggregation filterItems.
Parameters:
{sap.ui.comp.filterbar.FilterItem}oFilterItem Belongs to the basic group
applyVariant(oVariant, sContext, bInitial)
Applies the variant. This method is executed from the SmartVariantManagement control.
Parameters:
{object}oVariant JSON object
{string}sContext Describes in which context the variant is applied. The context is passed on to the application via the afterVariantLoad event
{boolean}bInitial indicates if the apply was executed during the initialization phase.
attachAfterVariantLoad(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the afterVariantLoad event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired after a variant has been loaded and applied to the FilterBar. The event can be used to adapt custom filters with data from the variant.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachAfterVariantSave(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the afterVariantSave event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired after a variant has been saved. ID of the saved variant.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachAssignedFiltersChanged(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the assignedFiltersChanged event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when the filters information has changed. It indicates specifically that the count of assigned filters may be changed. One of the intended reaction to this event would be to call retrieveFiltersWithValuesAsText method.

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.filterbar.FilterBar itself
Since:
1.38.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachBeforeVariantFetch(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the beforeVariantFetch event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired before a variant is fetched.

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.filterbar.FilterBar itself
Since:
1.28.13
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachBeforeVariantSave(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the beforeVariantSave event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired before a variant is saved. The event can be used to adapt the data of the custom filters, which will be saved as variant later.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachCancel(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the cancel event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked as dirty.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachClear(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the clear event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when the Clear button is pressed. The consumer has to clear all filters.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachFilterChange(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the filterChange event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when a filter 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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachFiltersDialogClosed(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the filtersDialogClosed event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired after the filters dialog is closed.

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.filterbar.FilterBar itself
Since:
1.34.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachInitialise(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the initialise event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when the filter bar is initialized.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachInitialized(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the initialized event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired after the filter bar was initialized and the standard variant was obtained. Eventual navigation related actions should be triggered by this event.

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.filterbar.FilterBar itself
Since:
1.38.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachReset(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the reset event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when the Restore button is pressed.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
attachSearch(oData?, fnFunction, oListener?): sap.ui.comp.filterbar.FilterBar
Attaches event handler fnFunction to the search event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar itself.

This event is fired when the Go button is pressed.

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.filterbar.FilterBar itself
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
clearVariantSelection()
Resets the current selection in the variant management control to standard.
destroy()
Destroys the control.
destroyFilterGroupItems(): sap.ui.comp.filterbar.FilterBar
Destroys all the filterGroupItems in the aggregation filterGroupItems.
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
destroyFilterItems(): sap.ui.comp.filterbar.FilterBar
Destroys all the filterItems in the aggregation filterItems.
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
detachAfterVariantLoad(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the afterVariantLoad event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachAfterVariantSave(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the afterVariantSave event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachAssignedFiltersChanged(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the assignedFiltersChanged event of this sap.ui.comp.filterbar.FilterBar.

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
Since:
1.38.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
detachBeforeVariantFetch(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the beforeVariantFetch event of this sap.ui.comp.filterbar.FilterBar.

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
Since:
1.28.13
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
detachBeforeVariantSave(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the beforeVariantSave event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachCancel(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the cancel event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachClear(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the clear event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachFilterChange(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the filterChange event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachFiltersDialogClosed(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the filtersDialogClosed event of this sap.ui.comp.filterbar.FilterBar.

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
Since:
1.34.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
detachInitialise(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the initialise event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachInitialized(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the initialized event of this sap.ui.comp.filterbar.FilterBar.

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
Since:
1.38.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
detachReset(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the reset event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
detachSearch(fnFunction, oListener): sap.ui.comp.filterbar.FilterBar
Detaches event handler fnFunction from the search event of this sap.ui.comp.filterbar.FilterBar.

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.filterbar.FilterBar} Reference to this in order to allow method chaining
determineControlByFilterItem(oFilterItem): sap.ui.core.Control
Retrieves the control associated to the filter.
Parameters:
{sap.ui.comp.filterbar.FilterItem}oFilterItem From the aggregations
Returns:
{sap.ui.core.Control} The corresponding control. If no match is found null is returned.
determineControlByName(sName, sGroupName): sap.ui.core.Control
Retrieves the control based on the name and group name.
Parameters:
{string}sName Name of the filter.
{string}sGroupName Group name of the filter; null for filter that belongs to basic group.
Returns:
{sap.ui.core.Control} The corresponding control, if no match is found, null is returned.
determineMandatoryFilterItems(): array
Retrieves the mandatory filters.
Returns:
{array} Of visible mandatory filters
fetchVariant(bConsiderInvisibleFilters): object
Creates and returns the variant representation. This method is executed from the SmartVariantManagement control.
Parameters:
{boolean}bConsiderInvisibleFilters Indicates if invisible filters should be considered
Returns:
{object} JSON object
fireAfterVariantSave(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event afterVariantSave to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
fireAssignedFiltersChanged()
Notifies about a filter change. Is the indicator that the text of filters with values may be changed.
fireBeforeVariantFetch(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event beforeVariantFetch to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.28.13
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
fireCancel(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event cancel to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
fireClear(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event clear to attached listeners.

Expects the following event parameters:

  • selectionSet of type sap.ui.core.Control[]Visible controls
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
fireFiltersDialogClosed(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event filtersDialogClosed to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.34.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
fireInitialise()
This method has to be called by the consumer to indicate that the data model is available.
fireInitialized()
This method will be called by the smart variant mangement and it indicates, that the standard variant was obtained.
fireReset(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event reset to attached listeners.

Expects the following event parameters:

  • selectionSet of type sap.ui.core.Control[]Visible controls
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
fireSearch(mArguments?): sap.ui.comp.filterbar.FilterBar
Fires event search to attached listeners.

Expects the following event parameters:

  • selectionSet of type sap.ui.core.Control[]Visible controls
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
getAdvancedMode(): boolean
Gets current value of property advancedMode.

The advanced mode overwrites the standard behavior and is used in the value help scenario.

Default value is false.

Returns:
{boolean} Value of property advancedMode
getAllFilterItems(bConsiderOnlyVisibleFields): array
Retrieves filters belonging to the current variant.
Parameters:
{boolean}bConsiderOnlyVisibleFields Indicates that only visible filters are retrieved
Returns:
{array} filters Of the current variant
getBasicSearch(): sap.m.SearchField
ID of the element which is the current target of the association basicSearch, or null.
Since:
1.30.0
Returns:
{sap.m.SearchField}
getConsiderGroupTitle(): boolean
Gets current value of property considerGroupTitle.

If this property is set, then the label for filters will be prefixed with the group title.

Default value is false.

Since:
1.28.0
Returns:
{boolean} Value of property considerGroupTitle
getCurrentVariantId(): string
Retrieves the current variant ID.
Since:
1.28.0
Returns:
{string} ID of the current variant
getDataSuiteFormat(bConsiderAllFilters): string
Retrieves the current variant as selection variant for UI navigation
Parameters:
{boolean}bConsiderAllFilters also include empty/invisible fields filter data
Since:
1.28.0 Also include empty/invisible fields filter data
Returns:
{string} JSON string representing the selection variant for UI navigation; null otherwise
getDeltaVariantMode(): boolean
Gets current value of property deltaVariantMode.

Stores the delta as compared to the standard variant.

Default value is true.

Since:
1.34.0
Returns:
{boolean} Value of property deltaVariantMode
getFilterBarExpanded(): boolean
Gets current value of property filterBarExpanded.

Shows/hides the filter row.

Default value is true.

Since:
1.26.1
Returns:
{boolean} Value of property filterBarExpanded
getFilterContainerWidth(): string
Gets current value of property filterContainerWidth.

Sets the width of the filters container.

Default value is 12rem.

Since:
1.34.0
Returns:
{string} Value of property filterContainerWidth
getFilterGroupItems(): sap.ui.comp.filterbar.FilterGroupItem[]
Gets content of aggregation filterGroupItems.

Filters belonging to groups other than the basic group.

Returns:
{sap.ui.comp.filterbar.FilterGroupItem[]}
getFilterItems(): sap.ui.comp.filterbar.FilterItem[]
Gets content of aggregation filterItems.

Filters belonging to the basic group.

Returns:
{sap.ui.comp.filterbar.FilterItem[]}
getHeader(): string
Gets current value of property header.

Specifies header text that is shown in the toolbar on the first position. This property is ignored, when useToolbar is set to false.

Since:
1.38.0
Returns:
{string} Value of property header
getPersistencyKey(): string
Gets current value of property persistencyKey.

Key used to access personalization data.

Returns:
{string} Value of property persistencyKey
getShowClearButton(): boolean
Gets current value of property showClearButton.

Handles visibility of the Clear button on the Filters dialog.

Default value is false.

Since:
1.26.1
Returns:
{boolean} Value of property showClearButton
getShowClearOnFB(): boolean
Gets current value of property showClearOnFB.

Handles visibility of the Clear button on the filter bar.

Default value is false.

Since:
1.28.0
Returns:
{boolean} Value of property showClearOnFB
getShowFilterConfiguration(): boolean
Gets current value of property showFilterConfiguration.

Handles visibility of the Filters button on the filter bar.

Default value is true.

Since:
1.38.0
Returns:
{boolean} Value of property showFilterConfiguration
getShowGoOnFB(): boolean
Gets current value of property showGoOnFB.

Handles visibility of the Go button on the filter bar.

Default value is true.

Since:
1.28.0
Returns:
{boolean} Value of property showGoOnFB
getShowRestoreButton(): boolean
Gets current value of property showRestoreButton.

Handles visibility of the Restore button on the Filters dialog.

Default value is true.

Since:
1.26.1
Returns:
{boolean} Value of property showRestoreButton
getShowRestoreOnFB(): boolean
Gets current value of property showRestoreOnFB.

Handles visibility of the Restore button on the filter bar.

Default value is false.

Since:
1.28.0
Returns:
{boolean} Value of property showRestoreOnFB
getUseToolbar(): boolean
Gets current value of property useToolbar.

Determines what design should be used. Default is the design with the toolbar. In mobile scenarios this property is ignored - the design with the toolbar will be used.

Default value is true.

Since:
1.38.0
Returns:
{boolean} Value of property useToolbar
indexOfFilterGroupItem(oFilterGroupItem): int
Checks for the provided sap.ui.comp.filterbar.FilterGroupItem in the aggregation filterGroupItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.comp.filterbar.FilterGroupItem}oFilterGroupItem The filterGroupItem whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfFilterItem(oFilterItem): int
Checks for the provided sap.ui.comp.filterbar.FilterItem in the aggregation filterItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.comp.filterbar.FilterItem}oFilterItem The filterItem whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertFilterGroupItem(oFilterGroupItem, iIndex): sap.ui.comp.filterbar.FilterBar
Inserts a filterGroupItem into the aggregation filterGroupItems.
Parameters:
{sap.ui.comp.filterbar.FilterGroupItem}oFilterGroupItem the filterGroupItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the filterGroupItem should be inserted at; for a negative value of iIndex, the filterGroupItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterGroupItem is inserted at the last position
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
insertFilterItem(oFilterItem, iIndex): sap.ui.comp.filterbar.FilterBar
Inserts a filterItem into the aggregation filterItems.
Parameters:
{sap.ui.comp.filterbar.FilterItem}oFilterItem the filterItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the filterItem should be inserted at; for a negative value of iIndex, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
registerApplyData(fCallBack)
Registration of a callback function. The provided callback function is executed when a variant must be applied. The callback function will receive the corresponding data set containing all relevant data in JSON, as initially provided by the callback for fetchData.
Parameters:
{function}fCallBack Called when a variant must be applied
registerFetchData(fCallBack)
Registration of a callback function. The provided callback function is executed when saving a variant is triggered and must provide all relevant fields and values in JSON.
Parameters:
{function}fCallBack Called when a variant must be fetched
registerGetFiltersWithValues(fCallBack)
Registration of a callback function. The provided callback function is executed to obtain the filters with values.
Parameters:
{function}fCallBack Called when a variant must be applied
Since:
1.26.1
removeAllFilterGroupItems(): sap.ui.comp.filterbar.FilterGroupItem[]
Removes all entries in the aggregation filterGroupItems.
Returns:
{sap.ui.comp.filterbar.FilterGroupItem[]} An array of the removed elements (might be empty).
removeAllFilterItems()
Removes all entries in the aggregation filterItems.
removeAllFilters()
Removes all entries in the aggregations filterItems, filterGroupItems, basicSearch
removeBasicSearch()
Removes the association basicSearch.
Since:
1.30.0
removeFilterGroupItem(vFilterGroupItem): sap.ui.comp.filterbar.FilterGroupItem
Removes a filterGroupItem from the aggregation filterGroupItems.
Parameters:
{int|string|sap.ui.comp.filterbar.FilterGroupItem}vFilterGroupItem The filterGroupItemto remove or its index or id
Returns:
{sap.ui.comp.filterbar.FilterGroupItem} The removed filterGroupItem or null
removeFilterItem(vFilterItem): sap.ui.comp.filterbar.FilterItem
Removes a filterItem from the aggregation filterItems.
Parameters:
{int|string|sap.ui.comp.filterbar.FilterItem}vFilterItem The filterItemto remove or its index or id
Returns:
{sap.ui.comp.filterbar.FilterItem} The removed filterItem or null
retrieveFiltersWithValues(): array
Retrieves the labels of all visible filters that belongs to the current variant and have an assigned value.
Returns:
{array} Filter labels that represents relevant filters with values
retrieveFiltersWithValuesAsText(): array
Retrieves the labels of all visible filters that belongs to the current variant and have an assigned value.
Returns:
{array} Filter labels that represents relevant filters with values
setAdvancedMode(bFlag)
The advanced mode is only relevant for the value help scenario. UI representation is different from the standard filter bar.
Parameters:
{boolean}bFlag Sets the advanced mode
setBasicSearch(oBasicSearchField)
Adds a basic search field to the toolbar.
Parameters:
{sap.m.SearchField}oBasicSearchField Control
setConsiderGroupTitle(bConsiderGroupTitle): sap.ui.comp.filterbar.FilterBar
Sets a new value for property considerGroupTitle.

If this property is set, then the label for filters will be prefixed with the group title.

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

Default value is false.

Parameters:
{boolean}bConsiderGroupTitle New value for property considerGroupTitle
Since:
1.28.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
setCurrentVariantId(sVariantId, bDoNotApplyVariant)
Sets the current variant ID.
Parameters:
{string}sVariantId ID of the variant
{boolean}bDoNotApplyVariant If set to true, the applyVariant method is not executed yet. Relevant during navigation, when called before the initialise event has been executed.
Since:
1.28.0
setDataSuiteFormat(sSuiteData, bReplace)
Sets the selection variant for UI navigation to FilterBar.
Parameters:
{string}sSuiteData Represents the selection variants for UI navigation
{boolean}bReplace Replaces existing filter data
Since:
1.28.0
setDeltaVariantMode(bDeltaVariantMode): sap.ui.comp.filterbar.FilterBar
Sets a new value for property deltaVariantMode.

Stores the delta as compared to the standard variant.

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

Default value is true.

Parameters:
{boolean}bDeltaVariantMode New value for property deltaVariantMode
Since:
1.34.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
setFilterBarExpanded(bShowExpanded)
Sets filterbar in collapsed/expanded mode.
Parameters:
{boolean}bShowExpanded Mode
Since:
1.26.1
setFilterContainerWidth(sFilterContainerWidth): sap.ui.comp.filterbar.FilterBar
Sets a new value for property filterContainerWidth.

Sets the width of the filters container.

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

Default value is 12rem.

Parameters:
{string}sFilterContainerWidth New value for property filterContainerWidth
Since:
1.34.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
setHeader(sHeader): sap.ui.comp.filterbar.FilterBar
Sets a new value for property header.

Specifies header text that is shown in the toolbar on the first position. This property is ignored, when useToolbar is set to false.

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

Parameters:
{string}sHeader New value for property header
Since:
1.38.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
setPersistencyKey(sPersistenceKey)
Sets the persistency key.
Parameters:
{string}sPersistenceKey ID for persistency
setShowClearButton(bShowClearButton): sap.ui.comp.filterbar.FilterBar
Sets a new value for property showClearButton.

Handles visibility of the Clear button on the Filters dialog.

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

Default value is false.

Parameters:
{boolean}bShowClearButton New value for property showClearButton
Since:
1.26.1
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
setShowClearOnFB(bFlag)
Handles the visibility for the Clear button in the filter bar. On phone devices, the value is always treated as false.
Parameters:
{boolean}bFlag State of visibility
Since:
1.28.0
setShowGoOnFB(bFlag)
Handles the visibility of the Go button on filter bar.
Parameters:
{boolean}bFlag State of visibility
Since:
1.28.0
setShowRestoreButton(bShowRestoreButton): sap.ui.comp.filterbar.FilterBar
Sets a new value for property showRestoreButton.

Handles visibility of the Restore button on the Filters dialog.

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

Default value is true.

Parameters:
{boolean}bShowRestoreButton New value for property showRestoreButton
Since:
1.26.1
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
setShowRestoreOnFB(bFlag)
Handles the visibility of the Restore button in the filter bar. On phone devices, the value is always treated as false.
Parameters:
{boolean}bFlag State of visibility
Since:
1.28.0
setUseToolbar(bUseToolbar): sap.ui.comp.filterbar.FilterBar
Sets a new value for property useToolbar.

Determines what design should be used. Default is the design with the toolbar. In mobile scenarios this property is ignored - the design with the toolbar will be used.

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

Default value is true.

Parameters:
{boolean}bUseToolbar New value for property useToolbar
Since:
1.38.0
Returns:
{sap.ui.comp.filterbar.FilterBar} Reference to this in order to allow method chaining
getSearchEnabled(): boolean
Gets current value of property searchEnabled.

Enables/disables the Search button.

Default value is true.

Deprecated:
Since version 1.32.0.
Returns:
{boolean} Value of property searchEnabled