Eclipse Platform
Release 3.4

org.eclipse.jface.layout
Class AbstractColumnLayout

java.lang.Object
  extended byorg.eclipse.swt.widgets.Layout
      extended byorg.eclipse.jface.layout.AbstractColumnLayout
Direct Known Subclasses:
TableColumnLayout, TreeColumnLayout

public abstract class AbstractColumnLayout
extends Layout

The AbstractColumnLayout is a Layout used to set the size of a table in a consistent way even during a resize unlike a TableLayout which only sets initial sizes.

You can only add the layout to a container whose only child is the table/tree control you want the layouts applied to.

Since:
3.4

Constructor Summary
AbstractColumnLayout()
           
 
Method Summary
protected  Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache)
          Computes and returns the size of the specified composite's client area according to this layout.
protected  int getColumnTrim()
          The number of extra pixels taken as horizontal trim by the table column.
protected  void layout(Composite composite, boolean flushCache)
          Lays out the children of the specified composite according to this layout.
 void setColumnData(Widget column, ColumnLayoutData data)
          Adds a new column of data to this table 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 Detail

AbstractColumnLayout

public AbstractColumnLayout()
Method Detail

setColumnData

public void setColumnData(Widget column,
                          ColumnLayoutData data)
Adds a new column of data to this table layout.

Parameters:
column - the column
data - the column layout data

computeSize

protected Point computeSize(Composite composite,
                            int wHint,
                            int hHint,
                            boolean flushCache)
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:
composite - a composite widget using this layout
wHint - width (SWT.DEFAULT for preferred size)
hHint - height (SWT.DEFAULT for preferred size)
flushCache - 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

protected void layout(Composite composite,
                      boolean flushCache)
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:
composite - a composite widget using this layout
flushCache - true means flush cached layout values

getColumnTrim

protected int getColumnTrim()
The number of extra pixels taken as horizontal trim by the table column. To ensure there are N pixels available for the content of the column, assign N+COLUMN_TRIM for the column width.

Returns:
the trim used by the columns
Since:
3.4

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.