org.axsl.area
Interface PageCollection

All Superinterfaces:

AreaNode, FoContext, javax.swing.tree.TreeNode

public interface PageCollection
extends AreaNode

A PageCollection is a collection of formatted pages. It is the immediate child of AreaTree, and the parent of one or more Pages.

Nested Class Summary

static class

PageCollection.Force Enumeration of possible "force" values when creating new pages.

Method Summary

AreaTree	getAreaTree() Returns the parent AreaTree.
int	getPageCount() Returns the current count of pages in this collection.
PageSequence	getPageSequence() Returns the generating PageSequence.
void	layoutComplete() Allows a layout system to notify the page that it is done adding content to it.
PageArea	makePage(PageCollection.Force forceValue) Creates a new page area for the given parameters.

Methods inherited from interface org.axsl.area.AreaNode

ancestorArea, ancestorBlockContentFactory, ancestorNormalBlockArea, ancestorTableArea, getAreaName, 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

getAreaTree

AreaTree getAreaTree()

Returns the parent AreaTree.

Specified by:

getAreaTree in interface AreaNode

Returns:

The parent AreaTree.

getPageSequence

PageSequence getPageSequence()

Returns the generating PageSequence.

Returns:

The generating PageSequence.

layoutComplete

void layoutComplete()
                    throws AreaTreeException

Allows a layout system to notify the page that it is done adding content to it. Specifically, this gives the PageCollection an opportunity to create any blank pages that are needed at its end.

Throws:

AreaTreeException - If this is unable to add any blank pages it is required to add at its end.

makePage

PageArea makePage(PageCollection.Force forceValue)
                  throws AreaTreeException

Creates a new page area for the given parameters. Any blank pages needed are silently created as well.

Parameters:

forceValue - Indicates whether the new page should be forced to be odd, even, or should not be forced to any parity.

Returns:

The new PageArea instance.

Throws:

AreaTreeException - If a new page cannot be created.

getPageCount

int getPageCount()

Returns the current count of pages in this collection.

Returns:

The count of pages in this collection.