MatrixData and
MatrixHeadData
Definition
The Web Dynpro IWDMatrixData API provides the layout data for a user interface element in a container (to which a Matrix layout is assigned). You can specify a new line in a Matrix layout with MatrixHeadData.
Description of the 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. The cellBackgroundDesignproperty can have the following values and is represented by the 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 the Group UI element. *) |
fill2 |
The color corresponds to value secondarycolor of property design in the Group UI element. *) |
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.
● cellDesign
Specifies the distance between the cell content and the outer edge of the cell. The default value of this property is rPad. Property cellDesign can take the following values and is represented by enumeration type WDLayoutCellDesign.
Value |
Appearance |
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.
● dragData
- only available for MatrixHeadData –
The text representation of the data to be transported along the way to the drop target. This property takes precedence over the MatrixLayout's DragSourceInfo and allows to assign different drag data to individual matrix layout rows. Note that drag-and-drop operates on the matrix layout's rows as a whole, not on individual cells! These rows can be moved vertically, but you cannot move cells horizontally within a row.
● hAlign
Specifies the horizontal alignment of the UI element in the matrix layout cell. The default value of this property is beginOfLine. Property hAlign is represented by enumeration type WDCellHAlign and can have the following values:
beginOfLine |
The text is always displayed at the beginning of 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 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 cell.
● vAlign
Specifies the vertical alignment of the UI element within the grid. The default value of this property is baseline. Property vAlign can have the following values and is represented by 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.
Property vGutter can take the
following values and is represented by enumeration type WDLayoutCellSeparator .
Value |
Appearance in Default Cell Design |
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 |
xLarge |
|
Additional horizontal distance of 63 pixels |
xLargeWithRule |
|
Additional horizontal distance of 63 pixels with a vertical line |
● width
Specifies the width of the cell.
Overview Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
cellBackgroundDesign |
IWDMatrixData |
WDCellBackgroundDesign |
transparent |
not_bindable |
cellDesign |
IWDMatrixData |
WDLayoutCellDesign |
rPad |
not_bindable |
colSpan |
IWDMatrixData |
int |
1 |
not_bindable |
dragData |
IWDMatrixHeadData |
String |
|
not bindable |
hAlign |
IWDMatrixData |
WDCellHAlign |
beginOfLine |
not_bindable |
height |
IWDMatriaData |
String (CSS size) |
|
not_bindable |
vAlign |
IWDMatrixData |
WDCellVAlign |
baseline |
not_bindable |
vGutter |
IWDMatrixData |
WDLayoutCellSeparator |
none |
not_bindable |
width |
IWDMatrixData |
String (CSS size) |
|
not_bindable |