com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDMatrixData

All Superinterfaces:

IWDLayoutData, IWDViewElement

All Known Subinterfaces:

IWDMatrixHeadData

public interface IWDMatrixData

extends IWDLayoutData

Web Dynpro MatrixData API. MatrixData defines the layout data of a UI element contained in a UI element container with a matrix layout.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static WDCellBackgroundDesign	DEFAULT_CELL_BACKGROUND_DESIGN Default value of property cellBackgroundDesign.
static WDLayoutCellDesign	DEFAULT_CELL_DESIGN Default value of property cellDesign.
static int	DEFAULT_COL_SPAN Default value of property colSpan.
static WDCellHAlign	DEFAULT_H_ALIGN Default value of property hAlign.
static java.lang.String	DEFAULT_HEIGHT Default value of property height.
static WDCellVAlign	DEFAULT_V_ALIGN Default value of property vAlign.
static WDLayoutCellSeparator	DEFAULT_V_GUTTER Default value of property vGutter.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

Method Summary

WDCellBackgroundDesign	getCellBackgroundDesign() Returns the value of the cellBackgroundDesign property.
WDLayoutCellDesign	getCellDesign() Returns the value of the cellDesign property.
int	getColSpan() Returns the value of the colSpan property.
WDCellHAlign	getHAlign() Returns the value of the hAlign property.
java.lang.String	getHeight() Returns the value of the height property.
WDCellVAlign	getVAlign() Returns the value of the vAlign property.
WDLayoutCellSeparator	getVGutter() Returns the value of the vGutter property.
java.lang.String	getWidth() Returns the value of the width property.
void	setCellBackgroundDesign(WDCellBackgroundDesign cellBackgroundDesign) Sets property cellBackgroundDesign to the given value.
void	setCellDesign(WDLayoutCellDesign cellDesign) Sets property cellDesign to the given value.
void	setColSpan(int colSpan) Sets property colSpan to the given value.
void	setHAlign(WDCellHAlign hAlign) Sets property hAlign to the given value.
void	setHeight(java.lang.String height) Sets property height to the given value.
void	setVAlign(WDCellVAlign vAlign) Sets property vAlign to the given value.
void	setVGutter(WDLayoutCellSeparator vGutter) Sets property vGutter to the given value.
void	setWidth(java.lang.String width) Sets property width to the given value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDLayoutData

getUIElement

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_CELL_BACKGROUND_DESIGN

public static final WDCellBackgroundDesign DEFAULT_CELL_BACKGROUND_DESIGN

Default value of property cellBackgroundDesign.

DEFAULT_CELL_DESIGN

public static final WDLayoutCellDesign DEFAULT_CELL_DESIGN

Default value of property cellDesign.

DEFAULT_COL_SPAN

public static final int DEFAULT_COL_SPAN

Default value of property colSpan.

DEFAULT_H_ALIGN

public static final WDCellHAlign DEFAULT_H_ALIGN

Default value of property hAlign.

DEFAULT_HEIGHT

public static final java.lang.String DEFAULT_HEIGHT

Default value of property height.

DEFAULT_V_ALIGN

public static final WDCellVAlign DEFAULT_V_ALIGN

Default value of property vAlign.

DEFAULT_V_GUTTER

public static final WDLayoutCellSeparator DEFAULT_V_GUTTER

Default value of property vGutter.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

getCellBackgroundDesign

public WDCellBackgroundDesign getCellBackgroundDesign()

Returns the value of the cellBackgroundDesign property. The initial value is WDCellBackgroundDesign.TRANSPARENT. Specifies the design of the cell background. You can use the background colors fill1, fill2, and fill3 to mark semantically different cell contents.

Returns:

the value of the cellBackgroundDesign property

See Also:

setCellBackgroundDesign(WDCellBackgroundDesign)

setCellBackgroundDesign

public void setCellBackgroundDesign(WDCellBackgroundDesign cellBackgroundDesign)

Sets property cellBackgroundDesign to the given value.

Parameters:

cellBackgroundDesign - the new cellBackgroundDesign value

See Also:

getCellBackgroundDesign()

getCellDesign

public WDLayoutCellDesign getCellDesign()

Returns the value of the cellDesign property. The initial value is WDLayoutCellDesign.R_PAD. Specifies the distance between the cell content and the outer edge of the cell. The default value of this property is rPad.

Returns:

the value of the cellDesign property

See Also:

setCellDesign(WDLayoutCellDesign)

setCellDesign

public void setCellDesign(WDLayoutCellDesign cellDesign)

Sets property cellDesign to the given value.

Parameters:

cellDesign - the new cellDesign value

See Also:

getCellDesign()

getColSpan

public int getColSpan()

Returns the value of the colSpan property. The initial value is 1. Specifies the number of columns the UI element occupies in the matrix layout.

Returns:

the value of the colSpan property

See Also:

setColSpan(int)

setColSpan

public void setColSpan(int colSpan)

Sets property colSpan to the given value.

Parameters:

colSpan - the new colSpan value

See Also:

getColSpan()

getHAlign

public WDCellHAlign getHAlign()

Returns the value of the hAlign property. The initial value is WDCellHAlign.LEFT. Specifies the horizontal alignment of the UI element in the grid cell.

Returns:

the value of the hAlign property

See Also:

setHAlign(WDCellHAlign)

setHAlign

public void setHAlign(WDCellHAlign hAlign)

Sets property hAlign to the given value.

Parameters:

hAlign - the new hAlign value

See Also:

getHAlign()

getHeight

public java.lang.String getHeight()

Returns the value of the height property. The initial value is "". Specifies the height of the cell.

Returns:

the value of the height property

See Also:

setHeight(String)

setHeight

public void setHeight(java.lang.String height)

Sets property height to the given value.

Parameters:

height - the new height value

See Also:

getHeight()

getVAlign

public WDCellVAlign getVAlign()

Returns the value of the vAlign property. The initial value is WDCellVAlign.BASELINE. Specifies the vertical alignment of the UI element in the grid cell.

Returns:

the value of the vAlign property

See Also:

setVAlign(WDCellVAlign)

setVAlign

public void setVAlign(WDCellVAlign vAlign)

Sets property vAlign to the given value.

Parameters:

vAlign - the new vAlign value

See Also:

getVAlign()

getVGutter

public WDLayoutCellSeparator getVGutter()

Returns the value of the vGutter property. The initial value is WDLayoutCellSeparator.NONE. Specifies additional, horizontal distances between the cell contents.

Returns:

the value of the vGutter property

See Also:

setVGutter(WDLayoutCellSeparator)

setVGutter

public void setVGutter(WDLayoutCellSeparator vGutter)

Sets property vGutter to the given value.

Parameters:

vGutter - the new vGutter value

See Also:

getVGutter()

getWidth

public java.lang.String getWidth()

Returns the value of the width property. The initial value is "". Specifies the width of the cell.

Returns:

the value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String width)

Sets property width to the given value.

Parameters:

width - the new width value

See Also:

getWidth()