org.apache.maven.doxia.docrenderer.itext

Class AbstractITextRender

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.doxia.docrenderer.itext.AbstractITextRender

All Implemented Interfaces:

DocRenderer, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

DefaultPdfRenderer, DefaultRtfRenderer

Deprecated.

since 1.1, use an implementation of DocumentRenderer.

public abstract class AbstractITextRender
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements DocRenderer

Abstract document render with the iText framework

Author:

Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.doxia.Doxia	doxia Deprecated.
protected org.apache.maven.doxia.parser.module.ParserModuleManager	parserModuleManager Deprecated.

Fields inherited from interface org.apache.maven.doxia.docrenderer.DocRenderer

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractITextRender() Deprecated.

Method Summary

Modifier and Type	Method and Description
abstract void	generateOutput(File iTextFile, File iTextOutput) Deprecated. Generate an output file from the contents of an input with the iText framework
void	render(File siteDirectory, File outputDirectory) Deprecated. Render all files from a site directory to an output directory
void	render(File siteDirectory, File outputDirectory, File documentDescriptor) Deprecated. Render a document depending a context and a document descriptor

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.doxia.docrenderer.DocRenderer

getOutputExtension

Field Detail

parserModuleManager

@Requirement
protected org.apache.maven.doxia.parser.module.ParserModuleManager parserModuleManager

Deprecated.

doxia

@Requirement
protected org.apache.maven.doxia.Doxia doxia

Deprecated.

Constructor Detail

AbstractITextRender

public AbstractITextRender()

Deprecated.

Method Detail

render

public void render(File siteDirectory,
                   File outputDirectory)
            throws DocumentRendererException,
                   IOException

Deprecated.

Render all files from a site directory to an output directory

Specified by:

render in interface DocRenderer

Parameters:

siteDirectory - the input directory contains files to be generated

outputDirectory - the output directory where files are generated

Throws:

DocumentRendererException - if any

IOException - if any

render

public void render(File siteDirectory,
                   File outputDirectory,
                   File documentDescriptor)
            throws DocumentRendererException,
                   IOException

Deprecated.

Render a document depending a context and a document descriptor

Specified by:

render in interface DocRenderer

Parameters:

siteDirectory - the input directory contains files to be generated

outputDirectory - the output directory where file are generated

documentDescriptor - the document descriptor

Throws:

DocumentRendererException - if any

IOException - if any

generateOutput

public abstract void generateOutput(File iTextFile,
                                    File iTextOutput)
                             throws DocumentRendererException,
                                    IOException

Deprecated.

Generate an output file from the contents of an input with the iText framework

Parameters:

iTextFile - input file

iTextOutput - output file

Throws:

DocumentRendererException - if any

IOException - if any