org.foray.pioneer
Class FlowPL

java.lang.Object
  org.foray.pioneer.FONodePL
      org.foray.pioneer.FObjPL
          org.foray.pioneer.AbstractFlowPL
              org.foray.pioneer.FlowPL

public class FlowPL
extends AbstractFlowPL

Pioneer Layout for Flow.

Field Summary

Fields inherited from class org.foray.pioneer.FONodePL

BREAK_AFTER, START

Constructor Summary

FlowPL(org.axsl.fo.fo.Flow flow, PioneerLS layout)
Constructor.

Method Summary

org.axsl.fo.fo.Flow	getFONode() Returns the FO Tree node that is being laid out by this layout item.
Status	layout(org.axsl.area.AreaNode areaNode, org.axsl.fo.fo.GraftingPoint graftingPoint) Each FONodePL subclass implements this method on a manner appropriate for its content.

Methods inherited from class org.foray.pioneer.AbstractFlowPL

getProgressSnapshot, getStatus, setProgressSnapshot, setStatus

Methods inherited from class org.foray.pioneer.FObjPL

getProgressSnapshot, layoutChildren, resetProgress, rollback

Methods inherited from class org.foray.pioneer.FONodePL

activeLineArea, addNonTextContent, addNonTextItemToLine, addTextItemToLine, getLayout, getLayoutProxy, getLogger, getProgress, setProgress, standardLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowPL

public FlowPL(org.axsl.fo.fo.Flow flow,
              PioneerLS layout)

Constructor.

Parameters:

flow - The FO Tree object which is being laid out.

layout - The ancestor layout system.

Method Detail

getFONode

public org.axsl.fo.fo.Flow getFONode()

Description copied from class: FONodePL

Returns the FO Tree node that is being laid out by this layout item.

Specified by:

getFONode in class FONodePL

Returns:

The FO Tree node that is being laid out.

layout

public Status layout(org.axsl.area.AreaNode areaNode,
                     org.axsl.fo.fo.GraftingPoint graftingPoint)
              throws org.axsl.area.AreaTreeException

Description copied from class: FONodePL

Each FONodePL subclass implements this method on a manner appropriate for its content.

Specified by:

layout in class FONodePL

Parameters:

areaNode - The Area in which the contents to be laid out by this should be placed. For example, for TableCellPL layout method, area should be a TableRowContainer. During the layout process, at least one TableCellArea should be created, which is then passed to layout for the children of the TableCell now being laid out.

graftingPoint - The RetrieveMarker instance, if any, into which this content will be laid out.

Returns:

An integer representing the status of this layout. When laying out FOText, this marks the index to the last character that was successfully laid out plus one, that is, it marks the next character to be laid out. For FObj subclasses, this indicates the index to the last child that was successfully laid out plus one, that is, it marks the next child that should be laid out.

Throws:

org.axsl.area.AreaTreeException - For errors during layout.