Package org.eclipse.jface.viewers

Class TableLayout

java.lang.Object

org.eclipse.swt.widgets.Layout

org.eclipse.jface.viewers.TableLayout

public class TableLayout
extends Layout

A layout for a table. Call addColumnData to add columns. The TableLayout ColumnLayoutData is only valid until the table is resized. To keep the proportions constant when the table is resized see TableColumnLayout

Constructor Summary

Constructors

Constructor	Description
TableLayout()	Creates a new table layout.
TableLayout(boolean adjustForScrollBar)	Creates a new table layout.

Method Summary

Modifier and Type	Method	Description
void	addColumnData(ColumnLayoutData data)	Adds a new column of data to this table layout.
Point	computeSize(Composite c, int wHint, int hHint, boolean flush)	Computes and returns the size of the specified composite's client area according to this layout.
void	layout(Composite c, boolean flush)	Lays out the children of the specified composite according to this layout.

Methods inherited from class org.eclipse.swt.widgets.Layout

flushCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TableLayout

public TableLayout()

Creates a new table layout.

TableLayout

public TableLayout(boolean adjustForScrollBar)

Creates a new table layout.

Parameters:

adjustForScrollBar - true if the layout should reserve space for the vertical scroll bar

Since:

3.9

Method Details

addColumnData

public void addColumnData(ColumnLayoutData data)

Adds a new column of data to this table layout.

Parameters:

data - the column layout data

computeSize

public Point computeSize(Composite c,
 int wHint,
 int hHint,
 boolean flush)

Description copied from class: Layout

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.

Specified by:

computeSize in class Layout

Parameters:

c - a composite widget using this layout

wHint - width (SWT.DEFAULT for preferred size)

hHint - height (SWT.DEFAULT for preferred size)

flush - true means flush cached layout values

Returns:

a point containing the computed size (width, height)

See Also:

• Layout.layout(org.eclipse.swt.widgets.Composite, boolean)
• Control.getBorderWidth()
• Control.getBounds()
• Control.getSize()
• Control.pack(boolean)
• "computeTrim, getClientArea for controls that implement them"

layout

public void layout(Composite c,
 boolean flush)

Description copied from class: 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.

Specified by:

layout in class Layout

Parameters:

c - a composite widget using this layout

flush - true means flush cached layout values