org.apache.fop.fo.pagination
Class PageSequence

java.lang.Object
  |
  +--org.apache.fop.fo.FONode
        |
        +--org.apache.fop.fo.FObj
              |
              +--org.apache.fop.fo.pagination.PageSequence

public class PageSequence
extends FObj

This provides pagination of flows onto pages. Much of the logic for paginating flows is contained in this class. The main entry point is the format method.


Inner Class Summary
static class PageSequence.Maker
           
 
Inner classes inherited from class org.apache.fop.fo.FObj
FObj.Maker
 
Fields inherited from class org.apache.fop.fo.FObj
name, properties, propMgr
 
Fields inherited from class org.apache.fop.fo.FONode
areaClass, areasGenerated, BREAK_AFTER, bufferManager, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, markers, orphans, parent, START, widows
 
Constructor Summary
protected PageSequence(FObj parent, PropertyList propertyList)
           
 
Method Summary
 void addFlow(Flow flow)
           
 void format(AreaTree areaTree)
          Runs the formatting of this page sequence into the given area tree
 int getCurrentPageNumber()
           
 java.lang.String getIpnValue()
           
 int getPageCount()
           
 boolean isFlowSet()
           
static FObj.Maker maker()
           
 void setIsFlowSet(boolean isFlowSet)
           
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, end, generatesReferenceAreas, getContentWidth, getName, getProperty, layout, makePropertyManager, removeID, setWritingMode, start
 
Methods inherited from class org.apache.fop.fo.FONode
addChild, addMarker, forceStartOffset, forceWidth, getBufferManager, getLinkSet, getMarkers, getMarkerSnapshot, getParent, hasMarkers, removeAreas, resetMarker, rollback, setBufferManager, setIsInTableCell, setLinkSet, setLogger, setOrphans, setWidows
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageSequence

protected PageSequence(FObj parent,
                       PropertyList propertyList)
                throws FOPException
Method Detail

maker

public static FObj.Maker maker()

addFlow

public void addFlow(Flow flow)
             throws FOPException

format

public void format(AreaTree areaTree)
            throws FOPException
Runs the formatting of this page sequence into the given area tree

isFlowSet

public boolean isFlowSet()

setIsFlowSet

public void setIsFlowSet(boolean isFlowSet)

getIpnValue

public java.lang.String getIpnValue()

getCurrentPageNumber

public int getCurrentPageNumber()

getPageCount

public int getPageCount()


Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.