Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.swt.widgets
Class WeightedLayout  view WeightedLayout download WeightedLayout.java

java.lang.Object
  extended byorg.eclipse.swt.widgets.Layout
      extended byorg.eclipse.swt.widgets.WeightedLayout

public class WeightedLayout
extends Layout

The SashForm lays out its children in a Row or Column arrangement (as specified by the orientation) and places a Sash between the children. One child may be maximized to occupy the entire size of the SashForm. The relative sizes of the children may be specfied using weights.

Styles:
HORIZONTAL, VERTICAL


Field Summary
 int fSpacing
           
(package private)  int fTotal
           
private  int[] fWeights
           
 int fXMargin
           
 int fYMargin
           
private  boolean isVertical
           
 
Constructor Summary
WeightedLayout(int style, int[] weights, int xmargin, int ymargin, int spacing)
          Constructor for WeightedLayout.
 
Method Summary
protected  org.eclipse.swt.graphics.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.
 int[] getWeights()
          Answer the relative weight of each child in the SashForm.
 boolean isVertical()
           
protected  void layout(Composite composite, boolean flushCache)
          Lays out the children of the specified composite according to this layout.
 void setOrientation(boolean vertical)
           
 void setWeights(int[] weights)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fXMargin

public int fXMargin

fYMargin

public int fYMargin

fSpacing

public int fSpacing

isVertical

private boolean isVertical

fWeights

private int[] fWeights

fTotal

int fTotal
Constructor Detail

WeightedLayout

public WeightedLayout(int style,
                      int[] weights,
                      int xmargin,
                      int ymargin,
                      int spacing)
Constructor for WeightedLayout.

Method Detail

computeSize

protected org.eclipse.swt.graphics.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 minimum size that the client area of the composite must be in order to position all children at their minimum 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 minimum 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

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 layed 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

isVertical

public boolean isVertical()

getWeights

public int[] getWeights()
Answer the relative weight of each child in the SashForm. The weight represents the percent of the total width (if SashForm has Horizontal orientation) or total height (if SashForm has Vertical orientation) each control occupies. The weights are returned in order of the creation of the widgets (weight[0] corresponds to the weight of the first child created).


setOrientation

public void setOrientation(boolean vertical)

setWeights

public void setWeights(int[] weights)