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

java.lang.Object
  

org.eclipse.draw2d.AbstractLayout
      

org.eclipse.draw2d.AbstractHintLayout
          
org.eclipse.draw2d.ViewportLayout

All Implemented Interfaces:: LayoutManager

public class ViewportLayout
extends AbstractHintLayout

Layout for a viewport. A viewport is a flexible window onto a figure.

Field Summary

Fields inherited from class org.eclipse.draw2d. AbstractLayout

isObservingVisibility, preferredSize

Constructor Summary

ViewportLayout ()


Method Summary

protected Dimension calculateMinimumSize ( IFigure figure, int wHint, int hHint)
          Returns the minimum size required by the input viewport figure.

protected Dimension calculatePreferredSize ( IFigure parent, int wHint, int hHint)
          Calculates and returns the preferred size of the figure based on the given hints.

protected boolean isSensitiveHorizontally ( IFigure parent)
          Returns whether this layout manager is sensitive to changes in the horizontal hint.

protected boolean isSensitiveVertically ( IFigure parent)
          Returns whether this layout manager is sensitive to changes in the vertical hint.

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

Methods inherited from class org.eclipse.draw2d. AbstractHintLayout

getMinimumSize, getPreferredSize, invalidate

Methods inherited from class org.eclipse.draw2d. AbstractLayout

calculatePreferredSize, getBorderPreferredSize, getConstraint, getMinimumSize, getPreferredSize, invalidate, isObservingVisibility, remove, setConstraint, setObserveVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewportLayout

public ViewportLayout()

Method Detail

calculateMinimumSize

protected 
Dimension calculateMinimumSize(
IFigure figure,
                                         int wHint,
                                         int hHint)

Returns the minimum size required by the input viewport figure. Since viewport is flexible, the minimum size required would be the just the size of the borders.

Overrides:: calculateMinimumSize in class AbstractHintLayout

Parameters:: figure - the Figure on which this layout is installed; wHint - the width hint; hHint - the height hint
Returns:: the layout's minimum size
See Also:: AbstractHintLayout.calculateMinimumSize(IFigure, int, int)

calculatePreferredSize

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

Calculates and returns the preferred size of the figure based on the given hints. The given wHint is ignored unless the viewport (parent) is tracking width. The same is true for the height hint.

Specified by:: calculatePreferredSize in class AbstractLayout

Parameters:: parent - the Viewport whose preferred size is to be calculated; wHint - the width hint; hHint - the height hint
Returns:: the Preferred size of the given viewport
Since:: 2.0

isSensitiveHorizontally

protected boolean isSensitiveHorizontally(
IFigure parent)

Description copied from class: AbstractHintLayout

Returns whether this layout manager is sensitive to changes in the horizontal hint. By default, this method returns true.

Overrides:: isSensitiveHorizontally in class AbstractHintLayout

Parameters:: parent - the layout's container
Returns:: true if this layout is sensite to horizontal hint changes
See Also:: AbstractHintLayout.isSensitiveHorizontally(IFigure)

isSensitiveVertically

protected boolean isSensitiveVertically(
IFigure parent)