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

All Superinterfaces:

IWDLayout, IWDViewElement

public interface IWDMatrixLayout

extends IWDLayout

Web Dynpro MatrixLayout API. The matrix layout arranges UI elements in a grid structure. It uses predefined cell classes that guarantee appropriate distances between cells in the grid. The vGutter property lets you specify additional horizontal distances easily. You can set these additional distances (known as gutters) with or without separators. In addition, the matrix layout can include horizontal separators to separate the rows further, represented by the HorizontalGutter UI element. The distance for each cell is specified by assigning a specific enumeration value of the class WDLayoutCellSeparator of the matrix data object. This type of layout is preferable to the GridLayout, since it makes the layout structure in a container more consistent. Using the interface IWDMatrixHeadData, you can specify the UI element that appears at the start of each new line. You should avoid using nested matrix layouts. Instead, use row layouts wherever possible. The row layout differs from the matrix layout in that the content is not organized in table cells. That is, the individual elements are not aligned vertically with each other. When the row layout is implemented in an application, performance is better than if a matrix layout were used, but the layout flexibility is not compromised. For this reason, you should structure the view and container in horizontal areas as early as possible, using the row layout. You should only use the matrix layout if you need to display a table and align the elements vertically.

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

Field Summary

static boolean	DEFAULT_STRETCHED_HORIZONTALLY Default value of property stretchedHorizontally.
static boolean	DEFAULT_STRETCHED_VERTICALLY Default value of property stretchedVertically.

Method Summary

boolean	getStretchedHorizontally() Returns the value of the stretchedHorizontally property.
boolean	getStretchedVertically() Returns the value of the stretchedVertically property.
void	setStretchedHorizontally(boolean stretchedHorizontally) Sets property stretchedHorizontally to the given value.
void	setStretchedVertically(boolean stretchedVertically) Sets property stretchedVertically to the given value.

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

getUIElementContainer

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

getId, getView, requestFocus

Field Detail

DEFAULT_STRETCHED_HORIZONTALLY

public static final boolean DEFAULT_STRETCHED_HORIZONTALLY

Default value of property stretchedHorizontally.

DEFAULT_STRETCHED_VERTICALLY

public static final boolean DEFAULT_STRETCHED_VERTICALLY

Default value of property stretchedVertically.

Method Detail

getStretchedHorizontally

public boolean getStretchedHorizontally()

Returns the value of the stretchedHorizontally property. The initial value is true. Specifies whether UI elements aligned using this layout are adapted horizontally to the container size, so that the container is completely filled horizontally.

Returns:

the value of the stretchedHorizontally property

See Also:

setStretchedHorizontally(boolean)

setStretchedHorizontally

public void setStretchedHorizontally(boolean stretchedHorizontally)

Sets property stretchedHorizontally to the given value.

Parameters:

stretchedHorizontally - the new stretchedHorizontally value

See Also:

getStretchedHorizontally()

getStretchedVertically

public boolean getStretchedVertically()

Returns the value of the stretchedVertically property. The initial value is true. Specifies whether UI elements aligned using this layout are adapted vertically to the container size, so that the container is completely filled vertically.

Returns:

the value of the stretchedVertically property

See Also:

setStretchedVertically(boolean)

setStretchedVertically

public void setStretchedVertically(boolean stretchedVertically)

Sets property stretchedVertically to the given value.

Parameters:

stretchedVertically - the new stretchedVertically value

See Also:

getStretchedVertically()