Interface DocumentRenderer

All Known Implementing Classes:
DoxiaDocumentRenderer

public interface DocumentRenderer
Renders a page in a site, whatever the source is: a Doxia source file, a report or anything else.
Author:
Brett Porter
See Also:
  • Method Details

    • renderDocument

      void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
      Render a document in a site.
      Parameters:
      writer - the Writer for the document output.
      siteRenderer - the site renderer to merge document content to.
      siteRenderingContext - the site rendering context.
      Throws:
      RendererException - if it bombs.
      FileNotFoundException - if it bombs.
      UnsupportedEncodingException - if it bombs.
    • getOutputName

      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, independent from the site templating.
      Returns:
      true if report is external, otherwise false
      Since:
      1.7