Eclipse Draw2d
2.1

org.eclipse.draw2d.text
Class BlockFlowLayout

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

public class BlockFlowLayout
extends FlowContainerLayout

The layout for BlockFlow figures.

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

Since:
2.1

Field Summary
 
Fields inherited from class org.eclipse.draw2d.text.FlowContainerLayout
currentLine
 
Fields inherited from class org.eclipse.draw2d.text.FlowFigureLayout
context, invalid
 
Fields inherited from class org.eclipse.draw2d.AbstractLayout
preferredSize
 
Constructor Summary
BlockFlowLayout(BlockFlow blockFlow)
          Creates a new BlockFlowLayout with the given BlockFlow.
 
Method Summary
protected  void cleanup()
          Flush anything pending and free all temporary data used during layout.
protected  void createNewLine()
          Used by getCurrentLine().
protected  void endBlock()
          Called by flush(), adds the BlockBox associated with this BlockFlowLayout to the current line and then ends the line.
 void endLine()
          The current line should be committed if it is occupied, and then set to null.
protected  void flush()
          Called after layoutChildren() when all children have been laid out.
protected  BlockFlow getBlockFlow()
          Returns the BlockFlow associated with this BlockFlowLayout
 int getCurrentY()
          Returns the current Y value.
protected  void layoutChildren()
          Layout all children.
protected  void layoutLine()
          Adjust all fragments in the current line to have the same baseline.
protected  void preLayout()
          Called before layoutChildren() to setup any necessary state.
protected  void setupBlock()
          sets up the single block that contains all of the lines.
protected  void setupLine(LineBox line)
          Override to setup the line's x, remaining, and available width.
 
Methods inherited from class org.eclipse.draw2d.text.FlowContainerLayout
addToCurrentLine, getCurrentLine, isCurrentLineOccupied, layout
 
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
 

Constructor Detail

BlockFlowLayout

public BlockFlowLayout(BlockFlow blockFlow)
Creates a new BlockFlowLayout with the given BlockFlow.

Parameters:
blockFlow - the BlockFlow
Method Detail

cleanup

protected void cleanup()
Description copied from class: FlowContainerLayout
Flush anything pending and free all temporary data used during layout.

Specified by:
cleanup in class FlowContainerLayout
See Also:
FlowContainerLayout.cleanup()

createNewLine

protected void createNewLine()
Description copied from class: FlowContainerLayout
Used by getCurrentLine().

Specified by:
createNewLine in class FlowContainerLayout
See Also:
FlowContainerLayout.createNewLine()

endBlock

protected void endBlock()
Called by flush(), adds the BlockBox associated with this BlockFlowLayout to the current line and then ends the line.


endLine

public void endLine()
Description copied from interface: FlowContext
The current line should be committed if it is occupied, and then set to null. Otherwise, do nothing.

See Also:
FlowContext.endLine()

layoutChildren

protected void layoutChildren()
Description copied from class: FlowContainerLayout
Layout all children.

Overrides:
layoutChildren in class FlowContainerLayout
See Also:
FlowContainerLayout.layoutChildren()

getCurrentY

public int getCurrentY()
Description copied from interface: FlowContext
Returns the current Y value.

Returns:
the current Y value
See Also:
FlowContext.getCurrentY()

getBlockFlow

protected final BlockFlow getBlockFlow()
Returns the BlockFlow associated with this BlockFlowLayout

Returns:
the BlockFlow

layoutLine

protected void layoutLine()
Adjust all fragments in the current line to have the same baseline. Do any additional adjustments, such as horizontal alignment.


flush

protected void flush()
Description copied from class: FlowContainerLayout
Called after FlowContainerLayout.layoutChildren() when all children have been laid out. This method exists to flush the last line.

Specified by:
flush in class FlowContainerLayout
See Also:
FlowContainerLayout.flush()

preLayout

protected void preLayout()
Description copied from class: FlowContainerLayout
Called before layoutChildren() to setup any necessary state.

Specified by:
preLayout in class FlowContainerLayout
See Also:
FlowContainerLayout.preLayout()

setupBlock

protected void setupBlock()
sets up the single block that contains all of the lines.


setupLine

protected void setupLine(LineBox line)
Override to setup the line's x, remaining, and available width.

Parameters:
line - the LineBox to set up

Eclipse Draw2d
2.1

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