Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.layout.GridLayout

Instances of this class lay out the control children of a Composite in a grid.

GridLayout has a number of configuration fields, and the controls it lays out can have an associated layout data object, called GridData. The power of GridLayout lies in the ability to configure GridData for each control in the layout.

The following code creates a shell managed by a GridLayout with 3 columns:

		Display display = new Display();
		Shell shell = new Shell(display);
		GridLayout gridLayout = new GridLayout();
		gridLayout.numColumns = 3;
		shell.setLayout(gridLayout);

The numColumns field is the most important field in a GridLayout. Widgets are laid out in columns from left to right, and a new row is created when numColumns + 1 controls are added to the Composite.

Field Summary

Modifier and Type	Field and Description
public int	horizontalSpacing horizontalSpacing specifies the number of points between the right edge of one cell and the left edge of its neighbouring cell to the right.
public boolean	makeColumnsEqualWidth makeColumnsEqualWidth specifies whether all columns in the layout will be forced to have the same width.
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 int	numColumns numColumns specifies the number of cell columns in the layout.
public int	verticalSpacing verticalSpacing specifies the number of points between the bottom edge of one cell and the top edge of its neighbouring cell underneath.

Constructor Summary

Access	Constructor and Description
public	GridLayout() Constructs a new instance of this class with a single column.
public	GridLayout(int the number of columns in the grid numColumns, boolean whether or not the columns will have equal width makeColumnsEqualWidth) Constructs a new instance of this class given the number of columns, and whether or not the columns should be forced to have the same width.

Method Summary

Modifier and Type	Method 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.
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 GridData	getData(Control[][] grid, int row, int column, int rowCount, int columnCount, boolean first)
pack-priv String	getName()
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	layout(Composite composite, boolean move, int x, int y, int width, 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

horizontalSpacing	back to summary
public int horizontalSpacing horizontalSpacing specifies the number of points between the right edge of one cell and the left edge of its neighbouring cell to the right. The default value is 5.

makeColumnsEqualWidth	back to summary
public boolean makeColumnsEqualWidth makeColumnsEqualWidth specifies whether all columns in the layout will be forced to have the same width. The default value is false.

marginBottom	back 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 0. Since 3.1

marginBottom

back 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 0.

Since: 3.1

marginHeight	back 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 5.

marginLeft	back 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 0. Since 3.1

marginLeft

back 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 0.

Since: 3.1

marginRight	back 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 0. Since 3.1

marginRight

back 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 0.

Since: 3.1

marginTop	back 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 0. Since 3.1

marginTop

back 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 0.

Since: 3.1

marginWidth	back 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 5.

numColumns	back to summary
public int numColumns numColumns specifies the number of cell columns in the layout. If numColumns has a value less than 1, the layout will not set the size and position of any controls. The default value is 1.

verticalSpacing	back to summary
public int verticalSpacing verticalSpacing specifies the number of points between the bottom edge of one cell and the top edge of its neighbouring cell underneath. The default value is 5.

Constructor Detail

GridLayout	back to summary
public GridLayout() Constructs a new instance of this class with a single column.

GridLayout	back to summary
public GridLayout(int numColumns, boolean makeColumnsEqualWidth) Constructs a new instance of this class given the number of columns, and whether or not the columns should be forced to have the same width. If numColumns has a value less than 1, the layout will not set the size and position of any controls. Parameters numColumns:int the number of columns in the grid makeColumnsEqualWidth:boolean whether or not the columns will have equal width Since 2.0

GridLayout

back to summary

public GridLayout(int numColumns, boolean makeColumnsEqualWidth)

Constructs a new instance of this class given the number of columns, and whether or not the columns should be forced to have the same width. If numColumns has a value less than 1, the layout will not set the size and position of any controls.

Parameters

numColumns:int: the number of columns in the grid
makeColumnsEqualWidth:boolean: whether or not the columns will have equal width

Since

2.0

Method Detail

computeSize back to summary

computeSize	back 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

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

flushCache back to summary

flushCache	back 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

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

getData	back to summary
pack-priv GridData getData(Control[][] grid, int row, int column, int rowCount, int columnCount, boolean first)

getName	back to summary
pack-priv String getName()

layout back to summary

layout	back 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

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

layout	back to summary
pack-priv Point layout(Composite composite, boolean move, int x, int y, int width, int height, boolean flushCache)

layout

back to summary

pack-priv Point layout(Composite composite, boolean move, int x, int y, int width, int height, boolean flushCache)

toString	back 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

toString

back 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

public final Class GridLayout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail