Web
Dynpro MatrixData API - IWDMatrixData 
Definition
The Web Dynpro IWDMatrixData API provides the layout data for an user interface element in a container (to which a Matrix layout is assigned).
Description of the UI Element Properties
·
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.
·
cellDesign
Specifies the distance between the cell content and the outer edge of the
cell. The default value of this property is rPad. The cellDesign property can be filled with the following values
and is represented by the enumeration type WDLayoutCellDesign .
Value |
Displayed as: |
Short Description |
lPad |
|
This value specifies a distance to the top edge (2 pixels), the bottom edge (2 pixels) and can be used in the last matrix column on the right. |
lrNoPad |
|
This value specifies a distance to the top edge (2 pixels), the bottom edge (2 pixels) and can be used in the last matrix column on the right or the first on the left. |
lrPad |
|
This value specifies a distance to the top edge (2 pixels), the bottom edge (2 pixels), the left edge (4 pixels), and the right edge. It should not be used as the last matrix column on the right or first on the left. |
padless |
|
This value specifies a distance of zero pixels to the edges of the cell. It is intended for nested contents that have their own specified padding or for cases where there is no need for cell content padding. |
rPad |
|
This value is appropriate for displaying most content, and is thus set as the default value. It can be used as the first matrix column on the left. It specifies a 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. |
·
colSpan
Specifies the number of
columns the UI element occupies in the matrix layout.
·
hAlign
Specifies the horizontal
alignment of the UI element in the grid. 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 cell. |
left |
Left-justified alignment. |
right |
Right-justified alignment. |
·
height
Specifies the height of the cell.
·
vAlign
Specifies the vertical
alignment of the UI element within the grid. The default value of this
property is baseline. The vAlign property
can be filled with the following values and is represented by the enumeration
type WDCellVAlign.
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. |
·
vGutter
Specifies additional, horizontal distances between the cell contents. The
default value of this property is none. It can be set separately for
each cell.
The vGutter property can be filled with the following values
and is represented by the enumeration type WDLayoutCellSeparator .
Value |
Display in default cell design |
Short description |
large |
|
Additional horizontal distance of 31 pixels |
largeWithRule |
|
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 |
·
width
Specifies the width of the cell.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
cellBackgroundDesign |
IWDMatrixData |
WDCellBackgroundDesign |
transparent |
not_bindable |
No |
cellDesign |
IWDMatrixData |
WDLayoutCellDesign |
rPad |
not_bindable |
No |
colSpan |
IWDMatrixData |
int |
1 |
not_bindable |
No |
hAlign |
IWDMatrixData |
WDCellHAlign |
left |
not_bindable |
No |
height |
IWDMatriaData |
String (CSS size) |
|
not_bindable |
No |
vAlign |
IWDMatrixData |
WDCellVAlign |
baseline |
not_bindable |
No |
vGutter |
IWDMatrixData |
WDLayoutCellSeparator |
none |
not_bindable |
No |
width |
IWDMatrixData |
String (CSS size) |
|
not_bindable |
No |
Methods in the Web Dynpro IWDMatrixData API
Method Name |
Parameter |
Return Value |
Short Description |
getCellBackgroundDesign |
|
WDCellBackgroundDesign |
Returns the value of the cellBackgroundDesign property. |
getCellDesign |
|
WDLayoutCellDesign |
Returns the value of the cellDesign property. |
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. |
getVAlign |
|
WDCellVAlign |
Returns the value of the vAlign property. |
getVGutter |
|
WDLayoutCellSeparator |
Returns the value of the vGutter property. |
getWidth |
|
String |
Returns the value of the width property. |
setCellBackgroundDesign |
(WDCellBackgroundDesign cellBackgroundDesign) |
|
Sets the value of the cellBackgroundDesign property. |
setCellDesign |
(WDLayoutCellDesign cellDesign) |
|
Sets the value of the cellDesign 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. |
setVAlign |
(WDCellVAlign vAlign) |
|
Sets the value of the vAlign property. |
setVGutter |
(WDLayoutCellSeparator vGutter) |
|
Sets the value of the vGutter property. |
setWidth |
(String width) |
|
Sets the value of the width property. |
Additional methods described in the following APIs are available using inheritance:
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.
Subclasses