Top Description Fields Constructors Methods
org.eclipse.swt.layout

public final Class RowLayout

extends Layout
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.graphics.*, org.eclipse.swt.widgets.*

Instances of this class determine the size and position of the children of a Composite by placing them either in horizontal rows or vertical columns within the parent Composite.

RowLayout aligns all controls in one row if the type is set to horizontal, and one column if it is set to vertical. It has the ability to wrap, and provides configurable margins and spacing. RowLayout has a number of configuration fields. In addition, the height and width of each control in a RowLayout can be specified by setting a RowData object into the control using setLayoutData ().

The following example code creates a RowLayout, sets all of its fields to non-default values, and then sets it into a Shell.

		RowLayout rowLayout = new RowLayout();
		rowLayout.wrap = false;
		rowLayout.pack = false;
		rowLayout.justify = true;
		rowLayout.type = SWT.VERTICAL;
		rowLayout.marginLeft = 5;
		rowLayout.marginTop = 5;
		rowLayout.marginRight = 5;
		rowLayout.marginBottom = 5;
		rowLayout.spacing = 0;
		shell.setLayout(rowLayout);
If you are using the default field values, you only need one line of code:
		shell.setLayout(new RowLayout());
See Also
RowData, RowLayout snippets, SWT Example: LayoutExample, Sample code and further information

Field Summary

Modifier and TypeField and Description
public boolean
center

center specifies whether the controls in a row should be centered vertically in each cell for horizontal layouts, or centered horizontally in each cell for vertical layouts.

public boolean
fill

fill specifies whether the controls in a row should be all the same height for horizontal layouts, or the same width for vertical layouts.

public boolean
justify

justify specifies whether the controls in a row should be fully justified, with any extra space placed between the controls.

public int
marginBottom

marginBottom specifies the number of points of vertical margin that will be placed along the bottom edge of the layout.

public int
marginHeight

marginHeight specifies the number of points of vertical margin that will be placed along the top and bottom edges of the layout.

public int
marginLeft

marginLeft specifies the number of points of horizontal margin that will be placed along the left edge of the layout.

public int
marginRight

marginRight specifies the number of points of horizontal margin that will be placed along the right edge of the layout.

public int
marginTop

marginTop specifies the number of points of vertical margin that will be placed along the top edge of the layout.

public int
marginWidth

marginWidth specifies the number of points of horizontal margin that will be placed along the left and right edges of the layout.

public boolean
pack

pack specifies whether all controls in the layout take their preferred size.

public int
spacing

spacing specifies the number of points between the edge of one cell and the edge of its neighbouring cell.

public int
type

type specifies whether the layout places controls in rows or columns.

public boolean
wrap

wrap specifies whether a control will be wrapped to the next row if there is insufficient space on the current row.

Constructor Summary

AccessConstructor and Description
public
RowLayout()

Constructs a new instance of this class with type HORIZONTAL.

public
RowLayout(int
the type of row layout
type
)

Constructs a new instance of this class given the type.

Method Summary

Modifier and TypeMethod and Description
protected Point
computeSize(Composite
a composite widget using this layout
composite
,
int
width (SWT.DEFAULT for preferred size)
wHint
,
int
height (SWT.DEFAULT for preferred size)
hHint
,
boolean
true means flush cached layout values
flushCache
)

Implements abstract org.eclipse.swt.widgets.Layout.computeSize.

Computes and returns the size of the specified composite's client area according to this layout.
pack-priv Point
computeSize(Control control, boolean flushCache)

protected boolean
flushCache(Control
a control managed by this layout
control
)

Overrides org.eclipse.swt.widgets.Layout.flushCache.

Instruct the layout to flush any cached values associated with the control specified in the argument control.
pack-priv String
protected void
layout(Composite
a composite widget using this layout
composite
,
boolean
true means flush cached layout values
flushCache
)

Implements abstract org.eclipse.swt.widgets.Layout.layout.

Lays out the children of the specified composite according to this layout.
pack-priv Point
layoutHorizontal(Composite composite, boolean move, boolean wrap, int width, boolean flushCache)

pack-priv Point
layoutVertical(Composite composite, boolean move, boolean wrap, int height, boolean flushCache)

public String

Returns:

a string representation of the layout
toString
()

Overrides java.lang.Object.toString.

Returns a string containing a concise, human-readable description of the receiver.

Field Detail

centerback to summary
public boolean center

center specifies whether the controls in a row should be centered vertically in each cell for horizontal layouts, or centered horizontally in each cell for vertical layouts. The default value is false.

Since
3.4
fillback to summary
public boolean fill

fill specifies whether the controls in a row should be all the same height for horizontal layouts, or the same width for vertical layouts. The default value is false.

Since
3.0
justifyback to summary
public boolean justify

