namespace sap.ui.mdc.filterbar

Control sample: sap.ui.mdc.filterbar
Visiblity:
Available since: N/A
Module:
Application Component: CA-UI5-MDC

Nodes Overview

Node Description
sap.ui.mdc.filterbar.FilterBarBase

The FilterBarBase control is used as a faceless base class for common functionality of any MDC FilterBar derivation.

sap.ui.mdc.filterbar.vh

Methods Overview

Method Description
general description of the syntax of the settings object.

new sap.ui.mdc.FilterBar(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
_p13nModeItem boolean false

Specifies if the personalization mode for filter items is supported.

Visibility: hidden
_p13nModeValue boolean false

Specifies if the personalization mode for filter conditions is supported.

Visibility: hidden
p13nMode sap.ui.mdc.FilterBarP13nMode[]

Specifies the personalization options for the filter bar.

Since: 1.74.

Visibility: public
showAdaptFiltersButton boolean true

Determines whether the Adapt Filters button is visible in the filter bar.
Note: If the p13nMode property does not contain the value Item, it is ignored.

Visibility: public

Borrowed Properties

Name Type Default Value Description
delegate object ...see text or source

Defines the path to the metadata retrieval class for the FilterBarBase control. It basically identifies the FilterBarDelegate file that provides the required APIs to create the filter bar content.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Note: This property must not be bound.

Since: 1.74.

Visibility: public
filterConditions object empty object

Specifies the filter conditions.
Note: This property must not be bound.
Note: This property is used exclusively for SAPUI5 flexibility. Do not use it otherwise.

Since: 1.66.0.

Visibility: public
liveMode boolean false

Triggers a search automatically after a filter value has been changed.
Note: The liveMode property only operates in non-mobile scenarios.
Additionally, if the liveMode property is active, the following applies:
The error message box is not displayed, and the showMessages property is ignored.

Since: 1.74.

Visibility: public
showGoButton boolean true

Determines whether the Go button is visible in the filter bar.
Note: If the liveMode property is set to true, it is ignored.

Visibility: public
showMessages boolean true

Displays possible errors during the search in a message box.

Since: 1.74.

Visibility: public
suspendSelection boolean false

If set to true, all search requests are ignored. Once it has been set to false, a search is triggered immediately if one or more search requests have been triggered in the meantime but were ignored based on the setting.

Since: 1.79.0.

Visibility: public
delegate object

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
basicSearchField 0..1 sap.ui.mdc.FilterField

Contains the optional basic search field.

filterItems 0..n sap.ui.mdc.FilterField

Contains all the displayed filter fields of the FilterBarBase control.


Methods Overview

Method Description
sap.ui.mdc.FilterBar.extend

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

sap.ui.mdc.FilterBar.getMetadata

Returns a metadata object for class sap.ui.mdc.FilterBar.

getP13nMode

Gets current value of property p13nMode.

Specifies the personalization options for the filter bar.

getShowAdaptFiltersButton

Gets current value of property showAdaptFiltersButton.

Determines whether the Adapt Filters button is visible in the filter bar.
Note: If the p13nMode property does not contain the value Item, it is ignored.

Default value is true.

setP13nMode

Sets a new value for property p13nMode.

Specifies the personalization options for the filter bar.

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

setShowAdaptFiltersButton

Sets a new value for property showAdaptFiltersButton.

Determines whether the Adapt Filters button is visible in the filter bar.
Note: If the p13nMode property does not contain the value Item, it is ignored.

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

Default value is true.

sap.ui.mdc.FilterBar.extend

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

sap.ui.mdc.FilterBar.getMetadata

Returns a metadata object for class sap.ui.mdc.FilterBar.

getP13nMode

Gets current value of property p13nMode.

Specifies the personalization options for the filter bar.

getShowAdaptFiltersButton

Gets current value of property showAdaptFiltersButton.

Determines whether the Adapt Filters button is visible in the filter bar.
Note: If the p13nMode property does not contain the value Item, it is ignored.

Default value is true.

setP13nMode

Sets a new value for property p13nMode.

Specifies the personalization options for the filter bar.

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

Param Type DefaultValue Description
sP13nMode sap.ui.mdc.FilterBarP13nMode[]

New value for property p13nMode

setShowAdaptFiltersButton

Sets a new value for property showAdaptFiltersButton.

Determines whether the Adapt Filters button is visible in the filter bar.
Note: If the p13nMode property does not contain the value Item, it is ignored.

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
bShowAdaptFiltersButton boolean true

New value for property showAdaptFiltersButton