Web
Dynpro TableColumn API - IWDTableColumn 
Definition
The TableColumn element is a column within a table.
Property Descriptions
·
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 WDCellBackgroundDesign.
Value |
Short Description |
border |
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 |
The 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. Before using
this property, read the description of the table property onFilter, which you can use to define an
action for filtering table entries.
·
hAlign
Describes the horizontal alignment of the table column.
·
resizable
Specifies whether the width
of the table column can be modified by the user.
·
visible
Specifies whether or not the column is displayed.
The visible property can be filled with the following values and is
represented by the data type WDVisibility.
blank |
The table column is not visible on the screen. This value has the same visibility effect for the table column on the screen as the value none. |
none |
The table column is not visible on the screen. |
visible |
The table column is displayed on the screen. |
·
width
Specifies the width of the
table column in a table.
Properties Overview
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
design |
IWDTableColumn |
WDCellBackgroundDesign |
transparent |
bindable |
No |
filterValue |
IWDTableColumn |
String |
|
bindable |
No |
hAlign |
IWDTableColumn |
WDTableColumnHAlign |
auto |
bindable |
No |
resizable |
IWDTableColumn |
boolean |
true |
bindable |
No |
visible |
IWDTableColumn |
WDVisibility |
visible |
bindable |
No |
width |
IWDTableColumn |
String (CSS size) |
|
bindable |
No |
Events
·
onAction
This property contains the action that is executed when the user selects the
header of a table column. The event parameter is the ID of the table column in
which the event occurs
Event Parameter |
Type |
col |
String |
See 
Parameter
Mapping.
Data Binding
The content of a
table cell to be displayed is specified by a table cell editor of the column.
For further information, refer to Data Bindung in a
Table.
Methods in the Web Dynpro IWDTableColumns API
Method Name |
Parameter |
Return Value |
Short Description |
bindDesign |
(String path) |
|
Binds the value of the design property to the context element specified by the path. |
bindFilterValue |
(String path) |
|
Binds the filterValue property to the context node specified by a path. |
bindHAlign |
(String path) |
|
Binds the hAlign property to the context node specified by a path. |
bindingOfDesign |
|
String |
Returns the path of the context element to which the design property is bound. Returns NULL if no binding exists. |
bindingOfFilterValue |
|
String |
Returns the path of the context element to which the filterValue property is bound. Returns NULL if no binding exists. |
bindingOfHAlign |
|
String |
Returns the path of the context element to which the hAlign property is bound. Returns NULL if no binding exists. |
bindingOfResizable |
|
String |
Returns the path of the context element to which the resizable property is bound. Returns NULL if no binding exists. |
bindingOfVisible |
|
String |
Returns the path of the context element to which the visible property is bound. Returns NULL if no binding exists. |
bindingOfWidth |
|
String |
Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists. |
bindResizable |
(String path) |
|
Binds the value of the resizable property to the context element specified by the path. |
bindVisible |
(String path) |
|
Binds the value of the visible property to the context element specified by the path. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
destroyHeader |
|
|
Removes and deletes the header for this TableColumn element. |
destroyTableCellEditor |
|
|
Removes and deletes the table cell editor for this TableColumn element. |
getDesign |
|
WDCellBackgroundDesign |
Returns the value of the design property. |
getFilterValue |
|
String |
Returns the value of the filterValue property. |
getHAlign |
|
WDTableColumnHAlign |
Returns the value of the hAlign property. |
getHeader |
|
IWDCaption |
Returns the header for this TableColumn element. |
getOnAction |
|
IWDAction |
Returns the action that is executed when the onAction event is triggered. |
getResizable |
|
boolean |
Returns the value of the resizable property. |
getTable |
|
IWDTable |
Returns the Table element in which this TableColumn element is contained. |
getTableCellEditor |
|
IWDTableCellEditor |
Returns the table cell editor for this TableColumn element. |
getVisible |
|
WDVisibility |
Returns the value of the visible property. |
getWidth |
|
String |
Returns the value of the width property. |
mappingOfOnAction |
|
IWDParameterMapping |
Returns the parameter mapping for the onAction action. |
setDesign |
(WDCellBackgroundDesign design) |
|
Sets the value of the design property. |
setFilterValue |
(String filterValue) |
|
Sets the value of the filterValue property. |
setHAlign |
(WDTableColumnHAlign hAlign) |
|
Sets the value of the hAlign property. |
setHeader |
(IWDCaption header) |
|
Sets the header for this TableColumn element. |
setOnAction |
(IWDAction action) |
|
Sets the action that is executed if the onAction event is raised. |
setTableCellEditor |
(IWDTableCellEditor tableCellEditor) |
|
Sets the table cell editor for this TableColumn element. |
setResizable |
(boolean resizable) |
|
Sets the value of the resizable property. |
setVisible |
(WDVisibility visible) |
|
Sets the value of the visible property. |
setWidth |
(String width) |
|
Sets the value of the width property. |
Additional methods are available using inheritance: IWDViewElement.