Web
Dynpro GridData API - IWDGridData 
Definition
The Web Dynpro IWDGridData API provides the layout data for an user interface element in a container (to which a grid layout is assigned). A grid layout defines a number of cells. In a grid layout cell, you can align a UI element both horizontically (left-justified, horizontally centered, right-justified, and so on) and vertically (top-aligned, vertically centered, bottom-aligned, and so on). The default settings for the alignment of the UI elements within the grid layout is left-justified and top-aligned.
Property Descriptions
·
cellBackgroundDesign
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 cellBackgroundDesign 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 grid 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.
·
colSpan
Specifies the number of
columns occupied by the UI element in the grid.
·
hAlign
Specifies the horizontal
alignment of the UI element in the grid layout cell. The default value of this
property is left. 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 |
Justified - This value allows forced justification within a grid layout cell. |
left |
Left-justified alignment. |
right |
Right-justified alignment. |
·
height
Specifies the height of the
UI element in the grid layout cell.
·
paddingBottom
Specifies the padding of the UI element to the bottom grid layout
cell.
·
paddingLeft
Specifies the left padding of the UI element to the grid layout
cell.
·
paddingRight
Specifies the right padding of the UI element to the grid layout
cell.
·
paddingTop
Specifies the padding of the UI element to the top grid layout
cell.
·
vAlign
Specifies the vertical
alignment of the UI element in the grid layout cell. The default value of this
property is baseline. The vAlign property is represented by the enumeration type
WDCellVAlign and can be used to specify the alignment value of
the grid layout cell.
baseline |
Alignment with a common baseline, the first text line is always displayed at the defined location. |
bottom |
Bottom padding - alignment with bottom edge. |
middle |
Centered vertically. |
top |
Top padding - alignment with top edge. |
·
width
Specifies the width of the UI
element in the grid layout cell.
When defining the properties paddingBottom, paddingLeft, paddingRight, and paddingTop, the layout is added to cellpadding that is already defined in grid layout.
Properties Overview
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
cellBackgroundDesign |
IWDGridData |
WDCellBackgroundDesign |
transparent |
not_bindable |
No |
colSpan |
IWDGridData |
int |
1 |
not_bindable |
No |
hAlign |
IWDGridData |
WDCellHAlign |
left |
not_bindable |
No |
height |
IWDGridData |
String (CSS Size) |
|
not_bindable |
No |
paddingBottom |
IWDGridData |
String (CSS Size) |
|
not_bindable |
No |
paddingLeft |
IWDGridData |
String (CSS Size) |
|
not_bindable |
No |
paddingRight |
IWDGridData |
String (CSS Size) |
|
not_bindable |
No |
paddingTop |
IWDGridData |
String (CSS Size) |
|
not_bindable |
No |
vAlign |
IWDGridData |
WDCellVAlign |
baseline |
not_bindable |
No |
width |
IWDGridData |
String (CSS Size) |
|
not_bindable |
No |
Methods in the Web Dynpro IWDGridData API
Method Name |
Parameter |
Return Value |
Short Description |
getColSpan |
|
int |
Returns the value of the colSpan property. |
getHAlign |
|
WDCellHAlign |
Returns the value of the hAlign property. |
getHeight |
|
String |
Returns the value of the height property. |
getPaddingBottom |
|
String |
Returns the value of the paddingBottom property. |
getPaddingLeft |
|
String |
Returns the value of the paddingLeft property. |
getPaddingRight |
|
String |
Returns the value of the paddingRight property. |
getPaddingTop |
|
String |
Returns the value of the paddingTop property. |
getVAlign |
|
WDCellVAlign |
Returns the value of the vAlign property. |
getWidth |
|
String |
Returns the value of the width property. |
setColSpan |
(int colSpan) |
|
Sets the value of the colSpan property. |
setHAlign |
(WDCellHAlign hAlign) |
|
Sets the value of the hAlign property. |
setHeight |
(String height) |
|
Sets the value of the height property. |
setPaddingBottom |
(String paddingBottom) |
|
Sets the value of the paddingBottom property. |
setPaddingLeft |
(String paddingLeft) |
|
Sets the value of the paddingLeft property. |
setPaddingRight |
(String paddingRight) |
|
Sets the value of the paddingRight property. |
setPaddingTop |
(String paddingTop) |
|
Sets the value of the paddingTop property. |
setVAlign |
(WDCellVAlign vAlign) |
|
Sets the value of the vAlign property. |
setWidth |
(String width) |
|
Sets the value of the width property. |
Additional methods described in the following APIs are available using inheritance: IWDLayoutData, IWDViewElement.