|
fop 0.93 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.layoutmgr.AbstractBaseLayoutManager
org.apache.fop.layoutmgr.AbstractLayoutManager
org.apache.fop.layoutmgr.PageSequenceLayoutManager
LayoutManager for a PageSequence. This class is instantiated by area.AreaTreeHandler for each fo:page-sequence found in the input document.
Nested Class Summary | |
class |
PageSequenceLayoutManager.PageProvider
This class delivers Page instances. |
Field Summary |
Fields inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager |
childLMiter, childLMs, curChildLM, fobjIter, markers, parentLM |
Fields inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
fobj, generatesBlockArea, generatesReferenceArea |
Constructor Summary | |
PageSequenceLayoutManager(AreaTreeHandler ath,
PageSequence pseq)
Constructor |
Method Summary | |
void |
activateLayout()
Activate the layout of this page sequence. |
void |
addIDToPage(java.lang.String id)
Add an ID reference to the current page. |
void |
addUnresolvedArea(java.lang.String id,
Resolvable res)
Identify an unresolved area (one needing an idref to be resolved, e.g. |
boolean |
associateLayoutManagerID(java.lang.String id)
Add an id reference of the layout manager in the AreaTreeHandler, if the id hasn't been resolved yet |
void |
doForcePageCount(Numeric nextPageSeqInitialPageNumber)
Act upon the force-page-count trait, in relation to the initial-page-number trait of the following page-sequence. |
void |
finishPageSequence()
Finished the page-sequence and notifies everyone about it. |
Page |
getCurrentPage()
Provides access to the current page. |
PageViewport |
getFirstPVWithID(java.lang.String idref)
This returns the first PageViewport that contains an id trait matching the idref argument, or null if no such PV exists. |
PageViewport |
getLastPVWithID(java.lang.String idref)
This returns the last PageViewport that contains an id trait matching the idref argument, or null if no such PV exists. |
LayoutManagerMaker |
getLayoutManagerMaker()
|
PageSequenceLayoutManager.PageProvider |
getPageProvider()
|
PageSequenceLayoutManager |
getPSLM()
Provides access to this object |
void |
notifyEndOfLayout(java.lang.String id)
Notify the areaTreeHandler that the LayoutManagers containing idrefs have finished creating areas |
RetrieveMarker |
resolveRetrieveMarker(RetrieveMarker rm)
Bind the RetrieveMarker to the corresponding Marker subtree. |
Methods inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager |
addAreas, addChildArea, addChildLM, addChildLMs, createChildLMs, createNextChildLMs, getChangedKnuthElements, getChildLM, getChildLMs, getCurrentPV, getNextKnuthElements, getParent, getParentArea, hasNextChildLM, initialize, isFinished, isFirst, isLast, notifyPos, reset, resetPosition, setFinished, setParent, transferForeignAttributes |
Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getContentAreaBPD, getContentAreaIPD, getFObj, getGeneratesBlockArea, getGeneratesLineArea, getGeneratesReferenceArea, getParentAreaBPD, getParentAreaIPD, getReferenceAreaBPD, getReferenceAreaIPD, setGeneratesBlockArea, setGeneratesReferenceArea |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PageSequenceLayoutManager(AreaTreeHandler ath, PageSequence pseq)
ath
- the area tree handler objectpseq
- fo:page-sequence to processMethod Detail |
public LayoutManagerMaker getLayoutManagerMaker()
LayoutManager
public PageSequenceLayoutManager.PageProvider getPageProvider()
public void activateLayout()
public void finishPageSequence()
public Page getCurrentPage()
getCurrentPage
in class AbstractLayoutManager
getCurrentPage()
public PageSequenceLayoutManager getPSLM()
getPSLM
in interface LayoutManager
getPSLM
in class AbstractLayoutManager
getPSLM()
public PageViewport getFirstPVWithID(java.lang.String idref)
idref
- the idref trait needing to be resolved
public PageViewport getLastPVWithID(java.lang.String idref)
idref
- the idref trait needing to be resolved
public void addIDToPage(java.lang.String id)
id
- the ID reference to addpublic boolean associateLayoutManagerID(java.lang.String id)
id
- the id to track
public void notifyEndOfLayout(java.lang.String id)
id
- the id for which layout has finishedpublic void addUnresolvedArea(java.lang.String id, Resolvable res)
id
- the ID reference to addres
- the resolvable object that needs resolvingpublic RetrieveMarker resolveRetrieveMarker(RetrieveMarker rm)
rm
- the RetrieveMarker instance whose properties are to
used to find the matching Marker.
public void doForcePageCount(Numeric nextPageSeqInitialPageNumber)
nextPageSeqInitialPageNumber
- initial-page-number trait of next page-sequence
|
fop 0.93 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |