GridData API
Definition
GridDataprovides the layout data for an user interface element in a container to which a GridLayout is assigned. A grid layout defines a number of cells. In a grid layout cell, you can align a UI element both horizontally (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.
Description of Properties
● cellBackgroundDesign
Specifies the design of the cell background. The default value for this property is transparent. You can use the background colors fill1, fill2, and fill3 as separators between the individual semantically different cell contents. Property cellBackgroundDesign can take the following values and is represented by enumeration type WDCellBackgroundDesign.
Value |
Description |
border |
This is the color of the cell borders. This value is used for nested grid layouts to create grid net lines. |
fill1 |
The color corresponds to value primarycolor of property design in UI element Group. *) |
fill2 |
The color corresponds to value secondarycolor of property design in UI element Group. *) |
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.
● colSpan
Specifies the number of columns occupied by the UI element in the grid.
● dragData
The text representation of the data to be transported along the way to the drop target. This property takes precedence over the grid layout's DragSourceInfo and allows to assign different drag data to individual grid layout cells.
● hAlign
Specifies the horizontal alignment of the UI element in the grid layout cell. The default value of this property is beginOfLine. Property hAlign is represented by enumeration type WDCellHAlign and can take following values:
beginOfLine |
The text is always displayed at the beginning of the line. Therefore, the text for value ltr of property textDirection is left-justified. The text for value rtl is right-justified. |
center |
Centered alignment. |
char |
Specifies the alignment using a specific character. Assigning value char allows you to align the cell contents to a single character. |
endOfLine |
The text is always displayed at the end of the line. Therefore, the text for value ltr of property textDirection is right-justified. The text for value rtl is left-justified. |
forcedLeft |
The text is always left-justified, regardless of whether the value is ltr or rtl for property textDirection. |
forcedRight |
The text content is always right-justified, regardless of whether the value is ltr or rtl for property textDirection. |
justify |
Justified - This value allows forced justification within a grid layout cell. |
left |
Left-justified alignment. This value is deprecated. Use beginOfLine instead. |
right |
Right-justified alignment. This value is deprecated. Use forcedRight instead. |
● 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. Property vAlignproperty is represented by 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 a cellpadding that is already defined in the grid layout.
Properties Overview
Name |
Interface |
Type |
Initial Value |
Bindable |
cellBackgroundDesign |
IWDGridData |
WDCellBackgroundDesign |
transparent |
not_bindable |
colSpan |
IWDGridData |
int |
1 |
not_bindable |
dragData |
IWDGridData |
String |
|
not bindable |
hAlign |
IWDGridData |
WDCellHAlign |
beginOfLine |
not_bindable |
height |
IWDGridData |
String (CSS Size) |
|
not_bindable |
paddingBottom |
IWDGridData |
String (CSS Size) |
|
not_bindable |
paddingLeft |
IWDGridData |
String (CSS Size) |
|
not_bindable |
paddingRight |
IWDGridData |
String (CSS Size) |
|
not_bindable |
paddingTop |
IWDGridData |
String (CSS Size) |
|
not_bindable |
vAlign |
IWDGridData |
WDCellVAlign |
baseline |
not_bindable |
width |
IWDGridData |
String (CSS Size) |
|
not_bindable |