Class sap.ui.table.RowModule: sap/ui/table/Row

extends Element

The row.

Constructor Summary
new sap.ui.table.Row(sId?, mSettings?)Constructor for a new Row.
Method Summary
sap.ui.table.Row.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.table.Row with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.table.Row.getMetadata()Returns a metadata object for class sap.ui.table.Row.
addCell(oCell)Adds some cell to the aggregation cells.
destroyCells()Destroys all the cells in the aggregation cells.
getCells()Gets content of aggregation cells.
getIndex()Returns the index of the row in the table or -1 if not added to a table.
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.
Constructor Detail
new sap.ui.table.Row(sId?, mSettings?)
Constructor for a new Row.

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:

  • Aggregations
    • cells : sap.ui.core.Control[] (default)

In addition, all settings applicable to the base type sap.ui.core.Element 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.ui.table.Row.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.table.Row 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.Element.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.ui.table.Row.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.table.Row.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addCell(oCell): sap.ui.table.Row
Adds some cell to the aggregation cells.
Parameters:
{sap.ui.core.Control}oCell the cell to add; if empty, nothing is inserted
Returns:
{sap.ui.table.Row} Reference to this in order to allow method chaining
destroyCells(): sap.ui.table.Row
Destroys all the cells in the aggregation cells.
Returns:
{sap.ui.table.Row} Reference to this in order to allow method chaining
getCells(): sap.ui.core.Control[]
Gets content of aggregation cells.

The controls for the cells.

Returns:
{sap.ui.core.Control[]}
getIndex(): int
Returns the index of the row in the table or -1 if not added to a table. This function considers the scroll position of the table and also takes fixed rows and fixed bottom rows into account.
Returns:
{int} index of the row (considers scroll position and fixed rows)
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.ui.table.Row
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.ui.table.Row} 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