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`

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

PDF renderer that uses Doxia's FO module.

Since:
  1.1
Version:
  $Id: FoPdfRenderer.java 1726406 2016-01-23 15:06:45Z hboutemy $
Author:
  ltheussl

### 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
`FoPdfRenderer()`

### Method Summary

All Methods Instance Methods Concrete Methods
`void` `generatePdf​(java.io.File inputFile, java.io.File pdfFile)` Generate a final pdf ouput file from an intermediate format file.
`void` `render​(java.util.Map<java.lang.String,​org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, java.io.File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel)` Render an aggregate document from the files found in a Map.
`void` `render​(java.util.Map<java.lang.String,​org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, java.io.File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel, DocumentRendererContext context)` Render an aggregate document from the files found in a Map.
`void` `renderIndividual​(java.util.Map<java.lang.String,​org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, java.io.File outputDirectory)` Render documents separately for each file found in a Map.
`void` `renderIndividual​(java.util.Map<java.lang.String,​org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, java.io.File outputDirectory, DocumentRendererContext context)` Render documents separately for each file found in a Map.

### 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 Detail

#### FoPdfRenderer

    public FoPdfRenderer()

### Method Detail

#### generatePdf

    public void generatePdf​(java.io.File inputFile,
                            java.io.File pdfFile)
                     throws DocumentRendererException

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​(java.util.Map<java.lang.String,​org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
                       java.io.File outputDirectory,
                       org.apache.maven.doxia.document.DocumentModel documentModel)
                throws DocumentRendererException,
                       java.io.IOException

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
  `java.io.IOException` - if any

#### render

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

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
  `java.io.IOException` - if any

#### renderIndividual

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

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
  `java.io.IOException` - if any

#### renderIndividual

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

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
  `java.io.IOException` - if any