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 org.docx4j.convert.out.common.AbstractWmlConversionContext

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

Author:

Alberto Zerolo

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.docx4j.convert.out.common.writer.AbstractMessageWriter	FO_MESSAGE_WRITER
protected static org.docx4j.convert.out.common.AbstractWriterRegistry	FO_WRITER_REGISTRY
protected org.docx4j.convert.out.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 and Description
FOConversionContext(org.docx4j.convert.out.FOSettings settings, org.docx4j.openpackaging.packages.WordprocessingMLPackage wmlPackage, org.docx4j.convert.out.common.ConversionSectionWrappers conversionSectionWrappers)

Method Summary

Modifier and Type	Method and 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.
void	forceRequires1Pass() If it is a 2 pass generation, the xslfo document can't be generated independently of a rendering step.
org.docx4j.convert.out.FORenderer	getFORenderer()
protected org.docx4j.convert.out.FORenderer	initializeFoRenderer(org.docx4j.convert.out.FOSettings settings)
protected org.docx4j.model.images.ConversionImageHandler	initializeImageHandler(org.docx4j.convert.out.AbstractConversionSettings settings, org.docx4j.model.images.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 Detail

requires2PassChecked

protected boolean requires2PassChecked

requires2Pass

protected boolean requires2Pass

foRenderer

protected org.docx4j.convert.out.FORenderer foRenderer

FO_WRITER_REGISTRY

protected static final org.docx4j.convert.out.common.AbstractWriterRegistry FO_WRITER_REGISTRY

FO_MESSAGE_WRITER

protected static final org.docx4j.convert.out.common.writer.AbstractMessageWriter FO_MESSAGE_WRITER

Constructor Detail

FOConversionContext

public FOConversionContext(org.docx4j.convert.out.FOSettings settings,
                           org.docx4j.openpackaging.packages.WordprocessingMLPackage wmlPackage,
                           org.docx4j.convert.out.common.ConversionSectionWrappers conversionSectionWrappers)

Method Detail

initializeFoRenderer

protected org.docx4j.convert.out.FORenderer initializeFoRenderer(org.docx4j.convert.out.FOSettings settings)

initializeImageHandler

protected org.docx4j.model.images.ConversionImageHandler initializeImageHandler(org.docx4j.convert.out.AbstractConversionSettings settings,
                                                                                org.docx4j.model.images.ConversionImageHandler handler)

Overrides:

initializeImageHandler in class org.docx4j.convert.out.common.AbstractConversionContext

getFORenderer

public org.docx4j.convert.out.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: