Package org.docx4j.convert.out.fo

Class XsltFOFunctions

java.lang.Object

org.docx4j.convert.out.fo.XsltFOFunctions

public class XsltFOFunctions
extends Object

This class contains static functions that are specific to the FO xsl-transformation and are called from docx2fo.xslt.

Field Summary

Fields

Modifier and Type	Field	Description
private static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
XsltFOFunctions()

Method Summary

Modifier and Type	Method	Description
static void	applyFoAttributes(List<Property> properties, Element foElement)
private static DocumentFragment	createBlock(FOConversionContext context, NodeIterator pPrNodeIt, String pStyleVal, NodeIterator childResults, boolean sdt)
protected static DocumentFragment	createBlock(WordprocessingMLPackage wmlPackage, RunFontSelector runFontSelector, String pStyleVal, NodeIterator childResults, boolean sdt, PPr pPrDirect, PPr pPr, RPr rPr, RPr rPrParagraphMark)
static DocumentFragment	createBlockForPPr(FOConversionContext context, NodeIterator pPrNodeIt, String pStyleVal, NodeIterator childResults)	This is invoked on every paragraph, whether it has a pPr or not.
static DocumentFragment	createBlockForRPr(FOConversionContext context, NodeIterator pPrNodeIt, NodeIterator rPrNodeIt, NodeIterator childResults)	On a block representing a run, we just put run properties from this rPr node.
static DocumentFragment	createBlockForSdt(FOConversionContext context, NodeIterator pPrNodeIt, String pStyleVal, NodeIterator childResults, String tag)
private static void	createFoAttributes(OpcPackage opcPackage, PPr pPr, Element foBlockElement, boolean inList, boolean ignoreBorders)
private static void	createFoAttributes(OpcPackage opcPackage, RPr rPr, Element foInlineElement)
private static void	createFoAttributes(TcPr tcPr, Element foBlockElement)
private static void	createFoAttributes(TrPr trPr, Element foBlockElement)
static DocumentFragment	createInlineForSdt(FOConversionContext context, NodeIterator rPrNodeIt, NodeIterator childResults, String tag)
protected static boolean	createListBlock(WordprocessingMLPackage wmlPackage, RunFontSelector runFontSelector, String pStyleVal, PPr pPrDirect, PPr pPr, RPr rPr, RPr rPrParagraphMark, Document document, Element foBlockElement, Element foListBlock)
private static boolean	foContainsElement(Node sourceNode, String elementName)	Recurse sourceNode looking to see whether it contains element with local name elementName
protected static int	getDistanceToNextTabStop(int pos, int numWidth, Tabs pprTabs, DocumentSettingsPart settings)
static String	getForcePageCount(FOConversionContext context)	FOP inserts a blank page if necessary so that a section with page numbering from 1 would be face up when printed double sided.
static DocumentFragment	getLayoutMasterSetFragment(AbstractWmlConversionContext context)
static String	getPageNumberFormat(FOConversionContext context)
static String	getPageNumberInitial(FOConversionContext context)
static boolean	hasPgNumTypeStart(FOConversionContext context)
private static boolean	isOdd(SectPr sectPr)
protected static void	setFont(RunFontSelector runFontSelector, Element foListItemLabelBody, PPr pPr, RPr rPr, String text)	Use RunFontSelector to determine the correct font for the list item label.

Methods inherited from class java.lang.Object

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

Field Details

log

private static org.slf4j.Logger log

Constructor Details

XsltFOFunctions

public XsltFOFunctions()

Method Details

getLayoutMasterSetFragment

public static DocumentFragment getLayoutMasterSetFragment(AbstractWmlConversionContext context)

createBlockForSdt

public static DocumentFragment createBlockForSdt(FOConversionContext context,
 NodeIterator pPrNodeIt,
 String pStyleVal,
 NodeIterator childResults,
 String tag)

createInlineForSdt

public static DocumentFragment createInlineForSdt(FOConversionContext context,
 NodeIterator rPrNodeIt,
 NodeIterator childResults,
 String tag)

createBlockForPPr

public static DocumentFragment createBlockForPPr(FOConversionContext context,
 NodeIterator pPrNodeIt,
 String pStyleVal,
 NodeIterator childResults)

This is invoked on every paragraph, whether it has a pPr or not.

Parameters:

wmlPackage -

pPrNodeIt -

pStyleVal -

childResults - - the already transformed contents of the paragraph.

Returns:

foContainsElement

private static boolean foContainsElement(Node sourceNode,
 String elementName)

Recurse sourceNode looking to see whether it contains element with local name elementName

Parameters:

sourceNode -

elementName -

Returns:

createBlock

private static DocumentFragment createBlock(FOConversionContext context,
 NodeIterator pPrNodeIt,
 String pStyleVal,
 NodeIterator childResults,
 boolean sdt)

createBlock

protected static DocumentFragment createBlock(WordprocessingMLPackage wmlPackage,
 RunFontSelector runFontSelector,
 String pStyleVal,
 NodeIterator childResults,
 boolean sdt,
 PPr pPrDirect,
 PPr pPr,
 RPr rPr,
 RPr rPrParagraphMark)

createListBlock

protected static boolean createListBlock(WordprocessingMLPackage wmlPackage,
 RunFontSelector runFontSelector,
 String pStyleVal,
 PPr pPrDirect,
 PPr pPr,
 RPr rPr,
 RPr rPrParagraphMark,
 Document document,
 Element foBlockElement,
 Element foListBlock)

setFont

protected static void setFont(RunFontSelector runFontSelector,
 Element foListItemLabelBody,
 PPr pPr,
 RPr rPr,
 String text)

Use RunFontSelector to determine the correct font for the list item label.

Parameters:

context -

foListItemLabelBody -

pPr -

rPr -

text -

getDistanceToNextTabStop

protected static int getDistanceToNextTabStop(int pos,
 int numWidth,
 Tabs pprTabs,
 DocumentSettingsPart settings)

createFoAttributes

private static void createFoAttributes(OpcPackage opcPackage,
 PPr pPr,
 Element foBlockElement,
 boolean inList,
 boolean ignoreBorders)

applyFoAttributes

public static void applyFoAttributes(List<Property> properties,
 Element foElement)

createFoAttributes

private static void createFoAttributes(TrPr trPr,
 Element foBlockElement)

createFoAttributes

private static void createFoAttributes(TcPr tcPr,
 Element foBlockElement)

createBlockForRPr

public static DocumentFragment createBlockForRPr(FOConversionContext context,
 NodeIterator pPrNodeIt,
 NodeIterator rPrNodeIt,
 NodeIterator childResults)

On a block representing a run, we just put run properties from this rPr node. The paragraph style rPr's have been taken care of on the fo block which represents the paragraph.

Parameters:

wmlPackage -

rPrNodeIt -

childResults -

Returns:

createFoAttributes

private static void createFoAttributes(OpcPackage opcPackage,
 RPr rPr,
 Element foInlineElement)

getPageNumberFormat

public static String getPageNumberFormat(FOConversionContext context)

getPageNumberInitial

public static String getPageNumberInitial(FOConversionContext context)

getForcePageCount

public static String getForcePageCount(FOConversionContext context)

FOP inserts a blank page if necessary so that a section with page numbering from 1 would be face up when printed double sided. Word doesn't do that (unless you have an odd section type), so this function mimics Word's behaviour.

Parameters:

context -

Returns:

Since:

3.2.2

isOdd

private static boolean isOdd(SectPr sectPr)

hasPgNumTypeStart

public static boolean hasPgNumTypeStart(FOConversionContext context)