org.axsl.area

Interface AreaTree

All Superinterfaces:

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

public interface AreaTree
extends AreaNode, PageCollectionFactory

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

Method Summary

Modifier and Type	Method and Description
void	contentComplete() Client applications (applications that are pushing content into the Area Tree) should run this method to notify the area tree that there is no more content to be added to the document.
FontConsumer	getFontConsumer() Returns the FontConsumer instance used by this AreaTree.
TextServer	getTextServer() Returns the TextServer instance used by this AreaTree.
void	registerListener(AreaTreeListener listener) Registers a listener for notification of AreaTreeEvent firings.

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

Methods inherited from interface org.axsl.area.PageCollectionFactory

makePageCollection

Method Detail

contentComplete

void contentComplete()

Client applications (applications that are pushing content into the Area Tree) should run this method to notify the area tree that there is no more content to be added to the document. The implementation should then do the following:

1. Attempt to resolve any open issues (unresolved references, etc.)
2. Flush any unreleased pages by firing an appropriate AreaTreeEvent.
3. Prepare any document nodes from the FOTree that should be passed along to the client application. Document nodes are those that are direct children of the Root, and are not part of any PageSequence. Examples includes Bookmarks and Destinations.

registerListener

void registerListener(AreaTreeListener listener)

Registers a listener for notification of AreaTreeEvent firings.

Parameters:

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

getFontConsumer

FontConsumer getFontConsumer()

Returns the FontConsumer instance used by this AreaTree.

Returns:

The FontConsumer.

getTextServer

TextServer getTextServer()

Returns the TextServer instance used by this AreaTree.

Returns:

The TextServer.