Package org.apache.fop.area
Class CachedRenderPagesModel
java.lang.Object
org.apache.fop.area.AreaTreeModel
org.apache.fop.area.RenderPagesModel
org.apache.fop.area.CachedRenderPagesModel
A simple cached render pages model.
If the page is prepared for later rendering then this saves
the page contents to a file and once the page is resolved
the contents are reloaded.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Map
<PageViewport, URI> private static final org.apache.xmlgraphics.io.TempResourceURIGenerator
private final URI
Base directory to save temporary file in, typically points to the user's temp dir.Fields inherited from class org.apache.fop.area.RenderPagesModel
prepared, renderer
Fields inherited from class org.apache.fop.area.AreaTreeModel
currentPageSequence, log
-
Constructor Summary
ConstructorsConstructorDescriptionCachedRenderPagesModel
(FOUserAgent userAgent, String outputFormat, FontInfo fontInfo, OutputStream stream) Main Constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
checkPreparedPages
(PageViewport newpage, boolean renderUnresolved) Check prepared pagesvoid
End the document.protected void
savePage
(PageViewport page) Save a page.Methods inherited from class org.apache.fop.area.RenderPagesModel
addPage, handleOffDocumentItem, preparePage, renderPage, setDocumentLocale, startPageSequence
Methods inherited from class org.apache.fop.area.AreaTreeModel
getCurrentPageSequence, getPage, getPageCount, getPageSequenceCount
-
Field Details
-
pageMap
-
tempBaseURI
Base directory to save temporary file in, typically points to the user's temp dir. -
TEMP_URI_GENERATOR
private static final org.apache.xmlgraphics.io.TempResourceURIGenerator TEMP_URI_GENERATOR
-
-
Constructor Details
-
CachedRenderPagesModel
public CachedRenderPagesModel(FOUserAgent userAgent, String outputFormat, FontInfo fontInfo, OutputStream stream) throws FOPException Main Constructor- Parameters:
userAgent
- FOUserAgent object for processoutputFormat
- the MIME type of the output format to use (ex. "application/pdf").fontInfo
- FontInfo objectstream
- OutputStream- Throws:
FOPException
- if the renderer cannot be properly initialized
-
-
Method Details
-
checkPreparedPages
Check prepared pages- Overrides:
checkPreparedPages
in classRenderPagesModel
- Parameters:
newpage
- the new page being addedrenderUnresolved
- render pages with unresolved idref's (done at end-of-document processing)- Returns:
- true if the current page should be rendered false if the renderer doesn't support out of order rendering and there are pending pages
-
savePage
Save a page. It saves the contents of the page to a file.- Parameters:
page
- the page to prepare
-
endDocument
End the document. Render any end document OffDocumentItems Signal the end of the document for any processing.- Overrides:
endDocument
in classRenderPagesModel
- Throws:
SAXException
- if a problem was encountered.
-