public class DoxiaDocumentRenderer extends Object implements DocumentRenderer
RenderingContext
, which is expected to have
a non-null parserId and extension.Constructor and Description |
---|
DoxiaDocumentRenderer(RenderingContext renderingContext)
Constructor.
|
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.
|
public DoxiaDocumentRenderer(RenderingContext renderingContext)
renderingContext
- the document's RenderingContext to use.public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
renderDocument
in interface DocumentRenderer
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.public String getOutputName()
getOutputName
in interface DocumentRenderer
public RenderingContext getRenderingContext()
getRenderingContext
in interface DocumentRenderer
public boolean isOverwrite()
isOverwrite
in interface DocumentRenderer
public boolean isExternalReport()
DocumentRenderer
isExternalReport
in interface DocumentRenderer
true
if report is external, otherwise false
Copyright © 2005–2018 The Apache Software Foundation. All rights reserved.