class sap.ui.comp.smartfilterbar.ControlConfiguration

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

ControlConfiguration can be used to add additional configuration for filter fields in the SmartFilterBar control, in order to overwrite the default settings from the OData metadata. For instance, it is possible to change the label, index or control type of a filter field.


Constructor

Constructor for a new smartfilterbar/ControlConfiguration.

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.ControlConfiguration(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
conditionType any

The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type

Visibility: public
controlType sap.ui.comp.smartfilterbar.ControlType auto

The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata.

Visibility: public
displayBehaviour sap.ui.comp.smartfilterbar.DisplayBehaviour auto

The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly for Combobox (DropDown text) , Description and ID for MultiInput (token text)

Visibility: public
filterType sap.ui.comp.smartfilterbar.FilterType auto

The filter type specifies whether the filter field is of type single value, multi-value, or interval. The filter type is calculated by the sap.ui.comp.smartfilterbar.SmartFilterBar control based on the OData metadata. Using this property the filter type can be configured manually.

Visibility: public
groupId string

The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName from the OData metadata. It is also possible to move a field from the advanced area to the basic area by specifying the groupId _BASIC.

Visibility: public
hasTypeAhead boolean true

Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g it does not work for DrodDownListbox

Visibility: public
hasValueHelpDialog boolean true

Specifies whether a value help dialog is available or not.

Visibility: public
historyEnabled boolean true

If set to false history values are disabled.

Note: For sap.m.ComboBox and sap.m.MultiComboBox the history values are disabled by default. To enable them for these controls, you need to set the historyEnabled property to true.

Since: 1.84.

Visibility: public
index int -1

The index property specifies the initial order of fields without any variants. It's zero based so in order for it to be taken into account, its value must be equal to or bigger than 0. Note: To ensure the expected sorting behavior, the index property should have a unique value.

Visibility: public
key string

The key property corresponds to the field name from the OData service $metadata document.

Visibility: public
label string

Using this property it is possible to overwrite the label of a filter field in the SmartFilterBar.

Visibility: public
mandatory sap.ui.comp.smartfilterbar.MandatoryType auto

Property can be used to overwrite the mandatory state of a filter field. Property can only be set during initialization. Changes at runtime will be ignored.

Visibility: public
preventInitialDataFetchInValueHelpDialog boolean false

In case there are value help annotations for this filter field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

Visibility: public
visible boolean true

Using this flag it is possible to hide fields from the OData metadata.

Visibility: public
visibleInAdvancedArea boolean false

If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default.

Visibility: public
width string

The width of the filter field in a CSS compatible format. The width can be set only once during initialization. Changes at runtime will not be reflected. The width will not be applied to custom controls.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
customControl 0..1 sap.ui.core.Control

If a custom control is specified, the SmartFilterBar will not create a control but use the custom control. Additional services like TypeAhead have to implemented manually.

defaultFilterValues 0..n sap.ui.comp.smartfilterbar.SelectOption

Default value for a filter field. The aggregation expects sap.ui.comp.smartfilterbar.SelectOption|SelectOption instances, where the values' format (properties low and high) match the type of the referneced property and consider also the given constraints of the property.

Samples for valid formats: Edm.DateTime with constraint sap:display-format='Date': "2018-12-24" (you optionally can provide a time-part and timezone, too, (2018-12-24T00:00:00Z) but this is ignored)

Edm.DateTimeOffset: "2018-12-24T13:55:59Z"

Edm.Time: "PT12H34M56S"

Edm.Boolean: "false"

Edm.Decimal: "2983.12"


Events Overview

Event Description
change

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

change

Fired when the value of a property, for example isVisible, 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
addDefaultFilterValue

Adds some defaultFilterValue to the aggregation defaultFilterValues.

attachChange

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

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.ControlConfiguration itself.

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

destroyCustomControl

Destroys the customControl in the aggregation customControl.

destroyDefaultFilterValues

Destroys all the defaultFilterValues in the aggregation defaultFilterValues.

detachChange

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

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

sap.ui.comp.smartfilterbar.ControlConfiguration.extend

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

getConditionType

Gets current value of property conditionType.

The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type

getControlType

Gets current value of property controlType.

The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata.

Default value is 'auto'.

getCustomControl

Gets content of aggregation customControl.

If a custom control is specified, the SmartFilterBar will not create a control but use the custom control. Additional services like TypeAhead have to implemented manually.

getDefaultFilterValues

Gets content of aggregation defaultFilterValues.

Default value for a filter field. The aggregation expects sap.ui.comp.smartfilterbar.SelectOption|SelectOption instances, where the values' format (properties low and high) match the type of the referneced property and consider also the given constraints of the property.

Samples for valid formats: Edm.DateTime with constraint sap:display-format='Date': "2018-12-24" (you optionally can provide a time-part and timezone, too, (2018-12-24T00:00:00Z) but this is ignored)

Edm.DateTimeOffset: "2018-12-24T13:55:59Z"

Edm.Time: "PT12H34M56S"

Edm.Boolean: "false"

Edm.Decimal: "2983.12"

getDisplayBehaviour

Gets current value of property displayBehaviour.

The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly for Combobox (DropDown text) , Description and ID for MultiInput (token text)

Default value is 'auto'.

getFilterType

Gets current value of property filterType.

The filter type specifies whether the filter field is of type single value, multi-value, or interval. The filter type is calculated by the sap.ui.comp.smartfilterbar.SmartFilterBar control based on the OData metadata. Using this property the filter type can be configured manually.

Default value is 'auto'.

getGroupId

Gets current value of property groupId.

The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName from the OData metadata. It is also possible to move a field from the advanced area to the basic area by specifying the groupId _BASIC.

getHasTypeAhead

Gets current value of property hasTypeAhead.

Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g it does not work for DrodDownListbox

Default value is true.

getHasValueHelpDialog

Gets current value of property hasValueHelpDialog.

Specifies whether a value help dialog is available or not.

Default value is true.

getHistoryEnabled

Gets current value of property historyEnabled.

If set to false history values are disabled.

Note: For sap.m.ComboBox and sap.m.MultiComboBox the history values are disabled by default. To enable them for these controls, you need to set the historyEnabled property to true.

Default value is true.

getIndex

Gets current value of property index.

The index property specifies the initial order of fields without any variants. It's zero based so in order for it to be taken into account, its value must be equal to or bigger than 0. Note: To ensure the expected sorting behavior, the index property should have a unique value.

Default value is -1.

getKey

Gets current value of property key.

The key property corresponds to the field name 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 filter field in the SmartFilterBar.

getMandatory

Gets current value of property mandatory.

Property can be used to overwrite the mandatory state of a filter field. Property can only be set during initialization. Changes at runtime will be ignored.

Default value is 'auto'.

sap.ui.comp.smartfilterbar.ControlConfiguration.getMetadata

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

getPreventInitialDataFetchInValueHelpDialog

Gets current value of property preventInitialDataFetchInValueHelpDialog.

In case there are value help annotations for this filter field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

Default value is false.

getVisible

Gets current value of property visible.

Using this flag it is possible to hide fields from the OData metadata.

Default value is true.

getVisibleInAdvancedArea

Gets current value of property visibleInAdvancedArea.

If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default.

Default value is false.

getWidth

Gets current value of property width.

The width of the filter field in a CSS compatible format. The width can be set only once during initialization. Changes at runtime will not be reflected. The width will not be applied to custom controls.

indexOfDefaultFilterValue

Checks for the provided sap.ui.comp.smartfilterbar.SelectOption in the aggregation defaultFilterValues. and returns its index if found or -1 otherwise.

insertDefaultFilterValue

Inserts a defaultFilterValue into the aggregation defaultFilterValues.

removeAllDefaultFilterValues

Removes all the controls from the aggregation defaultFilterValues.

Additionally, it unregisters them from the hosting UIArea.

removeDefaultFilterValue

Removes a defaultFilterValue from the aggregation defaultFilterValues.

setConditionType

Sets a new value for property conditionType.

The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type

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

setControlType

Sets a new value for property controlType.

The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata.

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

Default value is 'auto'.

setCustomControl

Sets the aggregated customControl.

setDisplayBehaviour

Sets a new value for property displayBehaviour.

The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly for Combobox (DropDown text) , Description and ID for MultiInput (token text)

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

Default value is 'auto'.

setFilterType

Sets a new value for property filterType.

The filter type specifies whether the filter field is of type single value, multi-value, or interval. The filter type is calculated by the sap.ui.comp.smartfilterbar.SmartFilterBar control based on the OData metadata. Using this property the filter type can be configured manually.

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

Default value is 'auto'.

setGroupId

Sets a new value for property groupId.

The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName from the OData metadata. It is also possible to move a field from the advanced area to the basic area by specifying the groupId _BASIC.

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

setHasTypeAhead

Sets a new value for property hasTypeAhead.

Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g it does not work for DrodDownListbox

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

Default value is true.

setHasValueHelpDialog

Sets a new value for property hasValueHelpDialog.

Specifies whether a value help dialog is available or not.

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

Default value is true.

setHistoryEnabled

Sets a new value for property historyEnabled.

If set to false history values are disabled.

Note: For sap.m.ComboBox and sap.m.MultiComboBox the history values are disabled by default. To enable them for these controls, you need to set the historyEnabled property to true.

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

Default value is true.

setIndex

Sets a new value for property index.

The index property specifies the initial order of fields without any variants. It's zero based so in order for it to be taken into account, its value must be equal to or bigger than 0. Note: To ensure the expected sorting behavior, the index property should have a unique value.

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

Default value is -1.

setKey

Sets a new value for property key.

The key property corresponds to the field name 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 filter field in the SmartFilterBar.

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

setMandatory

Sets a new value for property mandatory.

Property can be used to overwrite the mandatory state of a filter field. Property can only be set during initialization. Changes at runtime will be ignored.

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

Default value is 'auto'.

setPreventInitialDataFetchInValueHelpDialog

Sets a new value for property preventInitialDataFetchInValueHelpDialog.

In case there are value help annotations for this filter field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

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

Default value is false.

setVisible

Sets a new value for property visible.

Using this flag it is possible to hide fields from the OData metadata.

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

Default value is true.

setVisibleInAdvancedArea

Sets a new value for property visibleInAdvancedArea.

If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default.

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

Default value is false.

setWidth

Sets a new value for property width.

The width of the filter field in a CSS compatible format. The width can be set only once during initialization. Changes at runtime will not be reflected. The width will not be applied to custom controls.

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

addDefaultFilterValue

Adds some defaultFilterValue to the aggregation defaultFilterValues.

Param Type DefaultValue Description
oDefaultFilterValue sap.ui.comp.smartfilterbar.SelectOption

The defaultFilterValue to add; if empty, nothing is inserted

attachChange

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

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.ControlConfiguration itself.

Fired when the value of a property, for example isVisible, 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.ControlConfiguration itself

destroyCustomControl

Destroys the customControl in the aggregation customControl.

destroyDefaultFilterValues

Destroys all the defaultFilterValues in the aggregation defaultFilterValues.

detachChange

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

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.ControlConfiguration.extend

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

getConditionType

Gets current value of property conditionType.

The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type

getControlType

Gets current value of property controlType.

The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata.

Default value is 'auto'.

getCustomControl

Gets content of aggregation customControl.

If a custom control is specified, the SmartFilterBar will not create a control but use the custom control. Additional services like TypeAhead have to implemented manually.

getDefaultFilterValues

Gets content of aggregation defaultFilterValues.

Default value for a filter field. The aggregation expects sap.ui.comp.smartfilterbar.SelectOption|SelectOption instances, where the values' format (properties low and high) match the type of the referneced property and consider also the given constraints of the property.

Samples for valid formats: Edm.DateTime with constraint sap:display-format='Date': "2018-12-24" (you optionally can provide a time-part and timezone, too, (2018-12-24T00:00:00Z) but this is ignored)

Edm.DateTimeOffset: "2018-12-24T13:55:59Z"

Edm.Time: "PT12H34M56S"

Edm.Boolean: "false"

Edm.Decimal: "2983.12"

getDisplayBehaviour

Gets current value of property displayBehaviour.

The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly for Combobox (DropDown text) , Description and ID for MultiInput (token text)

Default value is 'auto'.

getFilterType

Gets current value of property filterType.

The filter type specifies whether the filter field is of type single value, multi-value, or interval. The filter type is calculated by the sap.ui.comp.smartfilterbar.SmartFilterBar control based on the OData metadata. Using this property the filter type can be configured manually.

Default value is 'auto'.

getGroupId

Gets current value of property groupId.

The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName from the OData metadata. It is also possible to move a field from the advanced area to the basic area by specifying the groupId _BASIC.

getHasTypeAhead

Gets current value of property hasTypeAhead.

Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g it does not work for DrodDownListbox

Default value is true.

getHasValueHelpDialog

Gets current value of property hasValueHelpDialog.

Specifies whether a value help dialog is available or not.

Default value is true.

getHistoryEnabled

Gets current value of property historyEnabled.

If set to false history values are disabled.

Note: For sap.m.ComboBox and sap.m.MultiComboBox the history values are disabled by default. To enable them for these controls, you need to set the historyEnabled property to true.

Default value is true.

getIndex

Gets current value of property index.

The index property specifies the initial order of fields without any variants. It's zero based so in order for it to be taken into account, its value must be equal to or bigger than 0. Note: To ensure the expected sorting behavior, the index property should have a unique value.

Default value is -1.

getKey

Gets current value of property key.

The key property corresponds to the field name 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 filter field in the SmartFilterBar.

getMandatory

Gets current value of property mandatory.

Property can be used to overwrite the mandatory state of a filter field. Property can only be set during initialization. Changes at runtime will be ignored.

Default value is 'auto'.

sap.ui.comp.smartfilterbar.ControlConfiguration.getMetadata

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

getPreventInitialDataFetchInValueHelpDialog

Gets current value of property preventInitialDataFetchInValueHelpDialog.

In case there are value help annotations for this filter field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

Default value is false.

getVisible

Gets current value of property visible.

Using this flag it is possible to hide fields from the OData metadata.

Default value is true.

getVisibleInAdvancedArea

Gets current value of property visibleInAdvancedArea.

If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default.

Default value is false.

getWidth

Gets current value of property width.

The width of the filter field in a CSS compatible format. The width can be set only once during initialization. Changes at runtime will not be reflected. The width will not be applied to custom controls.

indexOfDefaultFilterValue

Checks for the provided sap.ui.comp.smartfilterbar.SelectOption in the aggregation defaultFilterValues. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oDefaultFilterValue sap.ui.comp.smartfilterbar.SelectOption

The defaultFilterValue whose index is looked for

insertDefaultFilterValue

Inserts a defaultFilterValue into the aggregation defaultFilterValues.

Param Type DefaultValue Description
oDefaultFilterValue sap.ui.comp.smartfilterbar.SelectOption

The defaultFilterValue to insert; if empty, nothing is inserted

iIndex int

The 0-based index the defaultFilterValue should be inserted at; for a negative value of iIndex, the defaultFilterValue is inserted at position 0; for a value greater than the current size of the aggregation, the defaultFilterValue is inserted at the last position

removeAllDefaultFilterValues

Removes all the controls from the aggregation defaultFilterValues.

Additionally, it unregisters them from the hosting UIArea.

removeDefaultFilterValue

Removes a defaultFilterValue from the aggregation defaultFilterValues.

Param Type DefaultValue Description
vDefaultFilterValue int string sap.ui.comp.smartfilterbar.SelectOption

The defaultFilterValue to remove or its index or id

setConditionType

Sets a new value for property conditionType.

The condition Type class name to use for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type

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

Param Type DefaultValue Description
oConditionType any

New value for property conditionType

setControlType

Sets a new value for property controlType.

The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata.

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

Default value is 'auto'.

Param Type DefaultValue Description
sControlType sap.ui.comp.smartfilterbar.ControlType 'auto'

New value for property controlType

setCustomControl

Sets the aggregated customControl.

Param Type DefaultValue Description
oCustomControl sap.ui.core.Control

The customControl to set

setDisplayBehaviour

Sets a new value for property displayBehaviour.

The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly for Combobox (DropDown text) , Description and ID for MultiInput (token text)

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

Default value is 'auto'.

Param Type DefaultValue Description
sDisplayBehaviour sap.ui.comp.smartfilterbar.DisplayBehaviour 'auto'

New value for property displayBehaviour

setFilterType

Sets a new value for property filterType.

The filter type specifies whether the filter field is of type single value, multi-value, or interval. The filter type is calculated by the sap.ui.comp.smartfilterbar.SmartFilterBar control based on the OData metadata. Using this property the filter type can be configured manually.

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

Default value is 'auto'.

Param Type DefaultValue Description
sFilterType sap.ui.comp.smartfilterbar.FilterType 'auto'

New value for property filterType

setGroupId

Sets a new value for property groupId.

The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName from the OData metadata. It is also possible to move a field from the advanced area to the basic area by specifying the groupId _BASIC.

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

Param Type DefaultValue Description
sGroupId string

New value for property groupId

setHasTypeAhead

Sets a new value for property hasTypeAhead.

Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g it does not work for DrodDownListbox

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

New value for property hasTypeAhead

setHasValueHelpDialog

Sets a new value for property hasValueHelpDialog.

Specifies whether a value help dialog is available or not.

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

New value for property hasValueHelpDialog

setHistoryEnabled

Sets a new value for property historyEnabled.

If set to false history values are disabled.

Note: For sap.m.ComboBox and sap.m.MultiComboBox the history values are disabled by default. To enable them for these controls, you need to set the historyEnabled property to true.

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

New value for property historyEnabled

setIndex

Sets a new value for property index.

The index property specifies the initial order of fields without any variants. It's zero based so in order for it to be taken into account, its value must be equal to or bigger than 0. Note: To ensure the expected sorting behavior, the index property should have a unique value.

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

Default value is -1.

Param Type DefaultValue Description
iIndex int -1

New value for property index

setKey

Sets a new value for property key.

The key property corresponds to the field name 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 filter field in the SmartFilterBar.

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

Param Type DefaultValue Description
sLabel string

New value for property label

setMandatory

Sets a new value for property mandatory.

Property can be used to overwrite the mandatory state of a filter field. Property can only be set during initialization. Changes at runtime will be ignored.

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

Default value is 'auto'.

Param Type DefaultValue Description
sMandatory sap.ui.comp.smartfilterbar.MandatoryType 'auto'

New value for property mandatory

setPreventInitialDataFetchInValueHelpDialog

Sets a new value for property preventInitialDataFetchInValueHelpDialog.

In case there are value help annotations for this filter field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

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

Default value is false.

Param Type DefaultValue Description
bPreventInitialDataFetchInValueHelpDialog boolean false

New value for property preventInitialDataFetchInValueHelpDialog

setVisible

Sets a new value for property visible.

Using this flag it is possible to hide fields from the OData metadata.

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

New value for property visible

setVisibleInAdvancedArea

Sets a new value for property visibleInAdvancedArea.

If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default.

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

Default value is false.

Param Type DefaultValue Description
bVisibleInAdvancedArea boolean false

New value for property visibleInAdvancedArea

setWidth

Sets a new value for property width.

The width of the filter field in a CSS compatible format. The width can be set only once during initialization. Changes at runtime will not be reflected. The width will not be applied to custom controls.

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

Param Type DefaultValue Description
sWidth string

New value for property width