class sap.ui.comp.smartfilterbar.SelectOption

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

A Select Option can be used to specify default filter values for a control configuration of the SmartFilterBar.


Constructor

Constructor for a new smartfilterbar/SelectOption.

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.SelectOption(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
high string

The high value for a select option. The high value is only required for a few operators, e.g. BT (between).

Visibility: public
low string

The low value for a select option.

Visibility: public
operator sap.ui.model.FilterOperator EQ

The operator for a select option. The default value is EQ "for equals".

Visibility: public
sign sap.ui.comp.smartfilterbar.SelectOptionSign I

The sign for a Select Option. Possible values are I for include or E for exclude.

Visibility: public

Methods Overview

Method Description
sap.ui.comp.smartfilterbar.SelectOption.extend

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

getHigh

Gets current value of property high.

The high value for a select option. The high value is only required for a few operators, e.g. BT (between).

getLow

Gets current value of property low.

The low value for a select option.

sap.ui.comp.smartfilterbar.SelectOption.getMetadata

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

getOperator

Gets current value of property operator.

The operator for a select option. The default value is EQ "for equals".

Default value is 'EQ'.

getSign

Gets current value of property sign.

The sign for a Select Option. Possible values are I for include or E for exclude.

Default value is 'I'.

setHigh

Sets a new value for property high.

The high value for a select option. The high value is only required for a few operators, e.g. BT (between).

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

setLow

Sets a new value for property low.

The low value for a select option.

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

setOperator

Sets a new value for property operator.

The operator for a select option. The default value is EQ "for equals".

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

Default value is 'EQ'.

setSign

Sets a new value for property sign.

The sign for a Select Option. Possible values are I for include or E for exclude.

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

Default value is 'I'.

sap.ui.comp.smartfilterbar.SelectOption.extend

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

getHigh

Gets current value of property high.

The high value for a select option. The high value is only required for a few operators, e.g. BT (between).

getLow

Gets current value of property low.

The low value for a select option.

sap.ui.comp.smartfilterbar.SelectOption.getMetadata

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

getOperator

Gets current value of property operator.

The operator for a select option. The default value is EQ "for equals".

Default value is 'EQ'.

getSign

Gets current value of property sign.

The sign for a Select Option. Possible values are I for include or E for exclude.

Default value is 'I'.

setHigh

Sets a new value for property high.

The high value for a select option. The high value is only required for a few operators, e.g. BT (between).

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

Param Type DefaultValue Description
sHigh string

New value for property high

setLow

Sets a new value for property low.

The low value for a select option.

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

Param Type DefaultValue Description
sLow string

New value for property low

setOperator

Sets a new value for property operator.

The operator for a select option. The default value is EQ "for equals".

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

Default value is 'EQ'.

Param Type DefaultValue Description
sOperator sap.ui.model.FilterOperator 'EQ'

New value for property operator

setSign

Sets a new value for property sign.

The sign for a Select Option. Possible values are I for include or E for exclude.

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

Default value is 'I'.

Param Type DefaultValue Description
sSign sap.ui.comp.smartfilterbar.SelectOptionSign 'I'

New value for property sign