Class FORendererApacheFOP
java.lang.Object
org.docx4j.convert.out.fo.renderers.AbstractFORenderer
org.docx4j.convert.out.fo.renderers.FORendererApacheFOP
- All Implemented Interfaces:
FORenderer
The Apache FO Renderer uses Apache FOP to render the fo document
and is the default FO Renderer
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.docx4j.convert.out.FORenderer
FORenderer.SectionPageInformation
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
protected static FORendererApacheFOP
protected static org.slf4j.Logger
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected 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
void
render
(String foDocument, FOSettings settings, boolean twoPass, List<FORenderer.SectionPageInformation> pageNumberInformation, OutputStream outputStream) protected void
render
(org.apache.fop.apps.FopFactory fopFactory, org.apache.fop.apps.FOUserAgent foUserAgent, String outputFormat, Source foDocumentSrc, PlaceholderReplacementHandler.PlaceholderLookup placeholderLookup, OutputStream outputStream)
-
Field Details
-
log
protected static org.slf4j.Logger log -
instance
-
FOP_FACTORY
- See Also:
-
-
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 - Throws:
Docx4JException
-
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
-