Eclipse Draw2d
2.1

org.eclipse.draw2d.text
Class InlineFlowLayout

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

public class InlineFlowLayout
extends FlowContainerLayout

The layout manager for InlineFlow 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
InlineFlowLayout(FlowFigure flow)
          Creates a new InlineFlowLayout with the given FlowFigure.
 
Method Summary
 void addToCurrentLine(FlowBox block)
          Adds the given FlowBox to the current line of this InlineFlowLayout.
protected  void cleanup()
          Flush anything pending and free all temporary data used during layout.
protected  void createNewLine()
          Used by getCurrentLine().
 void endLine()
          The current line should be committed if it is occupied, and then set to null.
protected  void flush()
          Called after FlowContainerLayout.layoutChildren() when all children have been laid out.
 int getCurrentY()
          Returns the current Y value.
 boolean isCurrentLineOccupied()
           
 void preLayout()
          Clears out all fragments prior to the call to layoutChildren().
protected  void setupLine(LineBox line)
          Initializes the given LineBox.
 
Methods inherited from class org.eclipse.draw2d.text.FlowContainerLayout
getCurrentLine, layout, layoutChildren
 
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

InlineFlowLayout

public InlineFlowLayout(FlowFigure flow)
Creates a new InlineFlowLayout with the given FlowFigure.

Parameters:
flow - The FlowFigure
Method Detail

addToCurrentLine

public void addToCurrentLine(FlowBox block)
Adds the given FlowBox to the current line of this InlineFlowLayout.

Specified by:
addToCurrentLine in interface FlowContext
Overrides:
addToCurrentLine in class FlowContainerLayout
Parameters:
block - the FlowBox to add to the current line
See Also:
FlowContext.addToCurrentLine(FlowBox)

createNewLine

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

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

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()

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()

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()

getCurrentY

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

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

isCurrentLineOccupied

public boolean isCurrentLineOccupied()
Specified by:
isCurrentLineOccupied in interface FlowContext
Overrides:
isCurrentLineOccupied in class FlowContainerLayout
See Also:
FlowContainerLayout.isCurrentLineOccupied()

preLayout

public void preLayout()
Clears out all fragments prior to the call to layoutChildren().

Specified by:
preLayout in class FlowContainerLayout

setupLine

protected void setupLine(LineBox line)
Initializes the given LineBox. Called by createNewLine().

Parameters:
line - The LineBox to initialize.

Eclipse Draw2d
2.1

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