Package org.docx4j.convert.out

Class AbstractConversionSettings

java.lang.Object
org.docx4j.convert.out.AbstractConversionSettings
Direct Known Subclasses:
Documents4jConversionSettings, FOSettings, HTMLSettings, MicrosoftGraphConversionSettings, SvgExporter.SvgSettings
public abstract class AbstractConversionSettings
extends java.lang.Object
The Settings classes pass everything that’s needed to the conversion process.
Since:
3.0

  • Field Details

    • IMAGE_INCLUDE_UUID

      public static final java.lang.String IMAGE_INCLUDE_UUID
      See Also:
      Constant Field Values

    • IMAGE_DIR_PATH

      public static final java.lang.String IMAGE_DIR_PATH
      See Also:
      Constant Field Values

    • IMAGE_HANDLER

      public static final java.lang.String IMAGE_HANDLER
      See Also:
      Constant Field Values

    • OPC_PACKAGE

      public static final java.lang.String OPC_PACKAGE
      See Also:
      Constant Field Values

    • CUSTOM_XSLT_TEMPLATES

      public static final java.lang.String CUSTOM_XSLT_TEMPLATES
      See Also:
      Constant Field Values

    • settings

      protected java.util.Map<java.lang.String,​java.lang.Object> settings

    • features

      protected java.util.Set<java.lang.String> features

  • Constructor Details

    • AbstractConversionSettings

      public AbstractConversionSettings()

  • Method Details

    • getSettings

      public java.util.Map<java.lang.String,​java.lang.Object> getSettings()

    • getFeatures

      public java.util.Set<java.lang.String> getFeatures()

    • addFeatures

      public void addFeatures​(java.lang.String[] featuresArray)

    • setImageDirPath

      public void setImageDirPath​(java.lang.String imageDirPath)

    • getImageDirPath

      public java.lang.String getImageDirPath()

    • setImageIncludeUUID

      public void setImageIncludeUUID​(boolean imageIncludeUUID)
      Should the image names be prefixed with an UUID to differentiate runs? Default: true

    • isImageIncludeUUID

      public boolean isImageIncludeUUID()

    • setImageHandler

      public void setImageHandler​(ConversionImageHandler imageHandler)

    • getImageHandler

      public ConversionImageHandler getImageHandler()

    • setHyperlinkHandler

      public void setHyperlinkHandler​(ConversionHyperlinkHandler hyperlinkHandler)

    • getHyperlinkHandler

      public ConversionHyperlinkHandler getHyperlinkHandler()

    • setWmlPackage

      @Deprecated public void setWmlPackage​(OpcPackage wmlPackage)
      Deprecated.

    • setOpcPackage

      public void setOpcPackage​(OpcPackage opcPackage) throws Docx4JException
      Throws:
      Docx4JException

    • getOpcPackage

      public OpcPackage getOpcPackage()

    • setCustomXsltTemplates

      public void setCustomXsltTemplates​(java.lang.Object templates)
      Pass a custom xslt template to do the transformation.
      This template will only be used if you have selected an export that uses templates. The signature is defined as Object templates, to not introduce a dependency on javax.xml.transform - but don't expect it to work if you pass something different than a javax.xml.transform.Templates.

    • getCustomXsltTemplates

      public java.lang.Object getCustomXsltTemplates()