justify specifies whether the controls in a row should be fully justified, with any extra space placed between the controls. The default value is false.

marginBottomback to summary
public int marginBottom

marginBottom specifies the number of points of vertical margin that will be placed along the bottom edge of the layout. The default value is 3.

marginHeightback to summary
public int marginHeight

marginHeight specifies the number of points of vertical margin that will be placed along the top and bottom edges of the layout. The default value is 0.

Since
3.0
marginLeftback to summary
public int marginLeft

marginLeft specifies the number of points of horizontal margin that will be placed along the left edge of the layout. The default value is 3.

marginRightback to summary
public int marginRight

marginRight specifies the number of points of horizontal margin that will be placed along the right edge of the layout. The default value is 3.

marginTopback to summary
public int marginTop

marginTop specifies the number of points of vertical margin that will be placed along the top edge of the layout. The default value is 3.

marginWidthback to summary
public int marginWidth

marginWidth specifies the number of points of horizontal margin that will be placed along the left and right edges of the layout. The default value is 0.

Since
3.0
packback to summary
public boolean pack

pack specifies whether all controls in the layout take their preferred size. If pack is false, all controls will have the same size which is the size required to accommodate the largest preferred height and the largest preferred width of all the controls in the layout. The default value is true.

spacingback to summary
public int spacing

spacing specifies the number of points between the edge of one cell and the edge of its neighbouring cell. The default value is 3.

typeback to summary
public int type

type specifies whether the layout places controls in rows or columns. The default value is HORIZONTAL. Possible values are:

  • HORIZONTAL: Position the controls horizontally from left to right
  • VERTICAL: Position the controls vertically from top to bottom
Since
2.0
wrapback to summary
public boolean wrap

wrap specifies whether a control will be wrapped to the next row if there is insufficient space on the current row. The default value is true.

Constructor Detail

RowLayoutback to summary
public RowLayout()

Constructs a new instance of this class with type HORIZONTAL.

RowLayoutback to summary
public RowLayout(int type)

Constructs a new instance of this class given the type.

Parameters
type:int

the type of row layout

Since
2.0

Method Detail

computeSizeback to summary
protected Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache)

Implements abstract org.eclipse.swt.widgets.Layout.computeSize.

Doc from org.eclipse.swt.widgets.Layout.computeSize.

Computes and returns the size of the specified composite's client area according to this layout.

This method computes the size that the client area of the composite must be in order to position all children at their preferred size inside the composite according to the layout algorithm encoded by this layout.

When a width or height hint is supplied, it is used to constrain the result. For example, if a width hint is provided that is less than the width of the client area, the layout may choose to wrap and increase height, clip, overlap, or otherwise constrain the children.

Parameters
composite:Composite

a composite widget using this layout

wHint:int

width (SWT.DEFAULT for preferred size)

hHint:int

height (SWT.DEFAULT for preferred size)

flushCache:boolean

true means flush cached layout values

Returns:Point

a point containing the computed size (width, height)

Annotations
@Override
computeSizeback to summary
pack-priv Point computeSize(Control control, boolean flushCache)
flushCacheback to summary
protected boolean flushCache(Control control)

Overrides org.eclipse.swt.widgets.Layout.flushCache.

Doc from org.eclipse.swt.widgets.Layout.flushCache.

Instruct the layout to flush any cached values associated with the control specified in the argument control.

Parameters
control:Control

a control managed by this layout

Returns:boolean

true if the Layout has flushed all cached information associated with control

Annotations
@Override
getNameback to summary
pack-priv String getName()
layoutback to summary
protected void layout(Composite composite, boolean flushCache)

Implements abstract org.eclipse.swt.widgets.Layout.layout.

Doc from org.eclipse.swt.widgets.Layout.layout.

Lays out the children of the specified composite according to this layout.

This method positions and sizes the children of a composite using the layout algorithm encoded by this layout. Children of the composite are positioned in the client area of the composite. The position of the composite is not altered by this method.

When the flush cache hint is true, the layout is instructed to flush any cached values associated with the children. Typically, a layout will cache the preferred sizes of the children to avoid the expense of computing these values each time the widget is laid out.

When layout is triggered explicitly by the programmer the flush cache hint is true. When layout is triggered by a resize, either caused by the programmer or by the user, the hint is false.

Parameters
composite:Composite

a composite widget using this layout

flushCache:boolean

true means flush cached layout values

Annotations
@Override
layoutHorizontalback to summary
pack-priv Point layoutHorizontal(Composite composite, boolean move, boolean wrap, int width, boolean flushCache)
layoutVerticalback to summary
pack-priv Point layoutVertical(Composite composite, boolean move, boolean wrap, int height, boolean flushCache)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a string containing a concise, human-readable description of the receiver.

Returns:String

a string representation of the layout

Annotations
@Override