class sap.m.ColumnListItem

Control sample: sap.m.ColumnListItem
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/ColumnListItem
Application Component: CA-UI5-TBL

sap.m.ColumnListItem can be used with the cells aggregation to create rows for the sap.m.Table control. The columns aggregation of the sap.m.Table should match with the cells aggregation.

Note: This control should only be used within the sap.m.Table control. The inherited counter property of sap.m.ListItemBase is not supported.


Constructor

Constructor for a new ColumnListItem.

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.m.ColumnListItem(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
vAlign sap.ui.core.VerticalAlign Inherit

Sets the vertical alignment of all the cells within the table row (including selection and navigation). Note: vAlign property of sap.m.Column overrides the property for cell vertical alignment if both are set.

Since: 1.20.

Visibility: public

Borrowed Properties

Name Type Default Value Description
counter int

Defines the counter value of the list items.

Visibility: public
highlight string None

Defines the highlight state of the list items.

Valid values for the highlight property are values of the enumerations sap.ui.core.MessageType or sap.ui.core.IndicationColor.

Accessibility support is provided through the associated highlightText property. If the highlight property is set to a value of sap.ui.core.MessageType, the highlightText property does not need to be set because a default text is used. However, the default text can be overridden by setting the highlightText property. In all other cases the highlightText property must be set.

Since: 1.44.0.

Visibility: public
highlightText string empty string

Defines the semantics of the highlight property for accessibility purposes.

Since: 1.62.

Visibility: public
navigated boolean false

The navigated state of the list item.

If set to true, a navigation indicator is displayed at the end of the list item. Note: This property must be set for one list item only.

Since: 1.72.

Visibility: public
selected boolean false

Defines the selected state of the list items. Note: Binding the selected property in single selection modes may cause unwanted results if you have more than one selected items in your binding.

Visibility: public
type sap.m.ListType Inactive

Defines the visual indication and behavior of the list items, e.g. Active, Navigation, Detail.

Visibility: public
unread boolean false

Activates the unread indicator for the list item, if set to true. Note: This flag is ignored when the showUnread property of the parent is set to false.

Visibility: public
visible boolean true

Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control.

Visibility: public

Aggregations

Default Aggregation: cells

Name Cardinality Type Description
cells (default) 0..n sap.ui.core.Control

Every control inside the cells aggregation defines one cell of the row. Note: The order of the cells aggregation must match the order of the columns aggregation of sap.m.Table.


Methods Overview

Method Description
$Popin

Returns pop-in DOMRef as a jQuery Object

addCell

Adds some cell to the aggregation cells.

bindCells

Binds aggregation cells to model data.

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

destroyCells

Destroys all the cells in the aggregation cells.

sap.m.ColumnListItem.extend

Creates a new subclass of class sap.m.ColumnListItem 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.

getCells

Gets content of aggregation cells.

Every control inside the cells aggregation defines one cell of the row. Note: The order of the cells aggregation must match the order of the columns aggregation of sap.m.Table.

sap.m.ColumnListItem.getMetadata

Returns a metadata object for class sap.m.ColumnListItem.

getPopin

Returns the pop-in element.

getTabbables

Returns the tabbable DOM elements as a jQuery collection When popin is available this separated dom should also be included

getVAlign

Gets current value of property vAlign.

Sets the vertical alignment of all the cells within the table row (including selection and navigation). Note: vAlign property of sap.m.Column overrides the property for cell vertical alignment if both are set.

Default value is Inherit.

hasPopin

Determines whether control has pop-in or not.

indexOfCell

Checks for the provided sap.ui.core.Control in the aggregation cells. and returns its index if found or -1 otherwise.

insertCell

Inserts a cell into the aggregation cells.

removeAllCells

Removes all the controls from the aggregation cells.

Additionally, it unregisters them from the hosting UIArea.

removeCell

Removes a cell from the aggregation cells.

removePopin

Pemove pop-in from DOM

setVAlign

Sets a new value for property vAlign.

Sets the vertical alignment of all the cells within the table row (including selection and navigation). Note: vAlign property of sap.m.Column overrides the property for cell vertical alignment if both are set.

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

Default value is Inherit.

unbindCells

Unbinds aggregation cells from model data.

$Popin

Returns pop-in DOMRef as a jQuery Object

addCell

Adds some cell to the aggregation cells.

Param Type DefaultValue Description
oCell sap.ui.core.Control

The cell to add; if empty, nothing is inserted

bindCells

Binds aggregation cells to model data.

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

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyCells

Destroys all the cells in the aggregation cells.

sap.m.ColumnListItem.extend

Creates a new subclass of class sap.m.ColumnListItem 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.

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

getCells

Gets content of aggregation cells.

Every control inside the cells aggregation defines one cell of the row. Note: The order of the cells aggregation must match the order of the columns aggregation of sap.m.Table.

sap.m.ColumnListItem.getMetadata

Returns a metadata object for class sap.m.ColumnListItem.

getPopin

Returns the pop-in element.

getTabbables

Returns the tabbable DOM elements as a jQuery collection When popin is available this separated dom should also be included

getVAlign

Gets current value of property vAlign.

Sets the vertical alignment of all the cells within the table row (including selection and navigation). Note: vAlign property of sap.m.Column overrides the property for cell vertical alignment if both are set.

Default value is Inherit.

hasPopin

Determines whether control has pop-in or not.

indexOfCell

Checks for the provided sap.ui.core.Control in the aggregation cells. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oCell sap.ui.core.Control

The cell whose index is looked for

insertCell

Inserts a cell into the aggregation cells.

Param Type DefaultValue Description
oCell sap.ui.core.Control

The cell to insert; if empty, nothing is inserted

iIndex int

The 0-based index the cell should be inserted at; for a negative value of iIndex, the cell is inserted at position 0; for a value greater than the current size of the aggregation, the cell is inserted at the last position

removeAllCells

Removes all the controls from the aggregation cells.

Additionally, it unregisters them from the hosting UIArea.

removeCell

Removes a cell from the aggregation cells.

Param Type DefaultValue Description
vCell int string sap.ui.core.Control

The cell to remove or its index or id

removePopin

Pemove pop-in from DOM

setVAlign

Sets a new value for property vAlign.

Sets the vertical alignment of all the cells within the table row (including selection and navigation). Note: vAlign property of sap.m.Column overrides the property for cell vertical alignment if both are set.

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

Default value is Inherit.

Param Type DefaultValue Description
sVAlign sap.ui.core.VerticalAlign Inherit

New value for property vAlign

unbindCells

Unbinds aggregation cells from model data.