Interface DocumentRenderer

    • Method Detail

      • renderDocument

        void renderDocument​(java.io.Writer writer,
                            SiteRenderer siteRenderer,
                            SiteRenderingContext siteRenderingContext)
                     throws java.io.IOException,
                            RendererException
        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.
        java.io.IOException - if it bombs.
      • getOutputPath

        default java.lang.String getOutputPath()
        The output path of the document.

        Note: This method won't be default anymore when getOutputName() is removed. You are advised to implement it as soon as possible.

        Returns:
        the name of the output document.
        Since:
        2.0.0
      • getOutputName

        @Deprecated
        java.lang.String getOutputName()
        Deprecated.
        Method name does not properly reflect its purpose. Implement and use getOutputPath() instead.
      • getRenderingContext

        DocumentRenderingContext getRenderingContext()
        Return the rendering context of the document.
        Returns:
        DocumentRenderingContext.
      • 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