org.foray.pioneer
Class BlockPL

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

public class BlockPL
extends FObjPL

Pioneer Layout for Block.

Field Summary

Fields inherited from class org.foray.pioneer.FONodePL

BREAK_AFTER, START

Constructor Summary

BlockPL(org.axsl.fo.fo.Block realFObj, PioneerLS layout)
Constructor.

Method Summary

void	completeCurrentLine() Notify this block that the area has completed layout.
org.axsl.area.LineArea	getCurrentLineArea(org.axsl.area.NormalBlockArea blockArea) Get the current line area in this block area.
org.axsl.fo.fo.Block	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.
void	resetProgress() Resets the progress of the layout for the item to "START".
void	setCurrentLineArea(org.axsl.area.LineArea currentLineArea) Set the current line area.

Methods inherited from class org.foray.pioneer.FObjPL

getProgressSnapshot, layoutChildren, 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

BlockPL

public BlockPL(org.axsl.fo.fo.Block 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 FObjPL

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.

getCurrentLineArea

public org.axsl.area.LineArea getCurrentLineArea(org.axsl.area.NormalBlockArea blockArea)
                                          throws org.axsl.area.AreaTreeException

Get the current line area in this block area. This is used to get the current line area for adding inline objects. This will return null if there is not enough room left in the block area to accomodate the line area.

Parameters:

blockArea - The block area (last one generated by this block??).

Returns:

The line area to be used to add inline objects.

Throws:

org.axsl.area.AreaTreeException - For errors creating the next line area.

completeCurrentLine

public void completeCurrentLine()

Notify this block that the area has completed layout. Indicates the the block has been fully laid out, this will add (if any) the current line area.

setCurrentLineArea

public void setCurrentLineArea(org.axsl.area.LineArea currentLineArea)

Set the current line area.

Parameters:

currentLineArea - The currentLineArea to set.

getFONode

public org.axsl.fo.fo.Block 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.