Class sap.m.StandardListItemModule: sap/m/StandardListItem

extends ListItemBase
known direct subclasses: LegendItem

sap.m.StandardListItem is a list item providing the most common use cases, e.g. image, title and description.

Constructor Summary
new sap.m.StandardListItem(sId?, mSettings?)Constructor for a new StandardListItem.
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.StandardListItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.StandardListItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.StandardListItem.getMetadata()Returns a metadata object for class sap.m.StandardListItem.
getActiveIcon()Gets current value of property activeIcon.
getAdaptTitleSize()Gets current value of property adaptTitleSize.
getDescription()Gets current value of property description.
getIcon()Gets current value of property icon.
getIconDensityAware()Gets current value of property iconDensityAware.
getIconInset()Gets current value of property iconInset.
getInfo()Gets current value of property info.
getInfoState()Gets current value of property infoState.
getInfoTextDirection()Gets current value of property infoTextDirection.
getTitle()Gets current value of property title.
getTitleTextDirection()Gets current value of property titleTextDirection.
setActiveIcon(sActiveIcon)Sets a new value for property activeIcon.
setAdaptTitleSize(bAdaptTitleSize)Sets a new value for property adaptTitleSize.
setDescription(sDescription)Sets a new value for property description.
setIcon(sIcon)Sets a new value for property icon.
setIconDensityAware(bIconDensityAware)Sets a new value for property iconDensityAware.
setIconInset(bIconInset)Sets a new value for property iconInset.
setInfo(sInfo)Sets a new value for property info.
setInfoState(sInfoState)Sets a new value for property infoState.
setInfoTextDirection(sInfoTextDirection)Sets a new value for property infoTextDirection.
setTitle(sTitle)Sets a new value for property title.
setTitleTextDirection(sTitleTextDirection)Sets a new value for property titleTextDirection.
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.StandardListItem(sId?, mSettings?)
Constructor for a new StandardListItem.

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.StandardListItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.StandardListItem 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.StandardListItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.StandardListItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getActiveIcon(): sap.ui.core.URI
Gets current value of property activeIcon.

Defines the icon that is shown while the list item is pressed.

Returns:
{sap.ui.core.URI} Value of property activeIcon
getAdaptTitleSize(): boolean
Gets current value of property adaptTitleSize.

By default, the title size adapts to the available space and gets bigger if the description is empty. If you have list items with and without descriptions, this results in titles with different sizes. In this case, it can be better to switch the size adaption off by setting this property to false.

Default value is true.

Since:
1.16.3
Returns:
{boolean} Value of property adaptTitleSize
getDescription(): string
Gets current value of property description.

Defines the additional information for the title. Note: This is only visible when the title property is not empty.

Returns:
{string} Value of property description
getIcon(): sap.ui.core.URI
Gets current value of property icon.

Defines the list item icon.

Returns:
{sap.ui.core.URI} Value of property icon
getIconDensityAware(): boolean
Gets current value of property iconDensityAware.

By default, one or more requests are sent to get the density perfect version of the icon if the given version of the icon doesn't exist on the server. Note: If bandwidth is a key factor for the application, set this value to false.

Default value is true.

Returns:
{boolean} Value of property iconDensityAware
getIconInset(): boolean
Gets current value of property iconInset.

Defines the indentation of the icon. If set to false, the icon will not be shown as embedded. Instead it will take the full height of the list item.

Default value is true.

Returns:
{boolean} Value of property iconInset
getInfo(): string
Gets current value of property info.

Defines an additional information text.

Returns:
{string} Value of property info
getInfoState(): sap.ui.core.ValueState
Gets current value of property infoState.

Defines the state of the information text, e.g. Error, Warning, Success.

Default value is None.

Returns:
{sap.ui.core.ValueState} Value of property infoState
getInfoTextDirection(): sap.ui.core.TextDirection
Gets current value of property infoTextDirection.

Defines the info 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 infoTextDirection
getTitle(): string
Gets current value of property title.

Defines the title of the list item.

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
setActiveIcon(sActiveIcon): sap.m.StandardListItem
Sets a new value for property activeIcon.

Defines the icon that is shown while the list item is pressed.

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

Parameters:
{sap.ui.core.URI}sActiveIcon New value for property activeIcon
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setAdaptTitleSize(bAdaptTitleSize): sap.m.StandardListItem
Sets a new value for property adaptTitleSize.

By default, the title size adapts to the available space and gets bigger if the description is empty. If you have list items with and without descriptions, this results in titles with different sizes. In this case, it can be better to switch the size adaption off by setting 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}bAdaptTitleSize New value for property adaptTitleSize
Since:
1.16.3
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setDescription(sDescription): sap.m.StandardListItem
Sets a new value for property description.

Defines the additional information for the title. Note: This is only visible when the title property is not empty.

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

Parameters:
{string}sDescription New value for property description
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setIcon(sIcon): sap.m.StandardListItem
Sets a new value for property icon.

Defines the list item icon.

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

Parameters:
{sap.ui.core.URI}sIcon New value for property icon
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setIconDensityAware(bIconDensityAware): sap.m.StandardListItem
Sets a new value for property iconDensityAware.

By default, one or more requests are sent to get the density perfect version of the icon if the given version of the icon doesn't exist on the server. Note: If bandwidth is a key factor for the application, set this value 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}bIconDensityAware New value for property iconDensityAware
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setIconInset(bIconInset): sap.m.StandardListItem
Sets a new value for property iconInset.

Defines the indentation of the icon. If set to false, the icon will not be shown as embedded. Instead it will take the full height of the list item.

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

Default value is true.

Parameters:
{boolean}bIconInset New value for property iconInset
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setInfo(sInfo): sap.m.StandardListItem
Sets a new value for property info.

Defines an additional information text.

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

Parameters:
{string}sInfo New value for property info
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setInfoState(sInfoState): sap.m.StandardListItem
Sets a new value for property infoState.

Defines the state of the information text, e.g. Error, Warning, Success.

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

Default value is None.

Parameters:
{sap.ui.core.ValueState}sInfoState New value for property infoState
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setInfoTextDirection(sInfoTextDirection): sap.m.StandardListItem
Sets a new value for property infoTextDirection.

Defines the info 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}sInfoTextDirection New value for property infoTextDirection
Since:
1.28.0
Returns:
{sap.m.StandardListItem} Reference to this in order to allow method chaining
setTitle(sTitle): sap.m.StandardListItem
Sets a new value for property title.

Defines the title of the list item.

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.StandardListItem} Reference to this in order to allow method chaining
setTitleTextDirection(sTitleTextDirection): sap.m.StandardListItem
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.StandardListItem} Reference to this in order to allow method chaining