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.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.layout.BlockLayoutRow(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 |
Name | Type | Default Value | Description |
---|---|---|---|
rowColorSet | sap.ui.layout.BlockRowColorSets | Defines background type for that row. There might be several rows with the same type |
|
scrollable | boolean | false | 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. Visibility: public |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
content (default) | 0..n | sap.ui.layout.BlockLayoutCell |
The content cells to be included in the row. |
Name | Cardinality | Type | Description |
---|---|---|---|
accentCells | 0..n | sap.ui.layout.BlockLayoutCell |
Cells that would be accented. *Note:* This association has visual impact only for BlockLayouts with background types "Mixed" and "Accent". Mixed: In this type, areas of 25% (on desktop) can have a dark background color. Per section one area can be dark. Accent: Every section can contain multiple gray blocks, which are used alternately, beginning with the bright one |
Method | Description |
---|---|
addAccentCell |
Adds some accentCell into the association accentCells. |
addContent |
Adds some content to the aggregation content. |
destroyContent |
Destroys all the content in the aggregation content. |
sap.ui.layout.BlockLayoutRow.extend |
Creates a new subclass of class sap.ui.layout.BlockLayoutRow with name
|
getAccentCells |
Returns array of IDs of the elements which are the current targets of the association accentCells. |
getContent |
Gets content of aggregation content. The content cells to be included in the row. |
sap.ui.layout.BlockLayoutRow.getMetadata |
Returns a metadata object for class sap.ui.layout.BlockLayoutRow. |
getRowColorSet |
Gets current value of property rowColorSet. Defines background type for that row. There might be several rows with the same type |
getScrollable |
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 |
indexOfContent |
Checks for the provided |
insertContent |
Inserts a content into the aggregation content. |
removeAccentCell |
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. Additionally, it unregisters them from the hosting UIArea. |
removeContent |
Removes a content from the aggregation content. |
setRowColorSet |
Changes dynamically row color set Note: this might invalidate cells inside and also change color sets of the other BlockLayoutRow-s below it. |
setScrollable |
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 Default value is |
Adds some accentCell into the association accentCells.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAccentCell | sap.ui.core.ID sap.ui.layout.BlockLayoutCell |
The accentCells to add; if empty, nothing is inserted |
Adds some content to the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.layout.BlockLayoutCell |
The content to add; if empty, nothing is inserted |
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.
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 |
Returns array of IDs of the elements which are the current targets of the association accentCells.
Returns a metadata object for class sap.ui.layout.BlockLayoutRow.
Gets current value of property rowColorSet.
Defines background type for that row. There might be several rows with the same type
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
.
Checks for the provided sap.ui.layout.BlockLayoutCell
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.layout.BlockLayoutCell |
The content whose index is looked for |
Inserts a content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.layout.BlockLayoutCell |
The content to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes an accentCell from the association named accentCells.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAccentCell | int sap.ui.core.ID sap.ui.layout.BlockLayoutCell |
The accentCell to be removed or its index or ID |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.layout.BlockLayoutCell |
The content to remove or its index or id |
Changes dynamically row color set Note: this might invalidate cells inside and also change color sets of the other BlockLayoutRow-s below it.
Param | Type | DefaultValue | Description |
---|---|---|---|
sType | sap.ui.layout.BlockRowColorSets |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bScrollable | boolean | false |
New value for property |