Package org.docx4j.convert.out.fo

Class XsltFOFunctions

java.lang.Object
org.docx4j.convert.out.fo.XsltFOFunctions
public class XsltFOFunctions
extends java.lang.Object
This class contains static functions that are specific to the FO xsl-transformation and are called from docx2fo.xslt.

  • Constructor Summary

    Constructors
    Constructor Description
    XsltFOFunctions()  

  • Method Summary

    Modifier and Type Method Description
    static void applyFoAttributes​(java.util.List<Property> properties, org.w3c.dom.Element foElement)  
    protected static org.w3c.dom.DocumentFragment createBlock​(WordprocessingMLPackage wmlPackage, RunFontSelector runFontSelector, java.lang.String pStyleVal, org.w3c.dom.traversal.NodeIterator childResults, boolean sdt, org.docx4j.wml.PPr pPrDirect, org.docx4j.wml.PPr pPr, org.docx4j.wml.RPr rPr, org.docx4j.wml.RPr rPrParagraphMark)  
    static org.w3c.dom.DocumentFragment createBlockForPPr​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator pPrNodeIt, java.lang.String pStyleVal, org.w3c.dom.traversal.NodeIterator childResults)
    This is invoked on every paragraph, whether it has a pPr or not.
    static org.w3c.dom.DocumentFragment createBlockForRPr​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator pPrNodeIt, org.w3c.dom.traversal.NodeIterator rPrNodeIt, org.w3c.dom.traversal.NodeIterator childResults)
    On a block representing a run, we just put run properties from this rPr node.
    static org.w3c.dom.DocumentFragment createBlockForSdt​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator pPrNodeIt, java.lang.String pStyleVal, org.w3c.dom.traversal.NodeIterator childResults, java.lang.String tag)  
    static org.w3c.dom.DocumentFragment createInlineForSdt​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator rPrNodeIt, org.w3c.dom.traversal.NodeIterator childResults, java.lang.String tag)  
    protected static boolean createListBlock​(WordprocessingMLPackage wmlPackage, RunFontSelector runFontSelector, java.lang.String pStyleVal, org.docx4j.wml.PPr pPrDirect, org.docx4j.wml.PPr pPr, org.docx4j.wml.RPr rPr, org.docx4j.wml.RPr rPrParagraphMark, org.w3c.dom.Document document, org.w3c.dom.Element foBlockElement, org.w3c.dom.Element foListBlock)  
    protected static int getDistanceToNextTabStop​(int pos, int numWidth, org.docx4j.wml.Tabs pprTabs, DocumentSettingsPart settings)  
    static java.lang.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 org.w3c.dom.DocumentFragment getLayoutMasterSetFragment​(AbstractWmlConversionContext context)  
    static java.lang.String getPageNumberFormat​(FOConversionContext context)  
    static java.lang.String getPageNumberInitial​(FOConversionContext context)  
    static boolean hasPgNumTypeStart​(FOConversionContext context)  
    protected static void setFont​(RunFontSelector runFontSelector, org.w3c.dom.Element foListItemLabelBody, org.docx4j.wml.PPr pPr, org.docx4j.wml.RPr rPr, java.lang.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

  • Constructor Details

    • XsltFOFunctions

      public XsltFOFunctions()

  • Method Details

    • getLayoutMasterSetFragment

      public static org.w3c.dom.DocumentFragment getLayoutMasterSetFragment​(AbstractWmlConversionContext context)

    • createBlockForSdt

      public static org.w3c.dom.DocumentFragment createBlockForSdt​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator pPrNodeIt, java.lang.String pStyleVal, org.w3c.dom.traversal.NodeIterator childResults, java.lang.String tag)

    • createInlineForSdt

      public static org.w3c.dom.DocumentFragment createInlineForSdt​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator rPrNodeIt, org.w3c.dom.traversal.NodeIterator childResults, java.lang.String tag)

    • createBlockForPPr

      public static org.w3c.dom.DocumentFragment createBlockForPPr​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator pPrNodeIt, java.lang.String pStyleVal, org.w3c.dom.traversal.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:

    • createBlock

      protected static org.w3c.dom.DocumentFragment createBlock​(WordprocessingMLPackage wmlPackage, RunFontSelector runFontSelector, java.lang.String pStyleVal, org.w3c.dom.traversal.NodeIterator childResults, boolean sdt, org.docx4j.wml.PPr pPrDirect, org.docx4j.wml.PPr pPr, org.docx4j.wml.RPr rPr, org.docx4j.wml.RPr rPrParagraphMark)

    • createListBlock

      protected static boolean createListBlock​(WordprocessingMLPackage wmlPackage, RunFontSelector runFontSelector, java.lang.String pStyleVal, org.docx4j.wml.PPr pPrDirect, org.docx4j.wml.PPr pPr, org.docx4j.wml.RPr rPr, org.docx4j.wml.RPr rPrParagraphMark, org.w3c.dom.Document document, org.w3c.dom.Element foBlockElement, org.w3c.dom.Element foListBlock)

    • setFont

      protected static void setFont​(RunFontSelector runFontSelector, org.w3c.dom.Element foListItemLabelBody, org.docx4j.wml.PPr pPr, org.docx4j.wml.RPr rPr, java.lang.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, org.docx4j.wml.Tabs pprTabs, DocumentSettingsPart settings)

    • applyFoAttributes

      public static void applyFoAttributes​(java.util.List<Property> properties, org.w3c.dom.Element foElement)

    • createBlockForRPr

      public static org.w3c.dom.DocumentFragment createBlockForRPr​(FOConversionContext context, org.w3c.dom.traversal.NodeIterator pPrNodeIt, org.w3c.dom.traversal.NodeIterator rPrNodeIt, org.w3c.dom.traversal.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:

    • getPageNumberFormat

      public static java.lang.String getPageNumberFormat​(FOConversionContext context)

    • getPageNumberInitial

      public static java.lang.String getPageNumberInitial​(FOConversionContext context)

    • getForcePageCount

      public static java.lang.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

    • hasPgNumTypeStart

      public static boolean hasPgNumTypeStart​(FOConversionContext context)