org.docx4j.convert.out.fo.renderers

Class FORendererApacheFOP

java.lang.Object

org.docx4j.convert.out.fo.renderers.AbstractFORenderer

org.docx4j.convert.out.fo.renderers.FORendererApacheFOP

All Implemented Interfaces:

FORenderer

public class FORendererApacheFOP
extends AbstractFORenderer

The Apache FO Renderer uses Apache FOP to render the fo document and is the default FO Renderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FORendererApacheFOP.FopPlaceholderLookup

Nested classes/interfaces inherited from interface org.docx4j.convert.out.FORenderer

FORenderer.SectionPageInformation

Field Summary

Fields

Modifier and Type	Field and Description
protected static FORendererApacheFOP	instance
protected static org.slf4j.Logger	log

Fields inherited from class org.docx4j.convert.out.fo.renderers.AbstractFORenderer

TEXTBOX_POSTPROCESSING_REQUIRED

Fields inherited from interface org.docx4j.convert.out.FORenderer

PLACEHOLDER_PREFIX, PLACEHOLDER_SUFFIX

Constructor Summary

Constructors

Constructor and Description
FORendererApacheFOP()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.fop.apps.FormattingResults	calcResults(org.apache.fop.apps.FopFactory fopFactory, String outputFormat, Source foDocumentSrc, PlaceholderReplacementHandler.PlaceholderLookup placeholderLookup) For first pass of two pass process, invoke org.apache.fop.apps.FormattingResults which can tell us the number of pages in each page sequence, and in the document as a whole.
protected org.apache.fop.apps.Fop	createFop(String userConfiguration, String outputFormat, OutputStream outputStream)
protected org.apache.fop.apps.FopFactory	createFopFactory(String userConfig) Create and configure FopFactory.
protected org.apache.fop.apps.FopFactory	getFopFactory(String userConfig)
static FORenderer	getInstance()
protected void	render(org.apache.fop.apps.FopFactory fopFactory, String outputFormat, Source foDocumentSrc, PlaceholderReplacementHandler.PlaceholderLookup placeholderLookup, OutputStream outputStream)
void	render(String foDocument, FOSettings settings, boolean twoPass, List<FORenderer.SectionPageInformation> pageNumberInformation, OutputStream outputStream) Render the foDocument to the requested format, if needed do a 2 pass conversion.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

instance

protected static FORendererApacheFOP instance

Constructor Detail

FORendererApacheFOP

public FORendererApacheFOP()

Method Detail

render

public void render(String foDocument,
          FOSettings settings,
          boolean twoPass,
          List<FORenderer.SectionPageInformation> pageNumberInformation,
          OutputStream outputStream)
            throws Docx4JException

Description copied from interface: FORenderer

Render the foDocument to the requested format, if needed do a 2 pass conversion.

Parameters:

foDocument - the fo document to be rendered.

settings - the conversion settings passed to the conversion process

twoPass - a two pass rendering might be needed, i.e. the body of some tags contain placeholder How the renderer calculates the corresponding values and replaces them is its responsability

pageNumberInformation - This list contains an entry for each section in the document. It defines the IDs of the corresponding placeholders and the number format (as a fo format).
This List is only available if twoPass = true.

outputStream - The output stream on which the output should be rendered

Throws:

Docx4JException

getInstance

public static FORenderer getInstance()

render

protected void render(org.apache.fop.apps.FopFactory fopFactory,
          String outputFormat,
          Source foDocumentSrc,
          PlaceholderReplacementHandler.PlaceholderLookup placeholderLookup,
          OutputStream outputStream)
               throws Docx4JException

Throws:

Docx4JException

calcResults

protected org.apache.fop.apps.FormattingResults calcResults(org.apache.fop.apps.FopFactory fopFactory,
                                                String outputFormat,
                                                Source foDocumentSrc,
                                                PlaceholderReplacementHandler.PlaceholderLookup placeholderLookup)
                                                     throws Docx4JException

For first pass of two pass process, invoke org.apache.fop.apps.FormattingResults which can tell us the number of pages in each page sequence, and in the document as a whole.

Parameters:

fopFactory -

outputFormat -

foDocumentSrc -

placeholderLookup -

Returns:

Throws:

Docx4JException

createFop

protected org.apache.fop.apps.Fop createFop(String userConfiguration,
                                String outputFormat,
                                OutputStream outputStream)
                                     throws org.apache.fop.apps.FOPException

Throws:

org.apache.fop.apps.FOPException

getFopFactory

protected org.apache.fop.apps.FopFactory getFopFactory(String userConfig)
                                                throws org.apache.fop.apps.FOPException

Throws:

org.apache.fop.apps.FOPException

createFopFactory

protected org.apache.fop.apps.FopFactory createFopFactory(String userConfig)
                                                   throws org.apache.fop.apps.FOPException

Create and configure FopFactory.

Parameters:

userConfig -

defaultBaseURI -

Returns:

Throws:

org.apache.fop.apps.FOPException