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,
String outputFormat,
OutputStream stream)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addUnresolvedIDRef(String idref,
Resolvable res)
Deprecated.
use getIDTracker().addUnresolvedIDRef(idref, res) instead
|
boolean |
alreadyResolvedID(String id)
Deprecated.
use getIDTracker().alreadyResolvedID(id) instead
|
void |
associateIDWithPageViewport(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.
|
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.
|
List<PageViewport> |
getPageViewportsContainingID(String id)
Deprecated.
use getIDTracker().getPageViewportsContainingID(id) instead
|
FormattingResults |
getResults()
Get information about the rendered output, like number of pages created.
|
boolean |
isComplexScriptFeaturesEnabled()
Check whether complex script features are enabled.
|
void |
notifyPageSequenceFinished(AbstractPageSequence pageSequence,
int pageCount)
Called by the PageSequenceLayoutManager when it is finished with a
page-sequence.
|
protected void |
setupModel(FOUserAgent userAgent,
String outputFormat,
OutputStream stream)
Sets up the AreaTreeModel instance for use by the AreaTreeHandler.
|
void |
signalIDProcessed(String id)
Deprecated.
use getIDTracker().signalIDProcessed(id) instead
|
void |
signalPendingID(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 |
startRoot(Root root)
Called upon start of root element.
|
void |
tryIDResolution(PageViewport pv)
Deprecated.
use getIDTracker().tryIDResolution(pv) instead
|
character, characters, endBlock, endBlockContainer, endBody, endCell, endColumn, endFlow, endFooter, endFootnote, endFootnoteBody, endHeader, endInline, endInstreamForeignObject, endLeader, endLink, endList, endListBody, endListItem, endListLabel, endMarkup, endPageNumber, endPageNumberCitation, endPageNumberCitationLast, endRetrieveMarker, endRetrieveTableMarker, endRoot, endRow, endStatic, endTable, endWrapper, getFontInfo, getUserAgent, image, pageRef, restoreState, restoreState, startBlock, startBlockContainer, startBody, startCell, startColumn, startFlow, startFooter, startFootnote, startFootnoteBody, startHeader, startInline, startInstreamForeignObject, startLeader, startLink, startList, startListBody, startListItem, startListLabel, startMarkup, startPageNumber, startPageNumberCitation, startPageNumberCitationLast, startRetrieveMarker, startRetrieveTableMarker, startRow, startStatic, startTable, startWrapperprotected AreaTreeModel model
public AreaTreeHandler(FOUserAgent userAgent, String outputFormat, 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, String outputFormat, 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()
getResults in class FOEventHandlerpublic boolean isComplexScriptFeaturesEnabled()
public void startDocument()
throws SAXException
startDocument in class FOEventHandlerSAXException - if there is an errorpublic void startRoot(Root root)
FOEventHandlerstartRoot in class FOEventHandlerroot - elementpublic void startPageSequence(PageSequence pageSequence)
startPageSequence in class FOEventHandlerpageSequence - PageSequence that is starting.public void endPageSequence(PageSequence pageSequence)
endPageSequence in class FOEventHandlerpageSequence - the page sequence endingpublic void startExternalDocument(ExternalDocument document)
startExternalDocument in class FOEventHandlerdocument - the external-document nodepublic void endExternalDocument(ExternalDocument document)
endExternalDocument in class FOEventHandlerdocument - 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 SAXException
endDocument in class FOEventHandlerSAXException - if there is some errorpublic String generatePageViewportKey()
@Deprecated public void associateIDWithPageViewport(String id, PageViewport pv)
id - the property ID of the areapv - a page viewport that contains the area with this ID@Deprecated public void signalPendingID(String id)
id - the id of the object being processed@Deprecated public void signalIDProcessed(String id)
id - the id of the formatting object which was just finished@Deprecated public boolean alreadyResolvedID(String id)
id - the id to check@Deprecated public void tryIDResolution(PageViewport pv)
pv - page viewport whose ID refs to resolve@Deprecated public List<PageViewport> getPageViewportsContainingID(String id)
id - the id to lookup@Deprecated public void addUnresolvedIDRef(String idref, Resolvable res)
idref - the idref whose target id has not yet been locatedres - the Resolvable object needing the idref to be resolvedCopyright © 2025 Apache Software Foundation. All rights reserved.