Class sap.m.ActionListItemModule: sap/m/ActionListItem

extends ListItemBase

The sap.m.ActionListItem can be used like a button to fire actions when pressed. Note: The inherited selected property of the sap.m.ListItemBase is not supported.

Constructor Summary
new sap.m.ActionListItem(sId?, mSettings?)Constructor for a new ActionListItem.
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.ActionListItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ActionListItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ActionListItem.getMetadata()Returns a metadata object for class sap.m.ActionListItem.
getMode()Determines item specific mode

ActionListItems are not selectable because they are command controls (like Button or Link) so triggering the associated command, rather than selection is appropriate to happen upon user action on these items.

getText()Gets current value of property text.
setText(sText)Sets a new value for property text.
Constructor Detail
new sap.m.ActionListItem(sId?, mSettings?)
Constructor for a new ActionListItem.

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:

  • Properties

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.ActionListItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.ActionListItem 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.ActionListItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ActionListItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getMode()
Determines item specific mode

ActionListItems are not selectable because they are command controls (like Button or Link) so triggering the associated command, rather than selection is appropriate to happen upon user action on these items. By overwriting isSelectable (inherited from ListItemBase) we exclude the item from processing specific to selectable list-items.

getText(): string
Gets current value of property text.

Defines the text that appears in the control.

Returns:
{string} Value of property text
setText(sText): sap.m.ActionListItem
Sets a new value for property text.

Defines the text that appears in the control.

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

Parameters:
{string}sText New value for property text
Returns:
{sap.m.ActionListItem} Reference to this in order to allow method chaining