|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Renderer
Renderer interface.
Field Summary | |
---|---|
static String |
ROLE
Plexus lookup role. |
Method Summary | |
---|---|
void |
copyResources(SiteRenderingContext siteRenderingContext,
File resourcesDirectory,
File outputDirectory)
Copy resource files. |
SiteRenderingContext |
createContextForSkin(File skinFile,
Map<String,?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
Locale locale)
Return a SiteRenderingContext. |
SiteRenderingContext |
createContextForTemplate(File templateFile,
File skinFile,
Map<String,?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
Locale locale)
Return a SiteRenderingContext. |
void |
generateDocument(Writer writer,
SiteRendererSink sink,
SiteRenderingContext siteRenderingContext)
Generate a document. |
Map<String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext)
Return the document files in a Map. |
void |
render(Collection<DocumentRenderer> documents,
SiteRenderingContext siteRenderingContext,
File outputDirectory)
Render a collection of documents. |
void |
renderDocument(Writer writer,
org.apache.maven.doxia.sink.render.RenderingContext renderingContext,
SiteRenderingContext siteContext)
Render a document. |
Field Detail |
---|
static final String ROLE
Method Detail |
---|
void render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) throws RendererException, IOException
documents
- the documents to render.siteRenderingContext
- the SiteRenderingContext to use.outputDirectory
- the output directory to write results.
RendererException
- if it bombs.
IOException
- if it bombs.void generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException
writer
- the Writer to use.sink
- the Sink to receive the events.siteRenderingContext
- the SiteRenderingContext to use.
RendererException
- if it bombs.SiteRenderingContext createContextForSkin(File skinFile, Map<String,?> attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) throws IOException
skinFile
- attributes
- decoration
- defaultWindowTitle
- locale
-
IOException
- if it bombs.SiteRenderingContext createContextForTemplate(File templateFile, File skinFile, Map<String,?> attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) throws MalformedURLException
templateFile
- skinFile
- attributes
- decoration
- defaultWindowTitle
- locale
-
MalformedURLException
- if it bombs.void copyResources(SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory) throws IOException
siteRenderingContext
- resourcesDirectory
- outputDirectory
-
IOException
- if it bombs.Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws IOException, RendererException
siteRenderingContext
-
IOException
- if it bombs.
RendererException
- if it bombs.void renderDocument(Writer writer, org.apache.maven.doxia.sink.render.RenderingContext renderingContext, SiteRenderingContext siteContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
writer
- the writer to render the document to.renderingContext
- the document's rendering contextsiteContext
- the site's rendering context
RendererException
- if it bombs.
FileNotFoundException
- if it bombs.
UnsupportedEncodingException
- if it bombs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |