Class sap.m.CustomListItemModule: sap/m/CustomListItem

extends ListItemBase
known direct subclasses: CustomerControlListItem

This control with a content aggregation can be used to customize standard list items that we don't provide. List mode and ListItem type are applied to CustomListItems as well. Note: Even though the content aggregation allows any control, complex responsive layout controls (e.g. Table, Form) should not be aggregated as content.

Constructor Summary
new sap.m.CustomListItem(sId?, mSettings?)Constructor for a new CustomListItem.
Fields borrowed from class sap.m.ListItemBase
Events borrowed from class sap.m.ListItemBase
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.CustomListItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.CustomListItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.CustomListItem.getMetadata()Returns a metadata object for class sap.m.CustomListItem.
addContent(oContent)Adds some content to the aggregation content.
bindContent(oBindingInfo)Binds aggregation content to model data.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
unbindContent()Unbinds aggregation content from model data.
Constructor Detail
new sap.m.CustomListItem(sId?, mSettings?)
Constructor for a new CustomListItem.

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:

  • Aggregations
    • content : sap.ui.core.Control[] (default)

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.CustomListItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.CustomListItem 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.CustomListItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.CustomListItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.m.CustomListItem
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.m.CustomListItem} Reference to this in order to allow method chaining
bindContent(oBindingInfo): sap.m.CustomListItem
Binds aggregation content to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Returns:
{sap.m.CustomListItem} Reference to this in order to allow method chaining
destroyContent(): sap.m.CustomListItem
Destroys all the content in the aggregation content.
Returns:
{sap.m.CustomListItem} Reference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

The content of this list item

Returns:
{sap.ui.core.Control[]}
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.m.CustomListItem
Inserts a content into the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
{sap.m.CustomListItem} Reference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.core.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
unbindContent(): sap.m.CustomListItem
Unbinds aggregation content from model data.
Returns:
{sap.m.CustomListItem} Reference to this in order to allow method chaining