org.axsl.areaW
Interface AreaTree

All Superinterfaces:

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

public interface AreaTree

extends AreaNode

An AreaTree is a document that has been laid out on pages. To obtain an AreaTree instance, use AreaTreeFactory.makeAreaTree(Root).

Method Summary

void	createDocumentNodes() Reads document nodes from the FOTree and creates appropriate corresponding items in the AreaTree.
PageCollection	makePageCollection(PageSequence pageSequence) Factory method to create a child PageCollection instance.
void	registerListener(AreaTreeListener listener) Registers a listener for notification of AreaTreeEvent firings.

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

makePageCollection

public PageCollection makePageCollection(PageSequence pageSequence)

Factory method to create a child PageCollection instance.

Parameters:

pageSequence - The FOTree PageSequence that is generating the new PageCollection.

Returns:

A new PageCollection instance.

createDocumentNodes

public void createDocumentNodes()

Reads document nodes from the FOTree and creates appropriate corresponding items in the AreaTree. This method is typically run at the end of FOTree parsing. Document nodes are those that are direct children of the Root, and are not part of any PageSequence. Examples includes Bookmarks and Destinations.

registerListener

public void registerListener(AreaTreeListener listener)

Registers a listener for notification of AreaTreeEvent firings.

Parameters:

listener - The listener object which should be notified about AreaTreeEvent firings.