org.foray.pioneer
Class FObjPL

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

Direct Known Subclasses:

AbstractFlowPL, AbstractMixedInlinePL, AbstractTablePartPL, BlockContainerPL, BlockPL, ExternalGraphicPL, FootnoteBodyPL, FootnotePL, InstreamForeignObjectPL, LeaderPL, ListBlockPL, ListItemBodyPL, ListItemLabelPL, ListItemPL, MarkerPL, PageNumberCitationPL, PageNumberPL, RetrieveMarkerPL, TableCellPL, TablePL, TableRowPL, WrapperPL

public abstract class FObjPL
extends FONodePL

Abstract superclass for Pioneer Layout for all Fo instances.

Field Summary

Fields inherited from class org.foray.pioneer.FONodePL

BREAK_AFTER, START

Constructor Summary

FObjPL(org.axsl.fo.Fo realFObj, PioneerLS layout)
Constructor.

Method Summary

List<Integer>	getProgressSnapshot(List<Integer> inputSnapshot) Returns a snapshot (List) of the progress of this layout item and all descendant layout items.
protected Status	layoutChildren(org.axsl.area.AreaNode areaNode, org.axsl.fo.fo.GraftingPoint graftingPoint) Performs layout for this children of this object.
void	resetProgress() Resets the progress of the layout for the item to "START".
void	rollback(List<Integer> snapshot) Roll the layout progress back to a given snapshot.

Methods inherited from class org.foray.pioneer.FONodePL

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FObjPL

public FObjPL(org.axsl.fo.Fo realFObj,
              PioneerLS layout)

Constructor.

Parameters:

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

layout - The ancestor layout system.

Method Detail

resetProgress

public void resetProgress()

Description copied from class: FONodePL

Resets the progress of the layout for the item to "START".

Overrides:

resetProgress in class FONodePL

getProgressSnapshot

public List<Integer> getProgressSnapshot(List<Integer> inputSnapshot)

Returns a snapshot (List) of the progress of this layout item and all descendant layout items.

Overrides:

getProgressSnapshot in class FONodePL

Parameters:

inputSnapshot - The input (ancestor) snapshot.

Returns:

The snapshot.

rollback

public void rollback(List<Integer> snapshot)

Roll the layout progress back to a given snapshot.

Overrides:

rollback in class FONodePL

Parameters:

snapshot - The snapshot to which progress should be rolled back.

layoutChildren

protected Status layoutChildren(org.axsl.area.AreaNode areaNode,
                                org.axsl.fo.fo.GraftingPoint graftingPoint)
                         throws org.axsl.area.AreaTreeException

Performs layout for this children of this object.

Parameters:

areaNode - The area into which the children should be laid out.

graftingPoint - The ancestor grafting point, if any.

Returns:

The status of the layout.

Throws:

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