class sap.m.ViewSettingsCustomItem

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

The ViewSettingsCustomItem control is used for modelling custom filters in the ViewSettingsDialog.


Constructor

Constructor for a new ViewSettingsCustomItem.

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.ViewSettingsCustomItem(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
filterCount int 0

The number of currently active filters for this custom filter item. It will be displayed in the filter list of the ViewSettingsDialog to represent the filter state of the custom control.

Visibility: public

Borrowed Properties

Name Type Default Value Description
selected boolean false

Selected state of the item. If set to "true", the item will be displayed as selected in the view settings dialog.

Visibility: public

Aggregations

Default Aggregation:

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

A custom control for the filter field. It can be used for complex filtering mechanisms.


Methods Overview

Method Description
clone

Creates a clone of the ViewSettingsCustomItem instance.

destroyCustomControl

Destroys the customControl in the aggregation customControl.

sap.m.ViewSettingsCustomItem.extend

Creates a new subclass of class sap.m.ViewSettingsCustomItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ViewSettingsItem.extend.

getCustomControl

Internally the control is handled as a managed object instead of an aggregation because this control is sometimes aggregated in other controls like a popover or a dialog.

getFilterCount

Gets current value of property filterCount.

The number of currently active filters for this custom filter item. It will be displayed in the filter list of the ViewSettingsDialog to represent the filter state of the custom control.

Default value is 0.

sap.m.ViewSettingsCustomItem.getMetadata

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

setCustomControl

Internally the control is handled as a managed object instead of an aggregation as this control is sometimes aggregated in other controls like a popover or a dialog.

setFilterCount

Sets the filterCount without invalidating the control as it is never rendered directly.

clone

Creates a clone of the ViewSettingsCustomItem instance.

Param Type DefaultValue Description
sIdSuffix string

a suffix to be appended to the cloned object id

aLocalIds string[]

an array of local IDs within the cloned hierarchy (internally used)

oOptions object

configuration object

destroyCustomControl

Destroys the customControl in the aggregation customControl.

sap.m.ViewSettingsCustomItem.extend

Creates a new subclass of class sap.m.ViewSettingsCustomItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ViewSettingsItem.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

getCustomControl

Internally the control is handled as a managed object instead of an aggregation because this control is sometimes aggregated in other controls like a popover or a dialog.

getFilterCount

Gets current value of property filterCount.

The number of currently active filters for this custom filter item. It will be displayed in the filter list of the ViewSettingsDialog to represent the filter state of the custom control.

Default value is 0.

sap.m.ViewSettingsCustomItem.getMetadata

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

setCustomControl

Internally the control is handled as a managed object instead of an aggregation as this control is sometimes aggregated in other controls like a popover or a dialog.

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

A control used for filtering purposes

setFilterCount

Sets the filterCount without invalidating the control as it is never rendered directly.

Param Type DefaultValue Description
iValue int

The new value for property filterCount