org.docx4j.convert.out

Class AbstractConversionSettings

java.lang.Object

org.docx4j.convert.out.AbstractConversionSettings

All Implemented Interfaces:

ConversionFeatures

Direct Known Subclasses:

FOSettings, HTMLSettings, SvgExporter.SvgSettings

public abstract class AbstractConversionSettings
extends Object
implements ConversionFeatures

The Settings classes pass everything that’s needed to the conversion process.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_XSLT_TEMPLATES
protected Set<String>	features
static String	HYPERLINK_HANDLER
static String	IMAGE_DIR_PATH
static String	IMAGE_HANDLER
static String	IMAGE_INCLUDE_UUID
protected Map<String,Object>	settings
static String	WML_PACKAGE

Fields inherited from interface org.docx4j.convert.out.ConversionFeatures

DEFAULT_HTML_FEATURES, DEFAULT_PDF_FEATURES, PP_APACHEFOP_DISABLE_PAGEBREAK_FIRST_PARAGRAPH, PP_COMMON_COMBINE_FIELDS, PP_COMMON_CONTAINERIZATION, PP_COMMON_CREATE_SECTIONS, PP_COMMON_DEEP_COPY, PP_COMMON_DUMMY_CREATE_SECTIONS, PP_COMMON_DUMMY_PAGE_NUMBERING, PP_COMMON_MOVE_BOOKMARKS, PP_COMMON_MOVE_PAGEBREAK, PP_COMMON_PAGE_NUMBERING

Constructor Summary

Constructors

Constructor and Description
AbstractConversionSettings()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFeatures(String[] featuresArray)
Object	getCustomXsltTemplates()
Set<String>	getFeatures()
ConversionHyperlinkHandler	getHyperlinkHandler()
String	getImageDirPath()
ConversionImageHandler	getImageHandler()
Map<String,Object>	getSettings()
OpcPackage	getWmlPackage()
boolean	isImageIncludeUUID()
void	setCustomXsltTemplates(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.
void	setHyperlinkHandler(ConversionHyperlinkHandler hyperlinkHandler)
void	setImageDirPath(String imageDirPath)
void	setImageHandler(ConversionImageHandler imageHandler)
void	setImageIncludeUUID(boolean imageIncludeUUID) Should the image names be prefixed with an UUID to differentiate runs? Default: true
void	setWmlPackage(OpcPackage wmlPackage)

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE_INCLUDE_UUID

public static final String IMAGE_INCLUDE_UUID

See Also:

Constant Field Values

IMAGE_DIR_PATH

public static final String IMAGE_DIR_PATH

See Also:

Constant Field Values

IMAGE_HANDLER

public static final String IMAGE_HANDLER

See Also:

Constant Field Values

HYPERLINK_HANDLER

public static final String HYPERLINK_HANDLER

See Also:

Constant Field Values

WML_PACKAGE

public static final String WML_PACKAGE

See Also:

Constant Field Values

CUSTOM_XSLT_TEMPLATES

public static final String CUSTOM_XSLT_TEMPLATES

See Also:

Constant Field Values

settings

protected Map<String,Object> settings

features

protected Set<String> features

Constructor Detail

AbstractConversionSettings

public AbstractConversionSettings()

Method Detail

getSettings

public Map<String,Object> getSettings()

getFeatures

public Set<String> getFeatures()

addFeatures

public void addFeatures(String[] featuresArray)

setImageDirPath

public void setImageDirPath(String imageDirPath)

getImageDirPath

public 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

public void setWmlPackage(OpcPackage wmlPackage)

getWmlPackage

public OpcPackage getWmlPackage()

setCustomXsltTemplates

public void setCustomXsltTemplates(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 Object getCustomXsltTemplates()