class sap.m.P13nFilterItem

Control sample: sap.m.P13nFilterItem
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/P13nFilterItem
Application Component: CA-UI5-CTR

Type for filterItems aggregation in P13nFilterPanel control.


Constructor

Constructor for a new P13nFilterItem.

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.m.P13nFilterItem(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
columnKey string

key of the column

Visibility: public
exclude boolean false

defines if the filter is an include or exclude filter item

Visibility: public
operation string

sap.m.P13nConditionOperation

Visibility: public
value1 string

value of the filter

Visibility: public
value2 string

to value of the between filter

Visibility: public

Methods Overview

Method Description
sap.m.P13nFilterItem.extend

Creates a new subclass of class sap.m.P13nFilterItem 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.Item.extend.

getColumnKey

Gets current value of property columnKey.

key of the column

getExclude

Gets current value of property exclude.

defines if the filter is an include or exclude filter item

Default value is false.

sap.m.P13nFilterItem.getMetadata

Returns a metadata object for class sap.m.P13nFilterItem.

getOperation

Gets current value of property operation.

sap.m.P13nConditionOperation

getValue1

Gets current value of property value1.

value of the filter

getValue2

Gets current value of property value2.

to value of the between filter

setColumnKey

Sets a new value for property columnKey.

key of the column

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

setExclude

Sets a new value for property exclude.

defines if the filter is an include or exclude filter item

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

Default value is false.

setOperation

Sets a new value for property operation.

sap.m.P13nConditionOperation

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

setValue1

Sets a new value for property value1.

value of the filter

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

setValue2

Sets a new value for property value2.

to value of the between filter

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

sap.m.P13nFilterItem.extend

Creates a new subclass of class sap.m.P13nFilterItem 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.Item.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

getColumnKey

Gets current value of property columnKey.

key of the column

getExclude

Gets current value of property exclude.

defines if the filter is an include or exclude filter item

Default value is false.

sap.m.P13nFilterItem.getMetadata

Returns a metadata object for class sap.m.P13nFilterItem.

getOperation

Gets current value of property operation.

sap.m.P13nConditionOperation

getValue1

Gets current value of property value1.

value of the filter

getValue2

Gets current value of property value2.

to value of the between filter

setColumnKey

Sets a new value for property columnKey.

key of the column

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

Param Type DefaultValue Description
sColumnKey string

New value for property columnKey

setExclude

Sets a new value for property exclude.

defines if the filter is an include or exclude filter item

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
bExclude boolean false

New value for property exclude

setOperation

Sets a new value for property operation.

sap.m.P13nConditionOperation

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

Param Type DefaultValue Description
sOperation string

New value for property operation

setValue1

Sets a new value for property value1.

value of the filter

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

Param Type DefaultValue Description
sValue1 string

New value for property value1

setValue2

Sets a new value for property value2.

to value of the between filter

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

Param Type DefaultValue Description
sValue2 string

New value for property value2