Class sap.m.ColumnListItemModule: sap/m/ColumnListItem

extends ListItemBase
known direct subclasses: EditableVariantItem

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.


Since: 1.12.
Constructor Summary
new sap.m.ColumnListItem(sId?, mSettings?)Constructor for a new ColumnListItem.
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.ColumnListItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ColumnListItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ColumnListItem.getMetadata()Returns a metadata object for class sap.m.ColumnListItem.
$Popin()Returns pop-in DOMRef as a jQuery Object
addCell(oCell)Adds some cell to the aggregation cells.
bindCells(oBindingInfo)Binds aggregation cells to model data.
destroyCells()Destroys all the cells in the aggregation cells.
getCells()Gets content of aggregation cells.
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.
hasPopin()Determines whether control has pop-in or not.
indexOfCell(oCell)Checks for the provided sap.ui.core.Control in the aggregation cells.
insertCell(oCell, iIndex)Inserts a cell into the aggregation cells.
removeAllCells()Removes all the controls from the aggregation cells.
removeCell(vCell)Removes a cell from the aggregation cells.
removePopin()Pemove pop-in from DOM
setVAlign(sVAlign)Sets a new value for property vAlign.
unbindCells()Unbinds aggregation cells from model data.
Methods borrowed from class sap.m.ListItemBase
addAriaLabelledBy, attachDetailPress, attachDetailTap, attachPress, attachTap, detachDetailPress, detachDetailTap, detachPress, detachTap, fireDetailPress, fireDetailTap, firePress, fireTap, getAriaLabelledBy, getCounter, getSelected, 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.ColumnListItem(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • vAlign : sap.ui.core.VerticalAlign (default: Inherit)
  • Aggregations
    • cells : 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.ColumnListItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.ColumnListItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ColumnListItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
$Popin()
Returns pop-in DOMRef as a jQuery Object
Since:
1.26
addCell(oCell): sap.m.ColumnListItem
Adds some cell to the aggregation cells.
Parameters:
{sap.ui.core.Control}oCell the cell to add; if empty, nothing is inserted
Returns:
{sap.m.ColumnListItem} Reference to this in order to allow method chaining
bindCells(oBindingInfo): sap.m.ColumnListItem
Binds aggregation cells 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.ColumnListItem} Reference to this in order to allow method chaining
destroyCells(): sap.m.ColumnListItem
Destroys all the cells in the aggregation cells.
Returns:
{sap.m.ColumnListItem} Reference to this in order to allow method chaining
getCells(): sap.ui.core.Control[]
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.

Returns:
{sap.ui.core.Control[]}
getPopin()
Returns the pop-in element.
Since:
1.30.9
getTabbables(): jQuery
Returns the tabbable DOM elements as a jQuery collection When popin is available this separated dom should also be included
Since:
1.26
Returns:
{jQuery} jQuery object
getVAlign(): sap.ui.core.VerticalAlign
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.

Since:
1.20
Returns:
{sap.ui.core.VerticalAlign} Value of property vAlign
hasPopin()
Determines whether control has pop-in or not.
indexOfCell(oCell): int
Checks for the provided sap.ui.core.Control in the aggregation cells. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oCell The cell whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertCell(oCell, iIndex): sap.m.ColumnListItem
Inserts a cell into the aggregation cells.
Parameters:
{sap.ui.core.Control}oCell the cell to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.m.ColumnListItem} Reference to this in order to allow method chaining
removeAllCells(): sap.ui.core.Control[]
Removes all the controls from the aggregation cells.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeCell(vCell): sap.ui.core.Control
Removes a cell from the aggregation cells.
Parameters:
{int|string|sap.ui.core.Control}vCell The cellto remove or its index or id
Returns:
{sap.ui.core.Control} The removed cell or null
removePopin()
Pemove pop-in from DOM
setVAlign(sVAlign): sap.m.ColumnListItem
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.

Parameters:
{sap.ui.core.VerticalAlign}sVAlign New value for property vAlign
Since:
1.20
Returns:
{sap.m.ColumnListItem} Reference to this in order to allow method chaining
unbindCells(): sap.m.ColumnListItem
Unbinds aggregation cells from model data.
Returns:
{sap.m.ColumnListItem} Reference to this in order to allow method chaining