TableColumn API 

Definition

A Table is built of TableColumns. You have to insert a TableCellEditor into each TableColumn.

As of 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

●      accessibilityDescription

When accessibility is activated, the assigned text is added to the tooltip. This description provides semantic details of the UI element and is only read by the screen reader if the user focuses the complete Ul element.

●      cellDesign

Specifies the color of the TableColumn. The cellDesignproperty is represented by enumeration type WDTableCellDesign.

For the enumeration values see: WDTableCellDesign

●      colSelectionState

Specifies the selection state of the column. This property can be set by the application developer e.g. when the user triggers the onAction event. colSelectionState can take the following values and is represented by enumeration type WDTableColumnSelectionState.

○       notSelectable

○       notSelected

○       selected

●      design

This property is deprecated. Use cellDesign instead.

●      explanation

determines the explanation text. explanation is maintained by the documentation developer in the Web Dynpro Authoring environment.

●      filterValue

You can use this property to define the value to be filtered and to bind it to a corresponding context attribute.

●      fixedPosition

Specifies whether a table column is fixed on the left or right. fixedPosition is represented by enumeration type TableColumnFixedPosition and can take 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 take 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.

●      headerTextWrapping

Specifies whether the header text wraps.

●      isFiltered

Specifies whether the values of the column are filtered.

●      resizable

Specifies whether the width of the table column can be modified by the user.

●      selectedCellVariant

Specifies the selected cell variant.

●      sortState

Specifies the sort status of the table column. sortState is represented by enumeration type TableColumnSortDirection and can take 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.

●      visible

This property specifies the visibility of the UI element. The default value of this property is set to visible.

blank	The UI element is not visible on the screen but takes up space.
none	The UI element is not visible on the screen and takes up no space.
visible	The UI element is displayed on the screen.

●      width

Determines the width of the table column, which you can specify in relative CSS units like em, ex, or percentage.

See also: Common UI Element Properties

Properties Overview

Name	Interface	Type	Initial Value	Bindable
accessibilityDescription	IWDAbstractTableColumn	String		bindable
cellDesign	IWDTableColumn	TableCellDesign	standard	bindable
colSelectionState	IWDTableColumn	WDTableColumnSelectionState	notSelectable	bindable
design	IWDTableColumn	CellBackgroundDesign	transparent	bindable
explanation	IWDAbstractTableColumn	String		not_bindable
filterValue	IWDTableColumn	String		bindable
fixedPosition	IWDAbstractTableColumn	TableColumnFixedPosition	notFixed	bindable
groupingValue	IWDTableColumn	String		bindable
hAlign	IWDTableColumn	TableColumnHAlign	auto	bindable
headerTextWrapping	IWDAbstractTableColumn	boolean	false	bindable
isFiltered	IWDTableColumn	boolean	false	bindable
resizable	IWDTableColumn	boolean	true	bindable
selectedCellVariant	IWDTableColumn	String		bindable
sortState	IWDTableColumn	TableColumnSortDirection	none	bindable
visible	IWDAbstractTableColumn	Visibility	visible	bindable
width	IWDTableColumn	String (CSS size)		bindable

Events

●      onAction (String col)

This event is deprecated, use onColSelect or onSort of Table instead