class sap.ui.comp.filterbar.FilterGroupItem

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

Represents a filter belonging to a group other than basic.


Constructor

Constructor for a new FilterBar/FilterGroupItem.

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.filterbar.FilterGroupItem(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
groupName string

Name of the group.

Visibility: public
groupTitle string

Title of the group.

Visibility: public
visibleInAdvancedArea boolean false

If set to true, this filter is visible on the filter bar by default. Mapped against the visibleInFilterBar property.

Since: 1.24.0.

Visibility: public

Borrowed Properties

Name Type Default Value Description
controlTooltip string

Tooltip for the filter'c control.

Since: 1.52.0.

Visibility: public
entitySetName string

EntitySet name to which the filter belongs

Since: 1.58.0.

Visibility: public
entityTypeName string

EntityType name to which the filter belongs

Since: 1.58.0.

Visibility: public
hiddenFilter boolean false

A hidden filter will never be visible in the filter bar control

Since: 1.44.0.

Visibility: public
label string

Label of the filter.

Visibility: public
labelTooltip string

Tooltip for the filter.

Visibility: public
mandatory boolean false

Mandatory flag.

Visibility: public
name string

Name of the filter. This is an identifier for the filter and has to be unique.

Visibility: public
partOfCurrentVariant boolean true

Determines if a filter is part of the currently selected variant.
Note: This property can also be changed using the visibleInFilterBar property and by user interaction in the Select Filters dialog or the variant handling.

Since: 1.26.1.

Visibility: public
visible boolean true

Visibility state of the filter.

Visibility: public
visibleInFilterBar boolean true

Controls the visibility of a filter item in the filter bar.

Since: 1.26.1.

Visibility: public

Borrowed Aggregations

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

The control of the filter.


Methods Overview

Method Description
destroy

Destroys this element.

sap.ui.comp.filterbar.FilterGroupItem.extend

Creates a new subclass of class sap.ui.comp.filterbar.FilterGroupItem 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.comp.filterbar.FilterItem.extend.

getGroupName

Gets current value of property groupName.

Name of the group.

getGroupTitle

Gets current value of property groupTitle.

Title of the group.

sap.ui.comp.filterbar.FilterGroupItem.getMetadata

Returns a metadata object for class sap.ui.comp.filterbar.FilterGroupItem.

setGroupName

Sets a new value for property groupName.

Name of the group.

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

setGroupTitle

Setter for group title.

destroy

Destroys this element.

sap.ui.comp.filterbar.FilterGroupItem.extend

Creates a new subclass of class sap.ui.comp.filterbar.FilterGroupItem 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.comp.filterbar.FilterItem.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

getGroupName

Gets current value of property groupName.

Name of the group.

getGroupTitle

Gets current value of property groupTitle.

Title of the group.

sap.ui.comp.filterbar.FilterGroupItem.getMetadata

Returns a metadata object for class sap.ui.comp.filterbar.FilterGroupItem.

setGroupName

Sets a new value for property groupName.

Name of the group.

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

Param Type DefaultValue Description
sGroupName string

New value for property groupName

setGroupTitle

Setter for group title.

Param Type DefaultValue Description
sValue string

Group title