Package org.docx4j.convert.out.fo

Class FOConversionContext

java.lang.Object

org.docx4j.convert.out.common.AbstractConversionContext

org.docx4j.convert.out.common.AbstractWmlConversionContext

org.docx4j.convert.out.fo.FOConversionContext

public class FOConversionContext
extends AbstractWmlConversionContext

See /docs/developer/Convert_Out.docx for an overview of the design.

Author:

Alberto Zerolo

Field Summary

Fields

Modifier and Type	Field	Description
protected static AbstractMessageWriter	FO_MESSAGE_WRITER
protected static AbstractWriterRegistry	FO_WRITER_REGISTRY
protected FORenderer	foRenderer
protected boolean	requires2Pass
protected boolean	requires2PassChecked

Fields inherited from class org.docx4j.convert.out.common.AbstractWmlConversionContext

complexFieldDefinitionLevel, conversionSectionWrappers, currentPart, endnoteNumberCounter, footnoteNumberCounter, styleTree

Fields inherited from class org.docx4j.convert.out.common.AbstractConversionContext

CONVERSION_CONTEXT_ID, DUMMY_HYPERLINK_HANDLER, DUMMY_WRITER

Constructor Summary

Constructors

Constructor	Description
FOConversionContext(FOSettings settings, WordprocessingMLPackage wmlPackage, ConversionSectionWrappers conversionSectionWrappers)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkRequires2Pass()	A 2 pass pdf generation is required if the result of fo:page-number-citation-last does not correspond to the field results of NUMPAGES or SECTIONPAGES.
protected static RunFontSelector	createRunFontSelector(WordprocessingMLPackage wmlPackage)
void	forceRequires1Pass()	If it is a 2 pass generation, the xslfo document can't be generated independently of a rendering step.
FORenderer	getFORenderer()
protected FORenderer	initializeFoRenderer(FOSettings settings)
protected ConversionImageHandler	initializeImageHandler(AbstractConversionSettings settings, ConversionImageHandler handler)
boolean	isRequires2Pass()

Methods inherited from class org.docx4j.convert.out.common.AbstractWmlConversionContext

getCurrentPart, getNextEndnoteNumber, getNextFootnoteNumber, getPropertyResolver, getRunFontSelector, getSections, getStyleTree, getTransformState, getWmlPackage, getWriterRegistry, handleHyperlink, initializeOpcPackage, initializeStyleTree, initializeTransformStates, initializeWriterRegistry, isInComplexFieldDefinition, resolveLinkedAbstractNum, setCurrentPart, setCurrentPartMainDocument, updateComplexFieldDefinition

Methods inherited from class org.docx4j.convert.out.common.AbstractConversionContext

getConversionSettings, getHyperlinkHandler, getImageHandler, getLog, getMessageWriter, getOpcPackage, getXsltParameters, initializeHyperlinkHandler, initializeMessageWriter, initializeSettings, initializeXsltParameters

Methods inherited from class java.lang.Object

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

Field Details

requires2PassChecked

protected boolean requires2PassChecked

requires2Pass

protected boolean requires2Pass

foRenderer

protected FORenderer foRenderer

FO_WRITER_REGISTRY

protected static final AbstractWriterRegistry FO_WRITER_REGISTRY

FO_MESSAGE_WRITER

protected static final AbstractMessageWriter FO_MESSAGE_WRITER

Constructor Details

FOConversionContext

public FOConversionContext(FOSettings settings, WordprocessingMLPackage wmlPackage, ConversionSectionWrappers conversionSectionWrappers)

Method Details

createRunFontSelector

protected static RunFontSelector createRunFontSelector(WordprocessingMLPackage wmlPackage)

initializeFoRenderer

protected FORenderer initializeFoRenderer(FOSettings settings)

initializeImageHandler

protected ConversionImageHandler initializeImageHandler(AbstractConversionSettings settings, ConversionImageHandler handler)

Overrides:

initializeImageHandler in class AbstractConversionContext

getFORenderer

public FORenderer getFORenderer()

forceRequires1Pass

public void forceRequires1Pass()

If it is a 2 pass generation, the xslfo document can't be generated independently of a rendering step. Some APIs return a xslfo document without rendering it (XSLFOExporterNonXSLT, Conversion.outputXSLFO), for this cases this method ensures, that the document doesn't require the corresponding parameters but if a 2 pass generation was required the rendered document will show errors.

isRequires2Pass

public boolean isRequires2Pass()

checkRequires2Pass

protected boolean checkRequires2Pass()

A 2 pass pdf generation is required if the result of fo:page-number-citation-last does not correspond to the field results of NUMPAGES or SECTIONPAGES. This is the case when one of those fields are used and:

• There is an explicit start of page numbers (> 1 in the first section, anything in the following sections) or
• The document contains more than 1 section (and SECTIONPAGES is used).

In theory, a different page number formatting of NUMPAGES or SECTIONPAGES should also trigger a 2 pass conversion. This case is ignored to have a consistent behavior with the page refs and reduce the amount of 2 passes.

Returns: