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

java.lang.Object
  

org.eclipse.draw2d.AbstractLayout
      
org.eclipse.draw2d.XYLayout

All Implemented Interfaces:: LayoutManager

Direct Known Subclasses:: FreeformLayout

public class XYLayout
extends AbstractLayout

This class implements the LayoutManager interface using the XY Layout algorithm. This lays out the components using the layout constraints as defined by each component.

Field Summary

protected java.util.Map constraints
          The layout contraints

Fields inherited from class org.eclipse.draw2d. AbstractLayout

isObservingVisibility, preferredSize

Constructor Summary

XYLayout ()


Method Summary

protected Dimension calculatePreferredSize ( IFigure f, int wHint, int hHint)
          Calculates and returns the preferred size of the input figure.

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

Point getOrigin ( IFigure parent)
          Returns the origin for the given figure.

void layout ( IFigure parent)
          Implements the algorithm to layout the components of the given container figure.

void remove ( IFigure figure)
          Removes the given figure from this LayoutManager's list of figures.

void setConstraint ( IFigure figure, java.lang.Object newConstraint)
          Sets the layout constraint of 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

Field Detail

constraints

protected java.util.Map constraints

The layout contraints

Constructor Detail

XYLayout

public XYLayout()

Method Detail

calculatePreferredSize

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

Calculates and returns the preferred size of the input figure. Since in XYLayout the location of the child should be preserved, the preferred size would be a region which would hold all the children of the input figure. If no constraint is set, that child is ignored for calculation. If width and height are not positive, the preferred dimensions of the child are taken.

Specified by:: calculatePreferredSize in class AbstractLayout

Parameters:: f - The figure; wHint - The width hint; hHint - The height hint
Returns:: The preferred size
Since:: 2.0
See Also:: AbstractLayout.calculatePreferredSize(IFigure, int, int)

getConstraint

public java.lang.Object getConstraint(
IFigure figure)

Description copied from class: AbstractLayout

Returns the constraint for the given figure.

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

Parameters:: figure - The figure
Returns:: The constraint
See Also:: LayoutManager.getConstraint(IFigure)

getOrigin

public 
Point getOrigin(
IFigure parent)

Returns the origin for the given figure.

Parameters:: parent - the figure whose origin is requested
Returns:: the origin

layout

public void layout(
IFigure parent)

Implements the algorithm to layout the components of the given container figure. Each component is laid out using its own layout constraint specifying its size and position.

Parameters:: parent - The figure
See Also:: LayoutManager.layout(IFigure)

remove

public void remove(
IFigure figure)