|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PageCollection
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 |
---|
AreaTree getAreaTree()
getAreaTree
in interface AreaNode
PageSequence getPageSequence()
void layoutComplete() throws AreaTreeException
AreaTreeException
- If this is unable to add any blank pages it
is required to add at its end.PageArea makePage(PageCollection.Force forceValue) throws AreaTreeException
forceValue
- Indicates whether the new page should be forced to be
odd, even, or should not be forced to any parity.
AreaTreeException
- If a new page cannot be created.int getPageCount()
|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.