Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - LayoutManager (Eclipse Draw2d API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Draw2d
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.draw2d
Interface LayoutManager

All Known Implementing Classes:: AbstractLayout, FlowFigureLayout

public interface LayoutManager

A helper for positioning child figures and determining the ideal size for a figure with children.

Method Summary

java.lang.Object getConstraint ( IFigure child)
          Returns the constraint for the given figure.

Dimension getMinimumSize ( IFigure container, int wHint, int hHint)
          Returns the minimum size of the given figure.

Dimension getPreferredSize ( IFigure container, int wHint, int hHint)
          Returns the preferred size of the given figure, using width and height hints.

void invalidate ()
          Tells the LayoutManager to throw away all cached information about the figures it is responsible for.

void layout ( IFigure container)
          Lays out the given figure.

void remove ( IFigure child)
          Removes the given child from this layout.

void setConstraint ( IFigure child, java.lang.Object constraint)
          Sets the constraint for the given child.

Method Detail

getConstraint

public java.lang.Object getConstraint(
IFigure child)

Returns the constraint for the given figure.

Parameters:: child - The figure
Returns:: The constraint

getMinimumSize

public 
Dimension getMinimumSize(
IFigure container,
                                int wHint,
                                int hHint)

Returns the minimum size of the given figure.

Parameters:: container - The Figure; wHint - the width hint; hHint - the height hint
Returns:: The minimum size

getPreferredSize

public 
Dimension getPreferredSize(
IFigure container,
                                  int wHint,
                                  int hHint)

Returns the preferred size of the given figure, using width and height hints.

Parameters:: container - The figure; wHint - The width hint; hHint - The height hint
Returns:: The preferred size

invalidate

public void invalidate()

Tells the LayoutManager to throw away all cached information about the figures it is responsible for. This method is called whenever the owning figure is invalidated.

layout

public void layout(
IFigure container)

Lays out the given figure.

Parameters:: container - The figure

remove

public void remove(
IFigure child)

Removes the given child from this layout.

Parameters:: child - the child being remoced

setConstraint

public void setConstraint(
IFigure child,
                          java.lang.Object constraint)

Sets the constraint for the given child.

Parameters:: child - The figure; constraint - The constraint