TableColumn API
Definition
A Table is built of TableColumns. You have to insert a TableCellEditor into each TableColumn.
As of SAP NetWeaver 7.0 (2004s), the association role of TableColumns has changed from Columns to GroupedColumns. You can migrate tables to the new association role using the Migrate Columns function in the context menu of the Table UI element.
Description of Properties
● cellDesign
Specifies the background color of the cell. The cellDesign property can be filled with the following values and is represented by the enumeration type TableCellDesign.
badvalue_dark |
Dark background color that indicates a negative value. |
badvalue_light |
Light background color that indicates a negative value. |
badvalue_medium |
Medium background color that indicates a negative value. |
criticalvalue_dark |
Dark background color that indicates a critical value. |
criticalvalue_light |
Light background color that indicates a critical value. |
criticalvalue_medium |
Medium background color that indicates a critical value. |
goodvalue_dark |
Dark background color that indicates a good value. |
goodvalue_light |
Light background color that indicates a good value. |
goodvalue_medium |
Medium background color that indicates a good value. |
group_level1 |
Background color for cells of group level 1 |
group_level2 |
Background color for cells of group level 2 |
group_level3 |
Background color for cells of group level 3 |
key_medium |
Medium background color for cells of key column |
negative |
Background color that indicates a negative value. |
positive |
Background color that indicates a positive value. |
standard |
Standard background color, the same for the entire row |
one |
Color of category one, depends on the respective design theme used. |
two |
Color of category two, depends on the respective design theme used. |
three |
Color of category three, depends on the respective design theme used. |
four |
Color of category four, depends on the respective design theme used. |
The default value for this property is standard.
● design
Specifies the design of the cell background. The default value of this property is transparent. You can use the background colors fill1, fill2, and fill3 as separators between the individual semantically different cell contents. The design property can be filled with the following values and is represented by the enumeration type CellBackgroundDesign.
border |
This is the color of the cell borders. |
fill1 |
The color corresponds to the value primarycolor of the design property of the Group UI element. *) |
fill2 |
The color corresponds to the value secondarycolor of the design property of the Group UI element. *) |
fill3 |
This color corresponds to the color value of the third level of a Tree UI element. *) |
header |
The color is identical with the color of the header area of a Tree UI element or a table. |
plain |
White background. |
transparent |
The background is transparent. The individual cells are displayed without grid net lines. |
*) The colors to be displayed depend on the design topic and the documentation refers to the SAP Standard Design 2002.
● filterValue
You can use this property to define the value to be filtered and to bind it to a corresponding context attribute.
● fixedPosition
You can use the fixedPosition property to specify whether a table column is fixed on the left or right. fixedPosition is represented by the enumeration type TableColumnFixedPosition and can have the following values:
left |
The column is fixed on the left. |
notFixed |
The column is not fixed and can be scrolled. |
right |
The column is fixed on the right. |
● groupingValue
Specifies the
table column which is used to group the values. The user can identify the grouping by the
fact that the same values of a column is only displayed in the column in which
it is listed for the first time and that there is no separator between the
cells of the grouped values.
In the following graphic, the table is grouped by the column Article.
● hAlign
Describes the horizontal alignment of the table column. The hAlign property is represented by the enumeration type WDTableColumnHAlign and can be filled with the following values:
auto |
Automatic alignment of the text content. The alignment is specified by the usage of the UI element - for example, by the data type of the value to be represented. |
beginOfLine |
The text content is always displayed at the beginning of line. Therefore, the text content for the value ltr of the textDirection property is left-justified. The text content for the value rtl is right-justified. |
center |
Centered alignment. |
endOfLine |
The text content is always displayed at the end of the line. Therefore, the text content for the value ltr of the textDirection property is right-justified. The text content for the value rtl is left-justified. |
forcedLeft |
The text content is always left-justified, regardless of whether the value is ltr or rtl for the textDirection property. |
forcedLRight |
The text content is always right-justified, regardless of whether the value is ltr or rtl for the textDirection property. |
left |
Left-justified alignment. This value is deprecated. Use beginOfLine instead. |
right |
Right-justified alignment. This value is deprecated. Use forcedRight instead. |
The default value for this property is auto.
● isFiltered
Specifies whether the values of the column are filtered.
● resizable
has no impact on the user interface in this release.
● selectedCellVariant
Specifies the selected cell variant.
● sortState
Specifies the sort status of the table column. sortState is represented by the enumeration type TableColumnSortDirection and can have the following values:
down |
The table column is sorted in descending order. |
none |
The table column is not sorted, but can be sorted. |
notSortable |
The table column cannot be sorted. |
up |
The table column is sorted in ascending order. |
● width
Determines the width of the table column, which you can specify in relative CSS units like em, ex, or percentage.
Properties Overview
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
cellDesign |
IWDTableColumn |
TableCellDesign |
standard |
bindable |
No |
design |
IWDTableColumn |
CellBackgroundDesign |
transparent |
bindable |
No |
filterValue |
IWDTableColumn |
String |
|
bindable |
No |
fixedPosition |
IWDAbstractTableColumn |
TableColumnFixedPosition |
notFixed |
bindable |
No |
groupingValue |
IWDTableColumn |
String |
|
bindable |
No |
hAlign |
IWDTableColumn |
TableColumnHAlign |
auto |
bindable |
No |
isFiltered |
IWDTableColumn |
boolean |
false |
bindable |
No |
resizable |
IWDTableColumn |
boolean |
true |
bindable |
No |
selectedCellVariant |
IWDTableColumn |
String |
|
bindable |
No |
sortState |
IWDTableColumn |
TableColumnSortDirection |
none |
bindable |
No |
visible |
IWDAbstractTableColumn |
Visibility |
visible |
bindable |
No |
width |
IWDTableColumn |
String (CSS size) |
|
bindable |
No |
Events
● onAction
This event is triggered when the user clicks the header of the table column. The event parameter col is the ID of the table column in which the event takes place.
See
Parameter
Mapping.