public class AreaTreeHandler extends FOEventHandler
Modifier and Type | Field and Description |
---|---|
protected AreaTreeModel |
model
The AreaTreeModel in use
|
fontInfo, foUserAgent
Constructor and Description |
---|
AreaTreeHandler(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream stream)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addUnresolvedIDRef(java.lang.String idref,
Resolvable res)
Deprecated.
use getIDTracker().addUnresolvedIDRef(idref, res) instead
|
boolean |
alreadyResolvedID(java.lang.String id)
Deprecated.
use getIDTracker().alreadyResolvedID(id) instead
|
void |
associateIDWithPageViewport(java.lang.String id,
PageViewport pv)
Deprecated.
use getIDTracker().associateIDWithPageViewport(id, pv) instead
|
void |
endDocument()
End the document.
|
void |
endExternalDocument(ExternalDocument document)
Process the end of the external-document extension.
|
void |
endPageSequence(PageSequence pageSequence)
End the PageSequence.
|
java.lang.String |
generatePageViewportKey()
Generates and returns a unique key for a page viewport.
|
AreaTreeModel |
getAreaTreeModel()
Get the area tree model for this area tree.
|
IDTracker |
getIDTracker()
Get the IDTracker for this area tree.
|
LayoutManagerMaker |
getLayoutManagerMaker()
Get the LayoutManager maker for this area tree.
|
java.util.List |
getPageViewportsContainingID(java.lang.String id)
Deprecated.
use getIDTracker().getPageViewportsContainingID(id) instead
|
FormattingResults |
getResults()
Get information about the rendered output, like number of pages created.
|
void |
notifyPageSequenceFinished(AbstractPageSequence pageSequence,
int pageCount)
Called by the PageSequenceLayoutManager when it is finished with a
page-sequence.
|
protected void |
setupModel(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream stream)
Sets up the AreaTreeModel instance for use by the AreaTreeHandler.
|
void |
signalIDProcessed(java.lang.String id)
Deprecated.
use getIDTracker().signalIDProcessed(id) instead
|
void |
signalPendingID(java.lang.String id)
Deprecated.
use getIDTracker().signalPendingID(id) instead
|
void |
startDocument()
Prepare AreaTreeHandler for document processing This is called from
FOTreeBuilder.startDocument()
|
void |
startExternalDocument(ExternalDocument document)
Process the start of the external-document extension.
|
void |
startPageSequence(PageSequence pageSequence) |
void |
tryIDResolution(PageViewport pv)
Deprecated.
use getIDTracker().tryIDResolution(pv) instead
|
character, characters, endBlock, endBlockContainer, endBody, endCell, endColumn, endFlow, endFooter, endFootnote, endFootnoteBody, endHeader, endInline, endLink, endList, endListBody, endListItem, endListLabel, endMarkup, endPageNumber, endPageNumberCitation, endPageNumberCitationLast, endRow, endStatic, endTable, foreignObject, getFontInfo, getUserAgent, image, leader, pageRef, startBlock, startBlockContainer, startBody, startCell, startColumn, startFlow, startFooter, startFootnote, startFootnoteBody, startHeader, startInline, startLink, startList, startListBody, startListItem, startListLabel, startMarkup, startPageNumber, startPageNumberCitation, startPageNumberCitationLast, startRow, startStatic, startTable
protected AreaTreeModel model
public AreaTreeHandler(FOUserAgent userAgent, java.lang.String outputFormat, java.io.OutputStream stream) throws FOPException
userAgent
- FOUserAgent object for processoutputFormat
- the MIME type of the output format to use (ex.
"application/pdf").stream
- OutputStreamFOPException
- if the RenderPagesModel cannot be createdprotected void setupModel(FOUserAgent userAgent, java.lang.String outputFormat, java.io.OutputStream stream) throws FOPException
userAgent
- FOUserAgent object for processoutputFormat
- the MIME type of the output format to use (ex.
"application/pdf").stream
- OutputStreamFOPException
- if the RenderPagesModel cannot be createdpublic AreaTreeModel getAreaTreeModel()
public LayoutManagerMaker getLayoutManagerMaker()
public IDTracker getIDTracker()
public FormattingResults getResults()
public void startDocument() throws org.xml.sax.SAXException
startDocument
in class FOEventHandler
org.xml.sax.SAXException
- if there is an errorpublic void startPageSequence(PageSequence pageSequence)
startPageSequence
in class FOEventHandler
pageSequence
- PageSequence that is starting.public void endPageSequence(PageSequence pageSequence)
endPageSequence
in class FOEventHandler
pageSequence
- the page sequence endingpublic void startExternalDocument(ExternalDocument document)
startExternalDocument
in class FOEventHandler
document
- the external-document nodepublic void endExternalDocument(ExternalDocument document)
endExternalDocument
in class FOEventHandler
document
- the external-document nodepublic void notifyPageSequenceFinished(AbstractPageSequence pageSequence, int pageCount)
pageSequence
- the page-sequence just finishedpageCount
- The number of pages generated for the page-sequencepublic void endDocument() throws org.xml.sax.SAXException
endDocument
in class FOEventHandler
org.xml.sax.SAXException
- if there is some errorpublic java.lang.String generatePageViewportKey()
public void associateIDWithPageViewport(java.lang.String id, PageViewport pv)
id
- the property ID of the areapv
- a page viewport that contains the area with this IDpublic void signalPendingID(java.lang.String id)
id
- the id of the object being processedpublic void signalIDProcessed(java.lang.String id)
id
- the id of the formatting object which was just finishedpublic boolean alreadyResolvedID(java.lang.String id)
id
- the id to checkpublic void tryIDResolution(PageViewport pv)
pv
- page viewport whose ID refs to resolvepublic java.util.List getPageViewportsContainingID(java.lang.String id)
id
- the id to lookuppublic void addUnresolvedIDRef(java.lang.String idref, Resolvable res)
idref
- the idref whose target id has not yet been locatedres
- the Resolvable object needing the idref to be resolvedCopyright 1999-2010 The Apache Software Foundation. All Rights Reserved.