Class sap.m.GroupHeaderListItemModule: sap/m/GroupHeaderListItem

extends ListItemBase

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.


Since: 1.12.
Constructor Summary
new sap.m.GroupHeaderListItem(sId?, mSettings?)Constructor for a new GroupHeaderListItem.
Fields borrowed from class sap.m.ListItemBase
isSelected
Events borrowed from class sap.m.ListItemBase
detailPress, detailTap, press, tap
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.GroupHeaderListItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.GroupHeaderListItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.GroupHeaderListItem.getMetadata()Returns a metadata object for class sap.m.GroupHeaderListItem.
getCount()Gets current value of property count.
getTitle()Gets current value of property title.
getTitleTextDirection()Gets current value of property titleTextDirection.
getUpperCase()Gets current value of property upperCase.
setCount(sCount)Sets a new value for property count.
setTitle(sTitle)Sets a new value for property title.
setTitleTextDirection(sTitleTextDirection)Sets a new value for property titleTextDirection.
setUpperCase(bUpperCase)Sets a new value for property upperCase.
Methods borrowed from class sap.m.ListItemBase
addAriaLabelledBy, attachDetailPress, attachDetailTap, attachPress, attachTap, detachDetailPress, detachDetailTap, detachPress, detachTap, fireDetailPress, fireDetailTap, firePress, fireTap, getAriaLabelledBy, getCounter, getSelected, getTabbables, getType, getUnread, getVisible, removeAllAriaLabelledBy, removeAriaLabelledBy, setCounter, setSelected, setType, setUnread, setVisible
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.GroupHeaderListItem(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.m.ListItemBase can be used as well.

Parameters:
{string}sId? Id for the new control, generated automatically if no id is given
{object}mSettings? Initial settings for the new control
Method Detail
sap.m.GroupHeaderListItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.GroupHeaderListItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.GroupHeaderListItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getCount(): string
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:
{string} Value of property count
getTitle(): string
Gets current value of property title.

Defines the title of the group header.

Returns:
{string} Value of property title
getTitleTextDirection(): sap.ui.core.TextDirection
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.

Since:
1.28.0
Returns:
{sap.ui.core.TextDirection} Value of property titleTextDirection
getUpperCase(): boolean
Gets current value of property upperCase.

By default, the title is capitalized automatically. To disable this automation, set this property to false.

Default value is true.

Since:
1.13.2
Returns:
{boolean} Value of property upperCase
setCount(sCount): sap.m.GroupHeaderListItem
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.

Parameters:
{string}sCount New value for property count
Returns:
{sap.m.GroupHeaderListItem} Reference to this in order to allow method chaining
setTitle(sTitle): sap.m.GroupHeaderListItem
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.

Parameters:
{string}sTitle New value for property title
Returns:
{sap.m.GroupHeaderListItem} Reference to this in order to allow method chaining
setTitleTextDirection(sTitleTextDirection): sap.m.GroupHeaderListItem
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.

Parameters:
{sap.ui.core.TextDirection}sTitleTextDirection New value for property titleTextDirection
Since:
1.28.0
Returns:
{sap.m.GroupHeaderListItem} Reference to this in order to allow method chaining
setUpperCase(bUpperCase): sap.m.GroupHeaderListItem
Sets a new value for property upperCase.

By default, the title is capitalized automatically. To disable this automation, set this property to false.

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

Default value is true.

Parameters:
{boolean}bUpperCase New value for property upperCase
Since:
1.13.2
Returns:
{sap.m.GroupHeaderListItem} Reference to this in order to allow method chaining