org.apache.fop.fo.pagination
Class PageSequence

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
 public static classPageSequence.Maker
           

Inner classes inherited from class org.apache.fop.fo.FObj
FObj.Maker

Fields inherited from class org.apache.fop.fo.FObj
properties

Fields inherited from class org.apache.fop.fo.FONode
BREAK_AFTER, children, START

Method Summary
 voidaddFlow(Flow flow)
           
 voidformat(AreaTree areaTree)
          Runs the formatting of this page sequence into the given area tree
 booleanisFlowSet()
           
 static FObj.Makermaker()
           
 voidsetIsFlowSet(boolean isFlowSet)
           

Methods inherited from class org.apache.fop.fo.FObj
generatesReferenceAreas, getContentWidth, getName, getProperty, layout, removeID

Methods inherited from class org.apache.fop.fo.FONode
forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, removeAreas, resetMarker, rollback, setBodyIndent, setDistanceBetweenStarts, setIsInLabel, setIsInListBody, setIsInTableCell, setLabelSeparation, setLinkSet, setOrphans, setWidows

Method Detail

addFlow

public void addFlow(Flow flow)
throws org.apache.fop.apps.FOPException

format

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

isFlowSet

public boolean isFlowSet()

maker

public static FObj.Maker maker()

setIsFlowSet

public void setIsFlowSet(boolean isFlowSet)

Association Links

to Class org.apache.fop.fo.pagination.Root

The parent root object

to Class org.apache.fop.fo.pagination.LayoutMasterSet

the set of layout masters (provided by the root object)

to Class java.util.Hashtable

Map of flows to their flow name (flow-name, Flow)

to Class java.lang.String

the "master-name" attribute

to Class org.apache.fop.layout.Page

to Class org.apache.fop.fo.pagination.SubSequenceSpecifier

the current subsequence while formatting a given page sequence

to Class java.lang.String

the name of the current page master