sap.m.GroupHeaderListItem
is used to display the title of a group and act as separator between groups in sap.m.List
and sap.m.Table
. Note: The inherited properties unread
, selected
, counter
and press
event from sap.m.ListItemBase
are not supported.
Constructor for a new GroupHeaderListItem.
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.GroupHeaderListItem(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 |
Name | Type | Default Value | Description |
---|---|---|---|
count | string | Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group. Note: Will not be displayed if not set. Visibility: public |
|
title | string | Defines the title of the group header. Visibility: public |
|
titleTextDirection | sap.ui.core.TextDirection | Inherit | Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM. |
upperCase | boolean | false | Allows to uppercase the group title. |
Name | Type | Default Value | Description |
---|---|---|---|
counter | int | Defines the counter value of the list items. Visibility: public |
|
highlight | string | None | Defines the highlight state of the list items. Valid values for the Accessibility support is provided through the associated highlightText property. If the |
highlightText | string | empty string | Defines the semantics of the highlight property for accessibility purposes. |
navigated | boolean | false | The navigated state of the list item. If set to |
selected | boolean | false | Defines the selected state of the list items. Note: Binding the |
type | sap.m.ListType | Inactive | Defines the visual indication and behavior of the list items, e.g. |
unread | boolean | false | Activates the unread indicator for the list item, if set to |
visible | boolean | true | Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control. Visibility: public |
Method | Description |
---|---|
sap.m.GroupHeaderListItem.extend |
Creates a new subclass of class sap.m.GroupHeaderListItem with name
|
getCount |
Gets current value of property count. Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group. Note: Will not be displayed if not set. |
sap.m.GroupHeaderListItem.getMetadata |
Returns a metadata object for class sap.m.GroupHeaderListItem. |
getTitle |
Gets current value of property title. Defines the title of the group header. |
getTitleTextDirection |
Gets current value of property titleTextDirection. Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM. Default value is |
getUpperCase |
Gets current value of property upperCase. Allows to uppercase the group title. Default value is |
setCount |
Sets a new value for property count. Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group. Note: Will not be displayed if not set. When called with a value of |
setTitle |
Sets a new value for property title. Defines the title of the group header. When called with a value of |
setTitleTextDirection |
Sets a new value for property titleTextDirection. Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM. When called with a value of Default value is |
setUpperCase |
Sets a new value for property upperCase. Allows to uppercase the group title. When called with a value of Default value is |
Creates a new subclass of class sap.m.GroupHeaderListItem 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.ListItemBase.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 |
Gets current value of property count.
Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group. Note: Will not be displayed if not set.
Returns a metadata object for class sap.m.GroupHeaderListItem.
Gets current value of property titleTextDirection.
Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.
Default value is Inherit
.
Gets current value of property upperCase.
Allows to uppercase the group title.
Default value is false
.
Sets a new value for property count.
Defines the count of items in the group, but it could also be an amount which represents the sum of all amounts in the group. Note: Will not be displayed if not set.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sCount | string |
New value for property |
Sets a new value for property title.
Defines the title of the group header.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
New value for property |
Sets a new value for property titleTextDirection.
Defines the title text directionality with enumerated options. By default, the control inherits text direction from the DOM.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Inherit
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleTextDirection | sap.ui.core.TextDirection | Inherit |
New value for property |
Sets a new value for property upperCase.
Allows to uppercase the group title.
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 |
---|---|---|---|
bUpperCase | boolean | false |
New value for property |