Package 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	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	Description
private static final String	FO_USER_AGENT
static final String	FOP_FACTORY
protected static FORendererApacheFOP	instance
protected static org.slf4j.Logger	log
private static String	XSL_FO

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

TEXTBOX_POSTPROCESSING_REQUIRED, xslt_POSTPROCESSING

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

PLACEHOLDER_PREFIX, PLACEHOLDER_SUFFIX

Constructor Summary

Constructors

Constructor	Description
FORendererApacheFOP()

Method Summary

Modifier and Type	Method	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.
static org.apache.fop.apps.FopFactoryBuilder	getFopFactoryBuilder(FOSettings settings)	Get a FopFactoryBuilder, automagically preconfigured with font info.
static org.apache.fop.apps.FopFactoryBuilder	getFopFactoryBuilder(FOSettings settings, org.apache.xmlgraphics.io.ResourceResolver resourceResolver)	Get a FopFactoryBuilder, automagically preconfigured with font info.
static org.apache.fop.apps.FOUserAgent	getFOUserAgent(FOSettings settings, org.apache.fop.apps.FopFactory fopFactory)	Allow user access to FOUserAgent, so they can setAccessibility(true).
static FORenderer	getInstance()
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.
protected void	render(org.apache.fop.apps.FopFactory fopFactory, org.apache.fop.apps.FOUserAgent foUserAgent, String outputFormat, Source foDocumentSrc, PlaceholderReplacementHandler.PlaceholderLookup placeholderLookup, OutputStream outputStream)
private String	setupApacheFopMime(FOSettings settings)

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.slf4j.Logger log

instance

protected static FORendererApacheFOP instance

XSL_FO

private static String XSL_FO

FO_USER_AGENT

private static final String FO_USER_AGENT

See Also:

• Constant Field Values

FOP_FACTORY

public static final String FOP_FACTORY

See Also:

• Constant Field Values

Constructor Details

FORendererApacheFOP

public FORendererApacheFOP()

Method Details

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

setupApacheFopMime

private String setupApacheFopMime(FOSettings settings)

getInstance

public static FORenderer getInstance()

render

protected void render(org.apache.fop.apps.FopFactory fopFactory,
 org.apache.fop.apps.FOUserAgent foUserAgent,
 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

getFOUserAgent

public static org.apache.fop.apps.FOUserAgent getFOUserAgent(FOSettings settings,
 org.apache.fop.apps.FopFactory fopFactory)
                                                      throws Docx4JException,
org.apache.fop.apps.FOPException

Allow user access to FOUserAgent, so they can setAccessibility(true). Access to other settings is possible but unsupported.

Parameters:

wmlPackage -

Returns:

Throws:

org.apache.fop.apps.FOPException

Docx4JException

getFopFactoryBuilder

public static org.apache.fop.apps.FopFactoryBuilder getFopFactoryBuilder(FOSettings settings)
                                                                  throws org.apache.fop.apps.FOPException

Get a FopFactoryBuilder, automagically preconfigured with font info. Uses default ResourceResolver. defaultBaseURI can be set at property "docx4j.Convert.Out.fop.FopConfParser.defaultBaseURI"

Parameters:

settings -

Returns:

Throws:

org.apache.fop.apps.FOPException

getFopFactoryBuilder

public static org.apache.fop.apps.FopFactoryBuilder getFopFactoryBuilder(FOSettings settings,
 org.apache.xmlgraphics.io.ResourceResolver resourceResolver)
                                                                  throws org.apache.fop.apps.FOPException

Get a FopFactoryBuilder, automagically preconfigured with font info. Uses the specified ResourceResolver. defaultBaseURI can be set at property "docx4j.Convert.Out.fop.FopConfParser.defaultBaseURI"

Parameters:

settings -

resourceResolver - your custom resourceResolver

Returns:

Throws:

org.apache.fop.apps.FOPException