org.apache.fop.fo.pagination
Class PageSequence

java.lang.Object
  extended byorg.apache.fop.fo.FONode
      extended byorg.apache.fop.fo.FObj
          extended byorg.apache.fop.fo.pagination.PageSequence

public class PageSequence
extends FObj

Class modeling the fo:page-sequence object. Provides pagination of flows. Much of the logic for paginating flows is contained in this class. The main entry point is the format method.

See Also:
XSL-FO 1.0 ¶6.4.5

Nested Class Summary
static class PageSequence.Maker
           
 
Field Summary
 
Fields inherited from class org.apache.fop.fo.FObj
column, line, properties, propMgr, systemId
 
Fields inherited from class org.apache.fop.fo.FONode
areaClass, areasGenerated, BREAK_AFTER, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, parent, START
 
Constructor Summary
protected PageSequence(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)
           
 
Method Summary
 void addFlow(Flow flow)
           
 void addStaticContent(StaticContent staticContent)
           
 void format(AreaTree areaTree)
          Runs the formatting of this page sequence into the given area tree
 int getCurrentPageNumber()
           
 java.lang.String getName()
          returns the name of the formatting object
 int getPageCount()
           
 StaticContent getStaticContent(java.lang.String regionName)
           
static FObj.Maker maker()
           
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, addMarker, end, generatesReferenceAreas, getContentWidth, getProperty, layout, makePropertyManager, removeID, setWritingMode
 
Methods inherited from class org.apache.fop.fo.FONode
addChild, forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, mayPrecedeMarker, removeAreas, resetMarker, rollback, setIsInTableCell, setLinkSet, setLogger
 
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,
                       java.lang.String systemId,
                       int line,
                       int column)
                throws FOPException
Method Detail

maker

public static FObj.Maker maker()

getName

public java.lang.String getName()
Description copied from class: FObj
returns the name of the formatting object

Specified by:
getName in class FObj
Returns:
the name of this formatting objects

addFlow

public void addFlow(Flow flow)
             throws FOPException
Throws:
FOPException

addStaticContent

public void addStaticContent(StaticContent staticContent)
                      throws FOPException
Throws:
FOPException

format

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

Throws:
FOPException

getStaticContent

public StaticContent getStaticContent(java.lang.String regionName)

getCurrentPageNumber

public int getCurrentPageNumber()

getPageCount

public int getPageCount()


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