org.apache.maven.doxia.siterenderer
Interface Renderer

All Known Implementing Classes:
DefaultSiteRenderer

public interface Renderer

Version:
$Id:Renderer.java 348612 2005-11-24 12:54:19 +1100 (Thu, 24 Nov 2005) brett $
Author:
Field Summary
static java.lang.String ROLE
           
 
Method Summary
 void copyResources(SiteRenderingContext siteRenderingContext, java.io.File resourcesDirectory, java.io.File outputDirectory)
           
 SiteRenderingContext createContextForSkin(java.io.File skinFile, java.util.Map attributes, org.apache.maven.doxia.site.decoration.DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale)
           
 SiteRenderingContext createContextForTemplate(java.io.File templateFile, java.io.File skinFile, java.util.Map attributes, org.apache.maven.doxia.site.decoration.DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale)
           
 void generateDocument(java.io.Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext)
           
 java.util.Map locateDocumentFiles(SiteRenderingContext siteRenderingContext)
           
 void render(java.util.Collection documents, SiteRenderingContext siteRenderingContext, java.io.File outputDirectory)
           
 void renderDocument(java.io.Writer writer, org.apache.maven.doxia.module.xhtml.decoration.render.RenderingContext renderingContext, SiteRenderingContext context)
           
 

Field Detail

ROLE

static final java.lang.String ROLE
Method Detail

render

void render(java.util.Collection documents,
            SiteRenderingContext siteRenderingContext,
            java.io.File outputDirectory)
            throws RendererException,
                   java.io.IOException
Throws:
RendererException
java.io.IOException

generateDocument

void generateDocument(java.io.Writer writer,
                      SiteRendererSink sink,
                      SiteRenderingContext siteRenderingContext)
                      throws RendererException
Throws:
RendererException

createContextForSkin

SiteRenderingContext createContextForSkin(java.io.File skinFile,
                                          java.util.Map attributes,
                                          org.apache.maven.doxia.site.decoration.DecorationModel decoration,
                                          java.lang.String defaultWindowTitle,
                                          java.util.Locale locale)
                                          throws java.io.IOException
Throws:
java.io.IOException

createContextForTemplate

SiteRenderingContext createContextForTemplate(java.io.File templateFile,
                                              java.io.File skinFile,
                                              java.util.Map attributes,
                                              org.apache.maven.doxia.site.decoration.DecorationModel decoration,
                                              java.lang.String defaultWindowTitle,
                                              java.util.Locale locale)
                                              throws java.net.MalformedURLException
Throws:
java.net.MalformedURLException

copyResources

void copyResources(SiteRenderingContext siteRenderingContext,
                   java.io.File resourcesDirectory,
                   java.io.File outputDirectory)
                   throws java.io.IOException
Throws:
java.io.IOException

locateDocumentFiles

java.util.Map locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                                  throws java.io.IOException,
                                         RendererException
Throws:
java.io.IOException
RendererException

renderDocument

void renderDocument(java.io.Writer writer,
                    org.apache.maven.doxia.module.xhtml.decoration.render.RenderingContext renderingContext,
                    SiteRenderingContext context)
                    throws RendererException,
                           java.io.FileNotFoundException,
                           java.io.UnsupportedEncodingException
Throws:
RendererException
java.io.FileNotFoundException
java.io.UnsupportedEncodingException


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.