Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - DelegatingLayout (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
Class DelegatingLayout

java.lang.Object
  

org.eclipse.draw2d.AbstractLayout
      
org.eclipse.draw2d.DelegatingLayout

All Implemented Interfaces:: LayoutManager

public class DelegatingLayout
extends AbstractLayout

Figures using a DelegatingLayout as their layout manager give location responsibilities to their children. The children of a Figure using a DelegatingLayout should have a Locator as a constraint whose relocate method is responsible for placing the child.

Field Summary

Fields inherited from class org.eclipse.draw2d. AbstractLayout

isObservingVisibility, preferredSize

Constructor Summary

DelegatingLayout ()


Method Summary

protected Dimension calculatePreferredSize ( IFigure parent, int wHint, int hHint)
          Calculates the preferred size of the given Figure.

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

void layout ( IFigure parent)
          Lays out the given figure's children based on their Locator constraint.

void remove ( IFigure child)
          Removes the locator for the given figure.

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

Methods inherited from class org.eclipse.draw2d. AbstractLayout

calculatePreferredSize, getBorderPreferredSize, getMinimumSize, getMinimumSize, getPreferredSize, getPreferredSize, invalidate, invalidate, isObservingVisibility, setObserveVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatingLayout

public DelegatingLayout()

Method Detail

calculatePreferredSize

protected 
Dimension calculatePreferredSize(
IFigure parent,
                                           int wHint,
                                           int hHint)

Calculates the preferred size of the given Figure. For the DelegatingLayout, this is the largest width and height values of the passed Figure's children.

Specified by:: calculatePreferredSize in class AbstractLayout

Parameters:: parent - the figure whose preferred size is being calculated; wHint - the width hint; hHint - the height hint
Returns:: the preferred size
Since:: 2.0

getConstraint

public java.lang.Object getConstraint(
IFigure child)

Description copied from class: AbstractLayout

Returns the constraint for the given figure.

Specified by:: getConstraint in interface LayoutManager
Overrides:: getConstraint in class AbstractLayout

Parameters:: child - The figure
Returns:: The constraint
See Also:: LayoutManager.getConstraint(org.eclipse.draw2d.IFigure)

layout

public void layout(
IFigure parent)

Lays out the given figure's children based on their Locator constraint.

Parameters:: parent - the figure whose children should be layed out

remove

public void remove(
IFigure child)

Removes the locator for the given figure.

Specified by:: remove in interface LayoutManager
Overrides:: remove in class AbstractLayout

Parameters:: child - the child being removed

setConstraint

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

Sets the constraint for the given figure.

Specified by:: setConstraint in interface LayoutManager
Overrides:: setConstraint in class AbstractLayout

Parameters:: figure - the figure whose contraint is being set; constraint - the new constraint