Package org.apache.maven.doxia.docrenderer.pdf.fo

Class FoPdfRenderer

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer

org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer

org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer

All Implemented Interfaces:

DocumentRenderer, PdfRenderer, org.codehaus.plexus.logging.LogEnabled

@Deprecated
@Component(role=PdfRenderer.class,
           hint="fo")
public class FoPdfRenderer
extends AbstractPdfRenderer

Deprecated.

PDF renderer that uses Doxia's FO module.

Since:

1.1

Field Summary

Fields inherited from class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer

doxia, parserModuleManager

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

ROLE

Fields inherited from interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer

ROLE

Constructor Summary

Constructors

Constructor	Description
FoPdfRenderer()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	generatePdf(File inputFile, File pdfFile)	Deprecated. Generate a final pdf ouput file from an intermediate format file.
private void	generatePdf(File inputFile, File pdfFile, org.apache.maven.doxia.document.DocumentModel documentModel)	Deprecated.
private void	mergeAllSources(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, org.apache.maven.doxia.module.fo.FoAggregateSink sink, DocumentRendererContext context)	Deprecated.
private void	mergeSourcesFromTOC(org.apache.maven.doxia.document.DocumentTOC toc, org.apache.maven.doxia.module.fo.FoAggregateSink sink, DocumentRendererContext context)	Deprecated.
private void	parseTocItems(List<org.apache.maven.doxia.document.DocumentTOCItem> items, org.apache.maven.doxia.module.fo.FoAggregateSink sink, DocumentRendererContext context)	Deprecated.
void	render(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel)	Deprecated. Render an aggregate document from the files found in a Map.
void	render(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel, DocumentRendererContext context)	Deprecated. Render an aggregate document from the files found in a Map.
void	renderIndividual(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, File outputDirectory)	Deprecated. Render documents separately for each file found in a Map.
void	renderIndividual(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, File outputDirectory, DocumentRendererContext context)	Deprecated. Render documents separately for each file found in a Map.
private void	renderModules(String href, org.apache.maven.doxia.module.fo.FoAggregateSink sink, org.apache.maven.doxia.document.DocumentTOCItem tocItem, DocumentRendererContext context)	Deprecated.

Methods inherited from class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer

getOutputExtension

Methods inherited from class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer

copyDirectory, copyResources, endsWithIgnoreCase, endsWithIgnoreCase, getBaseDir, getExtensions, getFilesToProcess, getFilesToProcess, getOutputName, parse, parse, readDocumentModel, render, render, render, render, render, setBaseDir

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.DocumentRenderer

readDocumentModel, render, render

Constructor Details

FoPdfRenderer

public FoPdfRenderer()

Deprecated.

Method Details

generatePdf

public void generatePdf(File inputFile,
 File pdfFile)
                 throws DocumentRendererException

Deprecated.

Generate a final pdf ouput file from an intermediate format file.

Parameters:

inputFile - eg a fo or an itext file.

pdfFile - the pdf file to generate.

Throws:

DocumentRendererException - if any.

See Also:

• FoUtils.convertFO2PDF(File, File, String)

render

public void render(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
 File outputDirectory,
 org.apache.maven.doxia.document.DocumentModel documentModel)
            throws DocumentRendererException,
IOException

Deprecated.

Render an aggregate document from the files found in a Map.

Overrides:

render in class AbstractPdfRenderer

Parameters:

filesToProcess - the Map of Files to process. The Map should contain as keys the paths of the source files (relative to baseDir), and the corresponding ParserModule as values.

outputDirectory - the output directory where the aggregate document should be generated.

documentModel - the document model, containing all the metadata, etc.

Throws:

DocumentRendererException - if any

IOException - if any

render

public void render(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
 File outputDirectory,
 org.apache.maven.doxia.document.DocumentModel documentModel,
 DocumentRendererContext context)
            throws DocumentRendererException,
IOException

Deprecated.

Render an aggregate document from the files found in a Map.

Overrides:

render in class AbstractDocumentRenderer

Parameters:

filesToProcess - the Map of Files to process. The Map should contain as keys the paths of the source files (relative to baseDir), and the corresponding ParserModule as values.

outputDirectory - the output directory where the aggregate document should be generated.

documentModel - the document model, containing all the metadata, etc.

context - the rendering context when processing files.

Throws:

DocumentRendererException - if any

IOException - if any

renderIndividual

public void renderIndividual(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
 File outputDirectory)
                      throws DocumentRendererException,
IOException

Deprecated.

Render documents separately for each file found in a Map.

Overrides:

renderIndividual in class AbstractDocumentRenderer

Parameters:

filesToProcess - the Map of Files to process. The Map should contain as keys the paths of the source files (relative to baseDir), and the corresponding ParserModule as values.

outputDirectory - the output directory where the documents should be generated.

Throws:

DocumentRendererException - if any

IOException - if any

renderIndividual

public void renderIndividual(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
 File outputDirectory,
 DocumentRendererContext context)
                      throws DocumentRendererException,
IOException

Deprecated.

Render documents separately for each file found in a Map.

Overrides:

renderIndividual in class AbstractDocumentRenderer

Parameters:

filesToProcess - the Map of Files to process. The Map should contain as keys the paths of the source files (relative to baseDir), and the corresponding ParserModule as values.

outputDirectory - the output directory where the documents should be generated.

context - the rendering context.

Throws:

DocumentRendererException - if any

IOException - if any

mergeAllSources

private void mergeAllSources(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
 org.apache.maven.doxia.module.fo.FoAggregateSink sink,
 DocumentRendererContext context)
                      throws DocumentRendererException,
IOException

Deprecated.

Throws:

DocumentRendererException

IOException

mergeSourcesFromTOC

private void mergeSourcesFromTOC(org.apache.maven.doxia.document.DocumentTOC toc,
 org.apache.maven.doxia.module.fo.FoAggregateSink sink,
 DocumentRendererContext context)
                          throws IOException,
DocumentRendererException

Deprecated.

Throws:

IOException

DocumentRendererException

parseTocItems

private void parseTocItems(List<org.apache.maven.doxia.document.DocumentTOCItem> items,
 org.apache.maven.doxia.module.fo.FoAggregateSink sink,
 DocumentRendererContext context)
                    throws IOException,
DocumentRendererException

Deprecated.

Throws:

IOException

DocumentRendererException

renderModules

private void renderModules(String href,
 org.apache.maven.doxia.module.fo.FoAggregateSink sink,
 org.apache.maven.doxia.document.DocumentTOCItem tocItem,
 DocumentRendererContext context)
                    throws DocumentRendererException,
IOException

Deprecated.

Throws:

DocumentRendererException

IOException

generatePdf

private void generatePdf(File inputFile,
 File pdfFile,
 org.apache.maven.doxia.document.DocumentModel documentModel)
                  throws DocumentRendererException

Deprecated.

Parameters:

inputFile -

pdfFile -

documentModel - could be null

Throws:

DocumentRendererException - if any

Since:

1.1.1