class sap.ui.layout.BlockLayoutCell

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/layout/BlockLayoutCell
Application Component: CA-UI5-CTR

The BlockLayoutCell is used as an aggregation of the BlockLayoutRow. It contains Controls. The BlockLayoutCell should be used only as aggregation of the BlockLayoutRow.


Constructor

Constructor for a new BlockLayoutCell.

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.BlockLayoutCell(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
backgroundColorSet sap.ui.layout.BlockLayoutCellColorSet

The Background color set from which the background color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorSet should be used only in combination with backgroundColorShade.

Since: 1.48.

Visibility: public
backgroundColorShade sap.ui.layout.BlockLayoutCellColorShade

The index of the background color in the color set from which the color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorShade should be used only in combination with backgroundColorSet.

Since: 1.48.

Visibility: public
title string

Defines the title of the cell. Note: When the titleLink aggregation is provided, the title of the cell will be replaced with the text from the titleLink.

Visibility: public
titleAlignment sap.ui.core.HorizontalAlign Begin

Defines the alignment of the cell title

Visibility: public
titleLevel sap.ui.core.TitleLevel Auto

Defines the aria level of the title This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.

Visibility: public
width int 0

Defines the width of the cell. Depending on the context of the cell - whether it's in scrollable, or non scrollable row, this property is interpreted in two different ways. If the cell is placed inside a scrollable row - this property defines the width of the cell in percentages. If no value is provided - the default is 40%. If the cell is placed inside a non scrollable row - this property defines the grow factor of the cell compared to the whole row. For example: If you have 2 cells, each with width of 1, this means that they should be of equal size, and they need to fill the whole row. This results in 50% width for each cell. If you have 2 cells, one with width of 1, the other with width of 3, this means that the whole row width is 4, so the first cell will have a width of 25%, the second - 75%. According to the visual guidelines, it is suggested that you only use 25%, 50%, 75% or 100% cells in you applications. For example, 12,5% width is not desirable (1 cell with width 1, and another with width 7)

Visibility: public

Aggregations

Default Aggregation: content

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

The content to be included inside the cell


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

destroyContent

Destroys all the content in the aggregation content.

destroyTitleLink

Destroys the titleLink in the aggregation titleLink.

sap.ui.layout.BlockLayoutCell.extend

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

getBackgroundColorSet

Gets current value of property backgroundColorSet.

The Background color set from which the background color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorSet should be used only in combination with backgroundColorShade.

getBackgroundColorShade

Gets current value of property backgroundColorShade.

The index of the background color in the color set from which the color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorShade should be used only in combination with backgroundColorSet.

getContent

Gets content of aggregation content.

The content to be included inside the cell

sap.ui.layout.BlockLayoutCell.getMetadata

Returns a metadata object for class sap.ui.layout.BlockLayoutCell.

getTitle

Gets current value of property title.

Defines the title of the cell. Note: When the titleLink aggregation is provided, the title of the cell will be replaced with the text from the titleLink.

getTitleAlignment

Gets current value of property titleAlignment.

Defines the alignment of the cell title

Default value is "Begin".

getTitleLevel

Gets current value of property titleLevel.

Defines the aria level of the title This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.

Default value is "Auto".

getTitleLink

Gets content of aggregation titleLink.

The link that will replace the title of the cell. Note: The only possible value is the sap.m.Link control.

getWidth

Gets current value of property width.

Defines the width of the cell. Depending on the context of the cell - whether it's in scrollable, or non scrollable row, this property is interpreted in two different ways. If the cell is placed inside a scrollable row - this property defines the width of the cell in percentages. If no value is provided - the default is 40%. If the cell is placed inside a non scrollable row - this property defines the grow factor of the cell compared to the whole row. For example: If you have 2 cells, each with width of 1, this means that they should be of equal size, and they need to fill the whole row. This results in 50% width for each cell. If you have 2 cells, one with width of 1, the other with width of 3, this means that the whole row width is 4, so the first cell will have a width of 25%, the second - 75%. According to the visual guidelines, it is suggested that you only use 25%, 50%, 75% or 100% cells in you applications. For example, 12,5% width is not desirable (1 cell with width 1, and another with width 7)

Default value is 0.

indexOfContent

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

insertContent

Inserts a content into the aggregation content.

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.

setBackgroundColorSet

Sets a new value for property backgroundColorSet.

The Background color set from which the background color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorSet should be used only in combination with backgroundColorShade.

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

setBackgroundColorShade

Sets a new value for property backgroundColorShade.

The index of the background color in the color set from which the color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorShade should be used only in combination with backgroundColorSet.

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

setTitle

Sets a new value for property title.

Defines the title of the cell. Note: When the titleLink aggregation is provided, the title of the cell will be replaced with the text from the titleLink.

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

setTitleAlignment

Sets a new value for property titleAlignment.

Defines the alignment of the cell title

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

Default value is "Begin".

setTitleLevel

Sets a new value for property titleLevel.

Defines the aria level of the title This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.

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

Default value is "Auto".

setTitleLink

Sets the aggregated titleLink.

setWidth

Sets the Width.

addContent

Adds some content to the aggregation content.

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

The content to add; if empty, nothing is inserted

destroyContent

Destroys all the content in the aggregation content.

sap.ui.layout.BlockLayoutCell.extend

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

getBackgroundColorSet

Gets current value of property backgroundColorSet.

The Background color set from which the background color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorSet should be used only in combination with backgroundColorShade.

getBackgroundColorShade

Gets current value of property backgroundColorShade.

The index of the background color in the color set from which the color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorShade should be used only in combination with backgroundColorSet.

getContent

Gets content of aggregation content.

The content to be included inside the cell

sap.ui.layout.BlockLayoutCell.getMetadata

Returns a metadata object for class sap.ui.layout.BlockLayoutCell.

getTitle

Gets current value of property title.

Defines the title of the cell. Note: When the titleLink aggregation is provided, the title of the cell will be replaced with the text from the titleLink.

getTitleAlignment

Gets current value of property titleAlignment.

Defines the alignment of the cell title

Default value is "Begin".

getTitleLevel

Gets current value of property titleLevel.

Defines the aria level of the title This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.

Default value is "Auto".

getWidth

Gets current value of property width.

Defines the width of the cell. Depending on the context of the cell - whether it's in scrollable, or non scrollable row, this property is interpreted in two different ways. If the cell is placed inside a scrollable row - this property defines the width of the cell in percentages. If no value is provided - the default is 40%. If the cell is placed inside a non scrollable row - this property defines the grow factor of the cell compared to the whole row. For example: If you have 2 cells, each with width of 1, this means that they should be of equal size, and they need to fill the whole row. This results in 50% width for each cell. If you have 2 cells, one with width of 1, the other with width of 3, this means that the whole row width is 4, so the first cell will have a width of 25%, the second - 75%. According to the visual guidelines, it is suggested that you only use 25%, 50%, 75% or 100% cells in you applications. For example, 12,5% width is not desirable (1 cell with width 1, and another with width 7)

Default value is 0.

indexOfContent

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

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

The content whose index is looked for

insertContent

Inserts a content into the aggregation content.

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

The content to insert; if empty, nothing is inserted

iIndex int

The 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

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.

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

The content to remove or its index or id

setBackgroundColorSet

Sets a new value for property backgroundColorSet.

The Background color set from which the background color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorSet should be used only in combination with backgroundColorShade.

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

Param Type DefaultValue Description
sBackgroundColorSet sap.ui.layout.BlockLayoutCellColorSet

New value for property backgroundColorSet

setBackgroundColorShade

Sets a new value for property backgroundColorShade.

The index of the background color in the color set from which the color will be selected. By using background colors from the predefined sets your colors could later be customized from the Theme Designer. Note: backgroundColorShade should be used only in combination with backgroundColorSet.

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

Param Type DefaultValue Description
sBackgroundColorShade sap.ui.layout.BlockLayoutCellColorShade

New value for property backgroundColorShade

setTitle

Sets a new value for property title.

Defines the title of the cell. Note: When the titleLink aggregation is provided, the title of the cell will be replaced with the text from the titleLink.

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

Param Type DefaultValue Description
sTitle string

New value for property title

setTitleAlignment

Sets a new value for property titleAlignment.

Defines the alignment of the cell title

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

Default value is "Begin".

Param Type DefaultValue Description
sTitleAlignment sap.ui.core.HorizontalAlign "Begin"

New value for property titleAlignment

setTitleLevel

Sets a new value for property titleLevel.

Defines the aria level of the title This information is e.g. used by assistive technologies like screenreaders to create a hierarchical site map for faster navigation.

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

Default value is "Auto".

Param Type DefaultValue Description
sTitleLevel sap.ui.core.TitleLevel "Auto"

New value for property titleLevel

setWidth

Sets the Width.

Param Type DefaultValue Description
iWidth number

value.