Web
Dynpro RowHeadData API – IWDRowHeadData 
Definition
The RowHeadData element defines the layout data of a UI element that starts a new row in a row layout. The values of the following properties are valid for the entire row.
Description of the UI Element Properties
·
hAlign
Specifies the horizontal
alignment of the row. The default value of this property is left., i.e,
all elements of a row are left-aligned. The hAlign property is represented by the enumeration type
WDCellHAlign and can be filled with the following
values:
center |
Centered alignment. |
char |
Specifies the alignment using a specific character. The assignment of the char value allows you to align the cell contents to a single character. |
justify |
Centered alignment. |
left |
The complete row is left-aligned. |
right |
The complete row is right-aligned. |
·
rowDesign
Specifies the design
(padding) of a row. Thus, you cannot create gaps between the elements of a
row. The default value of this property is rPad. The rowDesign property can be filled with the following values
and is represented by the enumeration type WDLayoutCellDesign .
Value |
Displayed as: |
Short Description |
lPad |
|
Specifies the distance to the top edge (2 pixels), the bottom edge (2 pixels), and the left edge (4 pixels). |
lrNoPad |
|
Specifies the distance to the top edge (2 pixels) and the bottom edge (2 pixels). |
lrPad |
|
Specifies the distance to the top edge (2 pixels), the bottom edge (2 pixels), the left edge (4 pixels), and the right edge (4 pixels). |
Padless |
|
There is no distance between the row and the edges. |
rPad |
|
Specifies the distance to the top edge (2 pixels), the bottom edge (2 pixels), and the right edge (4 pixels) and thus prevents cell contents from touching. |
·
rowBackgroundDesign
Specifies the design of the
row background. The default value of this property is transparent. You can use the background colors fill1, fill2, and fill3 to highlight semantically different rows. The
rowBackgroundDesign 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. This value is used for nested row layouts to create grid net lines. |
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.
·
vGutter
Specifies an additional distance to the left edge. The default value of this
property is none. Other values are only appropriate if the row layout
is used in a matrix layout.
The vGutter property can be filled with the following values
and is represented by the enumeration type WDLayoutCellSeparator .
large |
|
Additional horizontal distance of 31 pixels
|
largeWidthRule |
|
Additional horizontal distance of 31 pixels with a vertical line
|
medium |
|
Additional horizontal distance of 17 pixels
|
mediumWithRule |
|
Additional horizontal distance of 17 pixels with a vertical line
|
none |
|
No additional distance
|
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
hAlign |
IWDRowHeadData |
WDCellHAlign |
left |
not_bindable |
No |
rowDesign |
IWDRowHeadData |
rPad |
not_bindable |
No |
|
rowBackgroundDesign |
IWDRowHeadData |
transparent |
not_bindable |
No |
|
vGutter |
IWDRowHeadData |
WDLayoutCellSeparator |
none |
not_bindable |
No |
Methods in the Web Dynpro IWDRowHeadData API
Method Name |
Parameter |
Return Value |
Short Description |
getHAlign |
|
WDCellHAlign |
Returns the value of the hAlign property. |
getRowBackgroundDesign |
|
WDCellBackgroundDesign |
Returns the value of the rowBackgroundDesign property. |
getRowDesign |
|
WDLayoutCellDesign |
Returns the value of the rowDesign property. |
getVGutter |
|
WDLayoutCellSeparator |
Returns the value of the vGutter property. |
setHAlign |
(WDCellHAlign hAlign) |
|
Sets the value of the hAlign property. |
setRowBackgroundDesign |
(WDCellBackgroundDesign rowBackgroundDesign) |
|
Sets the value of the rowBackgroundDesign property. |
setRowDesign |
(WDLayoutCellDesign rowDesign) |
|
Sets the value of the rowDesign property. |
setVGutter |
(WDLayoutCellSeparator vGutter) |
|
Sets the value of the vGutter property. |
Additional methods described in the following APIs are available using inheritance:
IWDLayoutData, IWDRowData, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.