org.axsl.area
Interface MainRefArea

All Superinterfaces:

Area, AreaNode, FoContext, javax.swing.tree.TreeNode

public interface MainRefArea
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

NormalFlowRefArea	getNormalFlow(Fo 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 NormalFlowRefArea.
boolean	isBalancingRequired(Fo 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.area.Area

crBpd, crIpd, pdAvailable

Methods inherited from interface org.axsl.area.AreaNode

ancestorArea, ancestorBlockContentFactory, ancestorNormalBlockArea, ancestorTableArea, getAreaName, getAreaTree, getPage, isFirstChildOfGeneratedBy, nearestArea, nearestGeneratedByBlockLevelFo, removeChild, siblingIndex, traitGeneratedBy

Methods inherited from interface javax.swing.tree.TreeNode

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

Methods inherited from interface org.axsl.fo.FoContext

bpdAncestorBlockOrRa, getGraftingPoint, heightContainingBlock, ipdAncestorBlockArea, ipdAncestorBlockOrRa, ipdContainingRefArea, ipdParentArea, isFirst, isLast, tableWidth, widthContainingBlock

Method Detail

isBalancingRequired

boolean isBalancingRequired(Fo 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

void resetSpanArea()

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

isNewSpanArea

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

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.

getNormalFlow

NormalFlowRefArea getNormalFlow(Fo fo)
                                throws AreaTreeException

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 NormalFlowRefArea.

Parameters:

fo - The next formatting object.

Returns:

The NormalFlowRefArea area that should be used for fo, which is possibly the current one.

Throws:

AreaTreeException - if the Area cannot be found or constructed.