org.apache.maven.doxia.docrenderer.pdf.itext
Class ITextPdfRenderer
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.itext.ITextPdfRenderer
- All Implemented Interfaces:
- DocumentRenderer, PdfRenderer, org.codehaus.plexus.logging.LogEnabled
public class ITextPdfRenderer
- extends AbstractPdfRenderer
Abstract document
render with the iText
framework
- Since:
- 1.1
- Version:
- $Id: ITextPdfRenderer.java 1187064 2011-10-20 21:41:24Z rfscholte $
- Author:
- Vincent Siveton, ltheussl
- Plexus component:
- role:
- "org.apache.maven.doxia.docrenderer.pdf.PdfRenderer"
- role-hint:
- "itext"
|
Fields inherited from interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer |
ROLE |
Method Summary |
void |
generatePdf(File inputFile,
File pdfFile)
Generate a final pdf ouput file from an intermediate format file. |
void |
render(Map<String,SiteModule> filesToProcess,
File outputDirectory,
DocumentModel documentModel)
Render an aggregate document from the files found in a Map. |
void |
render(Map<String,SiteModule> filesToProcess,
File outputDirectory,
DocumentModel documentModel,
DocumentRendererContext context)
Render an aggregate document from the files found in a Map. |
void |
renderIndividual(Map<String,SiteModule> filesToProcess,
File outputDirectory)
Render documents separately for each file found in a Map. |
void |
renderIndividual(Map<String,SiteModule> filesToProcess,
File outputDirectory,
DocumentRendererContext context)
Render documents separately for each file found in a Map. |
Methods inherited from class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer |
copyDirectory, copyResources, getBaseDir, 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 |
ITextPdfRenderer
public ITextPdfRenderer()
generatePdf
public void generatePdf(File inputFile,
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.
render
public void render(Map<String,SiteModule> filesToProcess,
File outputDirectory,
DocumentModel documentModel)
throws DocumentRendererException,
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 SiteModule 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,SiteModule> filesToProcess,
File outputDirectory,
DocumentModel documentModel,
DocumentRendererContext context)
throws DocumentRendererException,
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 SiteModule 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,SiteModule> filesToProcess,
File outputDirectory)
throws DocumentRendererException,
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 SiteModule 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,SiteModule> filesToProcess,
File outputDirectory,
DocumentRendererContext context)
throws DocumentRendererException,
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 SiteModule as values.outputDirectory
- the output directory where the documents should be generated.context
- the rendering context.
- Throws:
DocumentRendererException
- if any
IOException
- if any
Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.