GridLayout

Instances of this class lay out the control children of a <code>Composite</code> in a grid. <code>GridLayout</code> has a number of configuration fields, and the controls it lays out can have an associated layout data object, called <code>GridData</code>. The power of <code>GridLayout</code> lies in the ability to configure <code>GridData</code> for each control in the layout. The following code creates a shell managed by a <code>GridLayout</code> with 3 columns: <pre> Display display = new Display(); Shell shell = new Shell(display); GridLayout gridLayout = new GridLayout(); gridLayout.numColumns = 3; shell.setLayout(gridLayout); </pre> The <code>numColumns</code> field is the most important field in a <code>GridLayout</code>. Widgets are laid out in columns from left to right, and a new row is created when <code>numColumns</code> + 1 controls are added to the <code>Composite<code>.

@see GridData @see <a href="http://www.eclipse.org/swt/snippets/#gridlayout">GridLayout snippets</a> @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: LayoutExample</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

final

class GridLayout : Layout {

int numColumns;

bool makeColumnsEqualWidth;

int horizontalSpacing;

int verticalSpacing;

this();

this(int numColumns, bool makeColumnsEqualWidth);

String toString();

}

Constructors

this this(): Constructs a new instance of this class.
this this(int numColumns, bool 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.

Members

Functions

toString String toString(): Returns a string containing a concise, human-readable description of the receiver.

Variables

horizontalSpacing int horizontalSpacing;: horizontalSpacing specifies the number of pixels between the right edge of one cell and the left edge of its neighbouring cell to the right.
makeColumnsEqualWidth bool makeColumnsEqualWidth;: makeColumnsEqualWidth specifies whether all columns in the layout will be forced to have the same width.
marginBottom int marginBottom;: marginBottom specifies the number of pixels of vertical margin that will be placed along the bottom edge of the layout.
marginHeight int marginHeight;: marginHeight specifies the number of pixels of vertical margin that will be placed along the top and bottom edges of the layout.
marginLeft int marginLeft;: marginLeft specifies the number of pixels of horizontal margin that will be placed along the left edge of the layout.
marginRight int marginRight;: marginRight specifies the number of pixels of horizontal margin that will be placed along the right edge of the layout.
marginTop int marginTop;: marginTop specifies the number of pixels of vertical margin that will be placed along the top edge of the layout.
marginWidth int marginWidth;: marginWidth specifies the number of pixels of horizontal margin that will be placed along the left and right edges of the layout.
numColumns 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.
verticalSpacing int verticalSpacing;: verticalSpacing specifies the number of pixels between the bottom edge of one cell and the top edge of its neighbouring cell underneath.

Inherited Members

From Layout

computeSize Point computeSize(Composite composite, int wHint, int hHint, bool flushCache): 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.
flushCache bool flushCache(Control control): Instruct the layout to flush any cached values associated with the control specified in the argument <code>control</code>.
layout void layout(Composite composite, bool flushCache): 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.