Class sap.ui.layout.BlockLayoutRowModule: sap/ui/layout/BlockLayoutRow

extends Control

The BlockLayoutRow is used as an aggregation to the BlockLayout. It aggregates Block Layout cells. The BlockLayoutRow has 2 rendering modes - scrollable and non scrollable.
Since: 1.34.
Constructor Summary
new sap.ui.layout.BlockLayoutRow(sId?, mSettings?)Constructor for a new BlockLayoutRow.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.layout.BlockLayoutRow.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.BlockLayoutRow with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.BlockLayoutRow.getMetadata()Returns a metadata object for class sap.ui.layout.BlockLayoutRow.
addAccentCell(vAccentCell)Adds some accentCell into the association accentCells.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getAccentCells()Returns array of IDs of the elements which are the current targets of the association accentCells.
getContent()Gets content of aggregation content.
getRowColorSet()Gets current value of property rowColorSet.
getScrollable()Gets current value of property scrollable.
indexOfContent(oContent)Checks for the provided sap.ui.layout.BlockLayoutCell in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAccentCell(vAccentCell)Removes an accentCell from the association named accentCells.
removeAllAccentCells()Removes all the controls in the association named accentCells.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setRowColorSet(sType)Changes dynamically row's color set Note: this might invalidate cells inside and also change color sets of the other BlockLayoutRow-s below it.
setScrollable(bScrollable)Sets a new value for property scrollable.
Constructor Detail
new sap.ui.layout.BlockLayoutRow(sId?, mSettings?)

Constructor for a new BlockLayoutRow.

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

  • Aggregations

    • content : sap.ui.layout.BlockLayoutCell[] (default)

  • Associations

    • accentCells : (sap.ui.core.ID | sap.ui.layout.BlockLayoutCell)[]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Method Detail
sap.ui.layout.BlockLayoutRow.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.layout.BlockLayoutRow 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.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.layout.BlockLayoutRow.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.BlockLayoutRow.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAccentCell(vAccentCell): sap.ui.layout.BlockLayoutRow
Adds some accentCell into the association accentCells.
Parameters:
sap.ui.core.ID|sap.ui.layout.BlockLayoutCellvAccentCellthe accentCells to add; if empty, nothing is inserted
Returns:
sap.ui.layout.BlockLayoutRowReference to this in order to allow method chaining
Since:
1.42
addContent(oContent): sap.ui.layout.BlockLayoutRow
Adds some content to the aggregation content.
Parameters:
sap.ui.layout.BlockLayoutCelloContentthe content to add; if empty, nothing is inserted
Returns:
sap.ui.layout.BlockLayoutRowReference to this in order to allow method chaining
destroyContent(): sap.ui.layout.BlockLayoutRow
Destroys all the content in the aggregation content.
Returns:
sap.ui.layout.BlockLayoutRowReference to this in order to allow method chaining
getAccentCells(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association accentCells.
Returns:
sap.ui.core.ID[]
Since:
1.42

Gets content of aggregation content.

The content cells to be included in the row.

Returns:
sap.ui.layout.BlockLayoutCell[]

Gets current value of property rowColorSet.

Defines background type for that row. There might be several rows with the same type

Returns:
sap.ui.layout.BlockRowColorSetsValue of property rowColorSet
Since:
1.42
getScrollable(): boolean

Gets current value of property scrollable.

Sets the rendering mode of the BlockLayoutRow to scrollable. In scrollable mode, the cells get aligned side by side, with horizontal scroll bar for the row.

Default value is false.

Returns:
booleanValue of property scrollable
indexOfContent(oContent): int
Checks for the provided sap.ui.layout.BlockLayoutCell in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.layout.BlockLayoutCelloContentThe content whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.layout.BlockLayoutRow
Inserts a content into the aggregation content.
Parameters:
sap.ui.layout.BlockLayoutCelloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
sap.ui.layout.BlockLayoutRowReference to this in order to allow method chaining
removeAccentCell(vAccentCell): sap.ui.core.ID
Removes an accentCell from the association named accentCells.
Parameters:
int|sap.ui.core.ID|sap.ui.layout.BlockLayoutCellvAccentCellThe accentCell to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed accentCell or null
Since:
1.42
removeAllAccentCells(): sap.ui.core.ID[]
Removes all the controls in the association named accentCells.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
Since:
1.42
removeAllContent(): sap.ui.layout.BlockLayoutCell[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.layout.BlockLayoutCell[]An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.layout.BlockLayoutCell
Removes a content from the aggregation content.
Parameters:
int|string|sap.ui.layout.BlockLayoutCellvContentThe content to remove or its index or id
Returns:
sap.ui.layout.BlockLayoutCellThe removed content or null
setRowColorSet(sType): sap.ui.layout.BlockLayoutRow
Changes dynamically row's color set Note: this might invalidate cells inside and also change color sets of the other BlockLayoutRow-s below it.
Parameters:
sap.ui.layout.BlockRowColorSetssType
Returns:
sap.ui.layout.BlockLayoutRow
Since:
1.42
setScrollable(bScrollable): sap.ui.layout.BlockLayoutRow

Sets a new value for property scrollable.

Sets the rendering mode of the BlockLayoutRow to scrollable. In scrollable mode, the cells get aligned side by side, with horizontal scroll bar for the row.

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

Default value is false.

Parameters:
booleanbScrollableNew value for property scrollable
Returns:
sap.ui.layout.BlockLayoutRowReference to this in order to allow method chaining