Interface DocumentRenderer
-
- All Known Implementing Classes:
DoxiaDocumentRenderer
public interface DocumentRenderer
Renders a page, whatever the source is: a Doxia source file, a report or anything else.- Version:
- $Id: DocumentRenderer.java 1720924 2015-12-19 13:44:56Z hboutemy $
- Author:
- Brett Porter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.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.boolean
isOverwrite()
Whether to always overwrite the document, or only do so when it is changed.void
renderDocument(java.io.Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext)
Render a document.
-
-
-
Method Detail
-
renderDocument
void renderDocument(java.io.Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext) throws RendererException, java.io.FileNotFoundException, java.io.UnsupportedEncodingException
Render a document.- Parameters:
writer
- the Writer.renderer
- the Renderer.siteRenderingContext
- the SiteRenderingContext.- Throws:
RendererException
- if it bombs.java.io.FileNotFoundException
- if it bombs.java.io.UnsupportedEncodingException
- if it bombs.
-
getOutputName
java.lang.String getOutputName()
The name of the output document.- Returns:
- the name of the output document.
-
getRenderingContext
RenderingContext getRenderingContext()
Return the RenderingContext of the document.- Returns:
- RenderingContext.
-
isOverwrite
boolean isOverwrite()
Whether to always overwrite the document, or only do so when it is changed.- Returns:
- whether to overwrite
-
isExternalReport
boolean isExternalReport()
Whether this document is an external report.- Returns:
true
if report is external, otherwisefalse
- Since:
- 1.7
-
-