Eclipse Draw2d
2.1

org.eclipse.draw2d.text
Class FlowPage

java.lang.Object
  |
  +--org.eclipse.draw2d.Figure
        |
        +--org.eclipse.draw2d.text.FlowFigure
              |
              +--org.eclipse.draw2d.text.BlockFlow
                    |
                    +--org.eclipse.draw2d.text.FlowPage
All Implemented Interfaces:
IFigure

public class FlowPage
extends BlockFlow

The root of a Flow hierarchy. A flow page can be treated as a normal figure, but contains FlowFigures.

A FlowPage will not have a defined width unless it is inside a figure whose layout provides width hints when calling IFigure.getPreferredSize(int, int).

WARNING: This class is not intended to be subclassed by clients.


Nested Class Summary
 
Nested classes inherited from class org.eclipse.draw2d.Figure
Figure.FigureIterator
 
Nested classes inherited from class org.eclipse.draw2d.IFigure
IFigure.NoInsets
 
Field Summary
 
Fields inherited from class org.eclipse.draw2d.Figure
bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip
 
Fields inherited from interface org.eclipse.draw2d.IFigure
MAX_DIMENSION, MIN_DIMENSION, NO_INSETS
 
Constructor Summary
FlowPage()
           
 
Method Summary
protected  FlowFigureLayout createDefaultFlowLayout()
          Creates the default layout manager
 Dimension getMinimumSize(int w, int h)
          Returns a hint indicating the smallest desireable size for the IFigure.
 Dimension getPreferredSize(int width, int h)
          Returns the desireable size for this IFigure using the provided width and height hints.
 void invalidate()
          Invalidates this IFigure.
 void postValidate()
          Called after validate has occurred.
 void setBounds(Rectangle r)
          FlowFigures override setBounds() to prevent translation of children.
 void validate()
          Causes this IFigure to layout itself, as well as its children.
 
Methods inherited from class org.eclipse.draw2d.text.BlockFlow
getBlockBox, getHorizontalAligment, setHorizontalAligment, useLocalCoordinates
 
Methods inherited from class org.eclipse.draw2d.text.FlowFigure
add, paintFigure, setFlowContext
 
Methods inherited from class org.eclipse.draw2d.Figure
add, add, add, addAncestorListener, addFigureListener, addFocusListener, addKeyListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidateTree, isEnabled, isFocusTraversable, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, paint, paintBorder, paintChildren, paintClientArea, primTranslate, remove, removeAll, removeAncestorListener, removeFigureListener, removeFocusListener, removeKeyListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FlowPage

public FlowPage()
Method Detail

createDefaultFlowLayout

protected FlowFigureLayout createDefaultFlowLayout()
Description copied from class: FlowFigure
Creates the default layout manager

Overrides:
createDefaultFlowLayout in class BlockFlow
See Also:
BlockFlow.createDefaultFlowLayout()

getMinimumSize

public Dimension getMinimumSize(int w,
                                int h)
Description copied from interface: IFigure
Returns a hint indicating the smallest desireable size for the IFigure. Returned Dimension is by value.

Specified by:
getMinimumSize in interface IFigure
Overrides:
getMinimumSize in class Figure
See Also:
Figure.getMinimumSize()

invalidate

public void invalidate()
Description copied from interface: IFigure
Invalidates this IFigure.

Specified by:
invalidate in interface IFigure
Overrides:
invalidate in class Figure
See Also:
Figure.invalidate()

getPreferredSize

public Dimension getPreferredSize(int width,
                                  int h)
Description copied from interface: IFigure
Returns the desireable size for this IFigure using the provided width and height hints. Returned Dimension is by value. If a hint is less than or equal to 0 (usually, it's set to -1), it means that hint should be ignored.

Specified by:
getPreferredSize in interface IFigure
Overrides:
getPreferredSize in class Figure
See Also:
Figure.getPreferredSize(int, int)

postValidate

public void postValidate()
Description copied from class: FlowFigure
Called after validate has occurred. This is used to update the bounds of the FlowFigure to encompass its new flow boxed created during validate.

Overrides:
postValidate in class BlockFlow
See Also:
BlockFlow.postValidate()

setBounds

public void setBounds(Rectangle r)
Description copied from class: FlowFigure
FlowFigures override setBounds() to prevent translation of children. "bounds" is a derived property for FlowFigures, calculated from the fragments that make up the FlowFigure.

Specified by:
setBounds in interface IFigure
Overrides:
setBounds in class FlowFigure
See Also:
FlowFigure.setBounds(Rectangle)

validate

public void validate()
Description copied from interface: IFigure
Causes this IFigure to layout itself, as well as its children.

Specified by:
validate in interface IFigure
Overrides:
validate in class Figure
See Also:
Figure.validate()

Eclipse Draw2d
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.