public final class TableWrapLayout extends Layout implements ILayoutExtension
The advantage of the algorithm over GridLayout is that it is capable of flowing text controls capable of line wrap. These controls do not have natural 'preferred size'. Instead, they are capable of providing the required height if the width is set. Consequently, this algorithm first calculates the widths that will be assigned to columns, and then passes those widths to the controls to calculate the height. When a composite with this layout is a child of the scrolling composite, they should interact in such a way that reduction in the scrolling composite width results in the reflow and increase of the overall height.
If none of the columns contain expandable and wrappable controls, the end-result will be similar to the one provided by GridLayout. The difference will show up for layouts that contain controls whose minimum and maximum widths are not the same.
TableWrapData
Modifier and Type | Field and Description |
---|---|
int |
bottomMargin
Botom margin variable (default is 5).
|
int |
horizontalSpacing
Horizontal spacing (default is 5).
|
int |
leftMargin
Left margin variable (default is 5).
|
boolean |
makeColumnsEqualWidth
If set to
true , all the columns will have the same width. |
int |
numColumns
Number of columns to use when positioning children (default is 1).
|
int |
rightMargin
Right margin variable (default is 5).
|
int |
topMargin
Top margin variable (default is 5).
|
int |
verticalSpacing
Vertical spacing (default is 5).
|
Constructor and Description |
---|
TableWrapLayout() |
Modifier and Type | Method and Description |
---|---|
int |
computeMaximumWidth(Composite parent,
boolean changed)
Implements ILayoutExtension.
|
int |
computeMinimumWidth(Composite parent,
boolean changed)
Implements ILayoutExtension.
|
protected Point |
computeSize(Composite parent,
int wHint,
int hHint,
boolean changed)
Computes and returns the size of the specified
composite's client area according to this layout.
|
protected void |
layout(Composite parent,
boolean changed)
Lays out the children of the specified composite
according to this layout.
|
flushCache
public int numColumns
public int leftMargin
public int rightMargin
public int topMargin
public int bottomMargin
public int horizontalSpacing
public int verticalSpacing
public boolean makeColumnsEqualWidth
true
, all the columns will have the same width.
Otherwise, column widths will be computed based on controls in them and
their layout data (default is false
).public int computeMinimumWidth(Composite parent, boolean changed)
computeMinimumWidth
in interface ILayoutExtension
parent
- the parent compositechanged
- true
if the cached information should be
flushed, false
otherwise.ILayoutExtension
public int computeMaximumWidth(Composite parent, boolean changed)
computeMaximumWidth
in interface ILayoutExtension
parent
- the parent compositechanged
- true
if the cached information
should be flushed, false
otherwise.ILayoutExtension
protected void layout(Composite parent, boolean changed)
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.
layout
in class Layout
parent
- a composite widget using this layoutchanged
- true
means flush cached layout valuesLayout.layout(Composite, boolean)
protected Point computeSize(Composite parent, int wHint, int hHint, boolean changed)
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.
computeSize
in class Layout
parent
- a composite widget using this layoutwHint
- width (SWT.DEFAULT
for preferred size)hHint
- height (SWT.DEFAULT
for preferred size)changed
- true
means flush cached layout valuesLayout.computeSize(Composite, int, int, boolean)
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.