abstract class sap.ui.table.rowmodes.RowMode

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/table/rowmodes/RowMode
Application Component: CA-UI5-TBL

TODO: Class description


Constructor

Constructor for a new row mode.

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.

This class does not have its own settings, but all settings applicable to the base type sap.ui.core.Element can be used.

new sap.ui.table.rowmodes.RowMode(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


Methods Overview

Method Description
computeStandardizedRowCounts

Computes standardized row counts. - The fixed row counts are reduced to fit into the row count. First the number of fixed bottom rows and, if that is not enough, the number of fixed top rows is reduced. - Makes sure there is at least one scrollable row between fixed rows. - Takes the row count constraints into account.

References:

  • #getRowCountConstraints

disableNoData

Disables the "NoData" text of the table. The table will no longer show this text, even if its property showNoData is set to true. The text is hidden if it is currently shown. Has no effect for the text that is shown when the table has no visible columns.

enableNoData

Enables the "NoData" text of the table. Whether the text is shown depends on the state of the table and its showNoData property.

sap.ui.table.rowmodes.RowMode.extend

Creates a new subclass of class sap.ui.table.rowmodes.RowMode 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.

getBaseRowContentHeight

Gets the base row content height of this mode. This number is a pixel value and affects the base row height of the table. Returns 0 if this mode does not support setting the row content height.

References:

getBaseRowHeightOfTable

Gets the base row height of the table. This number is a pixel value and serves as the base for layout and row count calculations. The table considers the base row content height of this mode. If the base row content height is 0, the table applies a default row content height. Returns 0 if this mode is not child of a table.

References:

getComputedRowCounts

Gets the computed row counts. The computed count can differ from the configured count and is the leading number when it comes to managing the rows aggregation of the table and rendering the rows. The sum of scrollable, fixedTop and fixedBottom is equal to count.

sap.ui.table.rowmodes.RowMode.getMetadata

Returns a metadata object for class sap.ui.table.rowmodes.RowMode.

getMinRequestLength

Gets the number of contexts that should be requested at least from the rows aggregation binding of the table.

getRowContainerStyles

Gets the CSS styles that are applied to the DOM container of the rows.

getRowCountConstraints

Gets the constraints on the row counts in the table. These are soft constraints and the subclass may ignore them, for example if it does not support fixed rows.

Description of the constraints:

  • fixedTop: The value true means that there should be exactly one fixed top row and false means that fixed top rows should be disabled. By default, there are no constraint for the fixed top rows.
  • fixedBottom: The value true means that there should be exactly one fixed bottom row and false means that fixed bottom rows should be disabled. By default, there are no constraint for the fixed bottom rows.

getTable

Gets the parent table.

getTableBottomPlaceholderStyles

Gets the CSS styles that are applied to the table's bottom placeholder DOM element. This element can be used to visually reserve space for rows. If undefined is returned during rendering, this element will not be rendered.

getTableStyles

Gets the CSS styles that are applied to the table's DOM root element.

getTotalRowCountOfTable

Gets total row count of the table. Returns 0 if this mode is not child of a table.

isNoDataDisabled

Checks whether the "NoData" text of the table is disabled.

updateTable

Updates the table's rows aggregation according to the current computed row count, and updates the rows binding contexts.

computeStandardizedRowCounts

Computes standardized row counts. - The fixed row counts are reduced to fit into the row count. First the number of fixed bottom rows and, if that is not enough, the number of fixed top rows is reduced. - Makes sure there is at least one scrollable row between fixed rows. - Takes the row count constraints into account.

References:

Param Type DefaultValue Description
iCount int

The row count.

iFixedTop int

The fixed top row count.

iFixedBottom int

The fixed bottom row count.

disableNoData

Disables the "NoData" text of the table. The table will no longer show this text, even if its property showNoData is set to true. The text is hidden if it is currently shown. Has no effect for the text that is shown when the table has no visible columns.

enableNoData

Enables the "NoData" text of the table. Whether the text is shown depends on the state of the table and its showNoData property.

sap.ui.table.rowmodes.RowMode.extend

Creates a new subclass of class sap.ui.table.rowmodes.RowMode 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.

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

getBaseRowContentHeight

Gets the base row content height of this mode. This number is a pixel value and affects the base row height of the table. Returns 0 if this mode does not support setting the row content height.

References:

getBaseRowHeightOfTable

Gets the base row height of the table. This number is a pixel value and serves as the base for layout and row count calculations. The table considers the base row content height of this mode. If the base row content height is 0, the table applies a default row content height. Returns 0 if this mode is not child of a table.

References:

getComputedRowCounts

Gets the computed row counts. The computed count can differ from the configured count and is the leading number when it comes to managing the rows aggregation of the table and rendering the rows. The sum of scrollable, fixedTop and fixedBottom is equal to count.

sap.ui.table.rowmodes.RowMode.getMetadata

Returns a metadata object for class sap.ui.table.rowmodes.RowMode.

getMinRequestLength

Gets the number of contexts that should be requested at least from the rows aggregation binding of the table.

getRowContainerStyles

Gets the CSS styles that are applied to the DOM container of the rows.

getRowCountConstraints

Gets the constraints on the row counts in the table. These are soft constraints and the subclass may ignore them, for example if it does not support fixed rows.

Description of the constraints:

getTable

Gets the parent table.

getTableBottomPlaceholderStyles

Gets the CSS styles that are applied to the table's bottom placeholder DOM element. This element can be used to visually reserve space for rows. If undefined is returned during rendering, this element will not be rendered.

getTableStyles

Gets the CSS styles that are applied to the table's DOM root element.

getTotalRowCountOfTable

Gets total row count of the table. Returns 0 if this mode is not child of a table.

isNoDataDisabled

Checks whether the "NoData" text of the table is disabled.

updateTable

Updates the table's rows aggregation according to the current computed row count, and updates the rows binding contexts.