public interface DocumentRenderer
document rendering context
Modifier and Type | Method and Description |
---|---|
String |
getOutputName()
The name of the output document.
|
RenderingContext |
getRenderingContext()
Return the RenderingContext of the document.
|
boolean |
isExternalReport()
Whether this document is an external report, independent from the site templating.
|
boolean |
isOverwrite()
Whether to always overwrite the document, or only do so when it is changed.
|
void |
renderDocument(Writer writer,
Renderer siteRenderer,
SiteRenderingContext siteRenderingContext)
Render a document in a site.
|
void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
writer
- the Writer for the document output.siteRenderer
- the site renderer to merge document content to.siteRenderingContext
- the site rendering context.RendererException
- if it bombs.FileNotFoundException
- if it bombs.UnsupportedEncodingException
- if it bombs.String getOutputName()
RenderingContext getRenderingContext()
boolean isOverwrite()
boolean isExternalReport()
true
if report is external, otherwise false
Copyright © 2005–2018 The Apache Software Foundation. All rights reserved.