org.axsl.areaW
Interface MainRA

All Superinterfaces:

Area, AreaNode, FOContext, OrderedTreeNode, javax.swing.tree.TreeNode

public interface MainRA

extends Area

Manages the main-reference-area. Its parent should always be an instance of RegionRABody, and its children should always be instances of SpanRA.

Method Summary

NormalFlowRA	getNextWritableArea(FObj fo) Depending on the column-count of the next FO, determine whether a new span area needs to be constructed or not, and return the appropriate NormalFlowArea.
boolean	isBalancingRequired(FObj fo) Indicates whether adding a new object to this main-reference area will require any balancing work.
boolean	isLastColumn() Indicates whether the current column in this area is the last column.
boolean	isNewSpanArea() Indicates whether the currently-active span area in this Area is newly created.
void	resetSpanArea() Resets the the just-done span area in preparation for a backtrack for balancing.

Methods inherited from interface org.axsl.areaW.Area

crBPD, crIPD, incrementProgressionDimension, makeBlockContainerArea, makeListBlockArea, makeMarkerContentArea, makeNormalBlockArea, makeTableArea, progressionDimensionAvailable, setProgressionDimension, traitAbsolutePosition

Methods inherited from interface org.axsl.areaW.AreaNode

ancestorTableArea, ancestorWritableNormalBlockArea, crBPDNearestGeneratedByBlockLevelFO, crIPDNearestGeneratedByBlockLevelFO, getFontConsumer, getTextServer, getWritablePage, getWritableParent, getWritableParentArea, nearestGeneratedByBlockLevelFO, removeChild, traitGeneratedBy

Methods inherited from interface org.axsl.common.OrderedTreeNode

getChildren, getFirstChild, getFirstLeaf, getLastChild, getLastLeaf, getNextLeaf, getNextSibling, getPreviousLeaf, getPreviousSibling, getSiblings, hasChildren, nextPreOrderNode, siblingIndex

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface org.axsl.foR.FOContext

getRetrieveMarker

Method Detail

isBalancingRequired

public boolean isBalancingRequired(FObj fo)

Indicates whether adding a new object to this main-reference area will require any balancing work.

Parameters:

fo - The FObj instance to be added.

Returns:

True if adding fo will require balancing.

resetSpanArea

public void resetSpanArea()

Resets the the just-done span area in preparation for a backtrack for balancing.

isNewSpanArea

public boolean isNewSpanArea()

Indicates whether the currently-active span area in this Area is newly created.

Returns:

True iff the currently-active span area was just created.

isLastColumn

public boolean isLastColumn()

Indicates whether the current column in this area is the last column.

Returns:

True iff the current column in this area is the last column.

getNextWritableArea

public NormalFlowRA getNextWritableArea(FObj fo)
                                 throws AreaWException

Depending on the column-count of the next FO, determine whether a new span area needs to be constructed or not, and return the appropriate NormalFlowArea.

Parameters:

fo - The next formatting object.

Returns:

The next NormalFlowRA area (possibly the current one).

Throws:

AreaWException - if the Area cannot be found or constructed.