Top Description Fields Constructors Methods
org.eclipse.swt.layout

public Class BorderLayout

extends Layout
Class Inheritance
Static Imports
org.eclipse.swt.SWT.*
BorderLayout places controls in five regions 
+--------------------------------+
|       NORTH / TOP              |
+---+------------------------+---+
|   |                        |   |
| W |                        | E |
| E |                        | A |
| S |                        | S |
| T |                        | T |
| / |                        | / |
| L |       CENTER           | R |
| E |                        | I |
| F |                        | G |
| T |                        | H |
|   |                        | T |
|   |                        |   |
+---+------------------------+---+
|       SOUTH / BOTTOM           |
+--------------------------------+
The controls at the NORTH/SOUTH borders get their preferred heights, the controls at the EAST/WEST get their preferred widths and the center region grow/shrink according to the remaining space. If more than one control is placed inside a region the controls are equally distributed across their axis where the grow (CENTER controlled by the BorderLayout#type value)
Since
3.119

Field Summary

Modifier and TypeField and Description
public int
controlSpacing

controlSpacing specifies the number of points between the edge of one control and its neighboring control inside a region.

private static final ToIntFunction<Point>
HEIGHT

public double
heightDistributionFactor

If the height of the SWT#TOP and SWT#BOTTOM region exceeds the available space this factor is used to distribute the size to the controls, valid values range between [0 ...

private static final String
LAYOUT_KEY

public int
marginHeight

marginHeight specifies the number of points of vertical margin that will be placed along the top and bottom edges of the layout.

public int
marginWidth

marginWidth specifies the number of points of horizontal margin that will be placed along the left and right edges of the layout.

public int
spacing

spacing specifies the number of points between the edge of one region and its neighboring regions.

public int
type

type specifies how controls will be positioned within the center region.

private static final ToIntFunction<Point>
WIDTH

public double
widthDistributionFactor

If the width of the SWT#LEFT and SWT#RIGHT region exceeds the available space this factor is used to distribute the size to the controls, valid values range between [0 ...

Constructor Summary

AccessConstructor and Description
public
BorderLayout()

Method Summary

Modifier and TypeMethod and Description
private <C extends Control> Map.Entry<C, BorderData>
borderDataControl(C control, boolean flushCache)

protected Point
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)

Implements abstract org.eclipse.swt.widgets.Layout.computeSize.

Computes and returns the size of the specified composite's client area according to this layout.
private static int
getMax(ToIntFunction<Point> extractor, int region, Map<Integer, List<Map.Entry<Control, BorderData>>> regionMap)

private static int
getMax(ToIntFunction<Point> extractor, List<Map.Entry<Control, BorderData>> list, int maxW, int maxH, boolean flushCache)

private int

Returns:

the total W/H including the controlSpacing
getTotal(ToIntFunction<Point>
either WIDTH or HEIGHT
extractor, int
the region to compute
region, Map<Integer, List<Map.Entry<Control, BorderData>>>
the map of regions
regionMap)

Calculates the total W/H according to the extractor

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

Implements abstract org.eclipse.swt.widgets.Layout.layout.

Lays out the children of the specified composite according to this layout.
private static int
region(Map.Entry<Control, BorderData> entry)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.eclipse.swt.widgets.Layout:
flushCache

Field Detail

controlSpacingback to summary
public int controlSpacing

controlSpacing specifies the number of points between the edge of one control and its neighboring control inside a region. The default value is 0.

HEIGHTback to summary
private static final ToIntFunction<Point> HEIGHT
heightDistributionFactorback to summary
public double heightDistributionFactor

If the height of the SWT#TOP and SWT#BOTTOM region exceeds the available space this factor is used to distribute the size to the controls, valid values range between [0 ... 1] The default value is 0.5 (equal distribution of available space)

LAYOUT_KEYback to summary
private static final String LAYOUT_KEY
marginHeightback to summary
public int marginHeight

marginHeight specifies the number of points of vertical margin that will be placed along the top and bottom edges of the layout. The default value is 0.

marginWidthback to summary
public int marginWidth

marginWidth specifies the number of points of horizontal margin that will be placed along the left and right edges of the layout. The default value is 0.

spacingback to summary
public int spacing

spacing specifies the number of points between the edge of one region and its neighboring regions. The default value is 0.

typeback to summary
public int type

type specifies how controls will be positioned within the center region. The default value is SWT#HORIZONTAL. Possible values are:

  • SWT#HORIZONTAL: Position the controls horizontally from left to right
  • SWT#VERTICAL: Position the controls vertically from top to bottom
WIDTHback to summary
private static final ToIntFunction<Point> WIDTH
widthDistributionFactorback to summary
public double widthDistributionFactor

If the width of the SWT#LEFT and SWT#RIGHT region exceeds the available space this factor is used to distribute the size to the controls, valid values range between [0 ... 1] The default value is 0.5 (equal distribution of available space)

Constructor Detail

BorderLayoutback to summary
public BorderLayout()

Method Detail

borderDataControlback to summary
private <C extends Control> Map.Entry<C, BorderData> borderDataControl(C control, boolean flushCache)
computeSizeback to summary
protected Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache)

Implements abstract org.eclipse.swt.widgets.Layout.computeSize.

Doc from org.eclipse.swt.widgets.Layout.computeSize.

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)

Annotations
@Override
getMaxback to summary
private static int getMax(ToIntFunction<Point> extractor, int region, Map<Integer, List<Map.Entry<Control, BorderData>>> regionMap)
getMaxback to summary
private static int getMax(ToIntFunction<Point> extractor, List<Map.Entry<Control, BorderData>> list, int maxW, int maxH, boolean flushCache)
getTotalback to summary
private int getTotal(ToIntFunction<Point> extractor, int region, Map<Integer, List<Map.Entry<Control, BorderData>>> regionMap)

Calculates the total W/H according to the extractor

Parameters
extractor:ToIntFunction<Point>

either WIDTH or HEIGHT

region:int

the region to compute

regionMap:Map<Integer, List<Map.Entry<Control, BorderData>>>

the map of regions

Returns:int

the total W/H including the controlSpacing

layoutback to summary
protected void layout(Composite composite, boolean flushCache)

Implements abstract org.eclipse.swt.widgets.Layout.layout.

Doc from org.eclipse.swt.widgets.Layout.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.

Parameters
composite:Composite

a composite widget using this layout

flushCache:boolean

true means flush cached layout values

Annotations
@Override
regionback to summary
private static int region(Map.Entry<Control, BorderData> entry)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override