Top Description Constructors Methods
org.eclipse.swt.widgets

public abstract Class Layout

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.swt.custom.CBannerLayout, org.eclipse.swt.custom.CTabFolderLayout, org.eclipse.swt.custom.SashFormLayout, org.eclipse.swt.custom.ScrolledCompositeLayout, org.eclipse.swt.custom.StackLayout, org.eclipse.swt.custom.ViewFormLayout, org.eclipse.swt.layout.BorderLayout, org.eclipse.swt.layout.FillLayout, org.eclipse.swt.layout.FormLayout, org.eclipse.swt.layout.GridLayout, org.eclipse.swt.layout.RowLayout
Imports
org.eclipse.swt.graphics.*

A layout controls the position and size of the children of a composite widget. This class is the abstract base class for layouts.
See Also
Composite#setLayout(Layout), Sample code and further information

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected abstract Point

Returns:

a point containing the computed size (width, height)
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
)

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

protected boolean

Returns:

true if the Layout has flushed all cached information associated with control
flushCache
(Control
a control managed by this layout
control
)

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

protected abstract void
layout(Composite
a composite widget using this layout
composite
,
boolean
true means flush cached layout values
flushCache
)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Layoutback to summary
public Layout()

Method Detail

computeSizeback to summary
protected abstract 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.

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)

See Also
layout, Control#getBorderWidth, Control#getBounds, Control#getSize, Control#pack(boolean), computeTrim, getClientArea for controls that implement them
flushCacheback to summary
protected boolean flushCache(Control control)

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

Since
3.1
layoutback to summary
protected abstract void layout(Composite composite, boolean 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.

Parameters
composite:Composite

a composite widget using this layout

flushCache:boolean

true means flush cached layout values