Eclipse Draw2d
2.1

org.eclipse.draw2d.text
Class FlowContainerLayout

java.lang.Object
  |
  +--org.eclipse.draw2d.AbstractLayout
        |
        +--org.eclipse.draw2d.text.FlowFigureLayout
              |
              +--org.eclipse.draw2d.text.FlowContainerLayout
All Implemented Interfaces:
FlowContext, LayoutManager
Direct Known Subclasses:
BlockFlowLayout, InlineFlowLayout

public abstract class FlowContainerLayout
extends FlowFigureLayout
implements FlowContext

A layout for FlowFigures with children.

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

Since:
2.1

Field Summary
protected  LineBox currentLine
          the current line
 
Fields inherited from class org.eclipse.draw2d.text.FlowFigureLayout
context, invalid
 
Fields inherited from class org.eclipse.draw2d.AbstractLayout
preferredSize
 
Constructor Summary
protected FlowContainerLayout(FlowFigure flowFigure)
           
 
Method Summary
 void addToCurrentLine(FlowBox block)
          Adds the given box into the current line.
protected abstract  void cleanup()
          Flush anything pending and free all temporary data used during layout.
protected abstract  void createNewLine()
          Used by getCurrentLine().
protected abstract  void flush()
          Called after layoutChildren() when all children have been laid out.
 LineBox getCurrentLine()
          Obtains the current line, creating a new line if there is no current line.
 boolean isCurrentLineOccupied()
           
protected  void layout()
          Called during FlowFigureLayout.layout(IFigure).
protected  void layoutChildren()
          Layout all children.
protected abstract  void preLayout()
          Called before layoutChildren() to setup any necessary state.
 
Methods inherited from class org.eclipse.draw2d.text.FlowFigureLayout
calculatePreferredSize, getFlowFigure, invalidate, layout, setFlowContext
 
Methods inherited from class org.eclipse.draw2d.AbstractLayout
calculatePreferredSize, getBorderPreferredSize, getConstraint, getMinimumSize, getMinimumSize, getPreferredSize, getPreferredSize, invalidate, remove, setConstraint
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.draw2d.text.FlowContext
endLine, getCurrentY
 

Field Detail

currentLine

protected LineBox currentLine
the current line

Constructor Detail

FlowContainerLayout

protected FlowContainerLayout(FlowFigure flowFigure)
See Also:
FlowFigureLayout.FlowFigureLayout(FlowFigure)
Method Detail

addToCurrentLine

public void addToCurrentLine(FlowBox block)
Description copied from interface: FlowContext
Adds the given box into the current line.

Specified by:
addToCurrentLine in interface FlowContext
Parameters:
block - the FlowBox to add
See Also:
FlowContext.addToCurrentLine(FlowBox)

cleanup

protected abstract void cleanup()
Flush anything pending and free all temporary data used during layout.


createNewLine

protected abstract void createNewLine()
Used by getCurrentLine().


flush

protected abstract void flush()
Called after layoutChildren() when all children have been laid out. This method exists to flush the last line.


getCurrentLine

public LineBox getCurrentLine()
Description copied from interface: FlowContext
Obtains the current line, creating a new line if there is no current line.

Specified by:
getCurrentLine in interface FlowContext
Returns:
the current line
See Also:
FlowContext.getCurrentLine()

isCurrentLineOccupied

public boolean isCurrentLineOccupied()
Specified by:
isCurrentLineOccupied in interface FlowContext
Returns:
true if the current line contains any fragments
See Also:
FlowContext.isCurrentLineOccupied()

layout

protected void layout()
Description copied from class: FlowFigureLayout
Called during FlowFigureLayout.layout(IFigure). The FlowFigureLayout.invalid flag is reset after this method is called.

Specified by:
layout in class FlowFigureLayout
See Also:
FlowFigureLayout.layout()

layoutChildren

protected void layoutChildren()
Layout all children.


preLayout

protected abstract void preLayout()
Called before layoutChildren() to setup any necessary state.


Eclipse Draw2d
2.1

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