class sap.ui.core.ListItem

Control sample: sap.ui.core.ListItem
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/ListItem
Application Component: CA-UI5-COR

An item that is used in list controls, such as DropdownBox.

The element foresees the usage of additional texts displayed in a second column.


Constructor

Constructor for a new ListItem.

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.core.ListItem(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
additionalText string

Some additional text of type string, optionally to be displayed along with this item.

Visibility: public
icon string

The icon belonging to this list item instance. This can be a URI to an image or an icon font URI.

Visibility: public

Borrowed Properties

Name Type Default Value Description
enabled boolean true

Enabled items can be selected.

Visibility: public
key string

Can be used as input for subsequent actions.

Visibility: public
text string empty string

The text to be displayed for the item.

Visibility: public
textDirection sap.ui.core.TextDirection Inherit

Options are RTL and LTR. Alternatively, an item can inherit its text direction from its parent control.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
customData 0..n sap.ui.core.CustomData

Custom Data, a data structure like a map containing arbitrary key value pairs.

dependents 0..n sap.ui.core.Element

Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating Element.

Since: 1.19.

dragDropConfig 0..n sap.ui.core.dnd.DragDropBase

Defines the drag-and-drop configuration. Note: This configuration might be ignored due to control metadata restrictions.

Since: 1.56.

layoutData 0..1 sap.ui.core.LayoutData

Defines the layout constraints for this control when it is used inside a Layout. LayoutData classes are typed classes and must match the embedding Layout. See VariantLayoutData for aggregating multiple alternative LayoutData instances to a single Element.

tooltip 0..1 sap.ui.core.TooltipBase

The tooltip that should be shown for this Element.

In the most simple case, a tooltip is a string that will be rendered by the control and displayed by the browser when the mouse pointer hovers over the control's DOM. In this variant, tooltip behaves like a simple control property.

Controls need to explicitly support this kind of tooltip as they have to render it, but most controls do. Exceptions will be documented for the corresponding controls (e.g. sap.ui.core.HTML does not support tooltips).

Alternatively, tooltip can act like a 0..1 aggregation and can be set to a tooltip control (an instance of a subclass of sap.ui.core.TooltipBase). In that case, the framework will take care of rendering the tooltip control in a popup-like manner. Such a tooltip control can display arbitrary content, not only a string.

UI5 currently does not provide a recommended implementation of TooltipBase as the use of content-rich tooltips is discouraged by the Fiori Design Guidelines. Existing subclasses of TooltipBase therefore have been deprecated. However, apps can still subclass from TooltipBase and create their own implementation when needed (potentially taking the deprecated implementations as a starting point).

See the section Using Tooltips in the Fiori Design Guideline.


Methods Overview

Method Description
sap.ui.core.ListItem.extend

Creates a new subclass of class sap.ui.core.ListItem 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.core.Item.extend.

getAdditionalText

Gets current value of property additionalText.

Some additional text of type string, optionally to be displayed along with this item.

getIcon

Gets current value of property icon.

The icon belonging to this list item instance. This can be a URI to an image or an icon font URI.

sap.ui.core.ListItem.getMetadata

Returns a metadata object for class sap.ui.core.ListItem.

setAdditionalText

Sets a new value for property additionalText.

Some additional text of type string, optionally to be displayed along with this item.

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

setIcon

Sets a new value for property icon.

The icon belonging to this list item instance. This can be a URI to an image or an icon font URI.

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

sap.ui.core.ListItem.extend

Creates a new subclass of class sap.ui.core.ListItem 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.core.Item.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

getAdditionalText

Gets current value of property additionalText.

Some additional text of type string, optionally to be displayed along with this item.

getIcon

Gets current value of property icon.

The icon belonging to this list item instance. This can be a URI to an image or an icon font URI.

sap.ui.core.ListItem.getMetadata

Returns a metadata object for class sap.ui.core.ListItem.

setAdditionalText

Sets a new value for property additionalText.

Some additional text of type string, optionally to be displayed along with this item.

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

Param Type DefaultValue Description
sAdditionalText string

New value for property additionalText

setIcon

Sets a new value for property icon.

The icon belonging to this list item instance. This can be a URI to an image or an icon font URI.

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

Param Type DefaultValue Description
sIcon string

New value for property icon