Package net.sf.jasperreports.export

Interface DocxExporterConfiguration

All Superinterfaces:

CommonExportConfiguration, ExporterConfiguration

All Known Implementing Classes:

SimpleDocxExporterConfiguration

public interface DocxExporterConfiguration
extends ExporterConfiguration

Interface containing settings used by the DOCX exporter.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• JRDocxExporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_EMBED_FONTS	Property that indicates whether the true type fonts used in the report should be embedded into the generated DOCX document.
static final String	PROPERTY_ENCRYPTION_PASSWORD	Property whose value is used as default for the getEncryptionPassword() export configuration setting.
static final String	PROPERTY_METADATA_APPLICATION	Property whose value is used as default for the getMetadataApplication() export configuration setting.
static final String	PROPERTY_METADATA_AUTHOR	Property whose value is used as default for the getMetadataAuthor() export configuration setting.
static final String	PROPERTY_METADATA_KEYWORDS	Property whose value is used as default for the getMetadataKeywords() export configuration setting.
static final String	PROPERTY_METADATA_SUBJECT	Property whose value is used as default for the getMetadataSubject() export configuration setting.
static final String	PROPERTY_METADATA_TITLE	Property whose value is used as default for the getMetadataTitle() export configuration setting.

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Method Summary

Modifier and Type	Method	Description
String	getEncryptionPassword()	The encryption password needed to open the document, if it is encrypted.
String	getMetadataApplication()	The Application for the DOCX document.
String	getMetadataAuthor()	The Author of the DOCX document.
String	getMetadataKeywords()	The Keywords of the DOCX document.
String	getMetadataSubject()	The Subject of the DOCX document.
String	getMetadataTitle()	The Title of the DOCX document.
Boolean	isEmbedFonts()	Indicates whether the true type fonts used in the report should be embedded into the generated DOCX document.

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

isOverrideHints

Field Details

PROPERTY_METADATA_TITLE

static final String PROPERTY_METADATA_TITLE

Property whose value is used as default for the getMetadataTitle() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_AUTHOR

static final String PROPERTY_METADATA_AUTHOR

Property whose value is used as default for the getMetadataAuthor() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_SUBJECT

static final String PROPERTY_METADATA_SUBJECT

Property whose value is used as default for the getMetadataSubject() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_KEYWORDS

static final String PROPERTY_METADATA_KEYWORDS

Property whose value is used as default for the getMetadataKeywords() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_APPLICATION

static final String PROPERTY_METADATA_APPLICATION

Property whose value is used as default for the getMetadataApplication() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_EMBED_FONTS

static final String PROPERTY_EMBED_FONTS

Property that indicates whether the true type fonts used in the report should be embedded into the generated DOCX document. This property serves as default value for the isEmbedFonts() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_ENCRYPTION_PASSWORD

static final String PROPERTY_ENCRYPTION_PASSWORD

Property whose value is used as default for the getEncryptionPassword() export configuration setting.

See Also:

• JRPropertiesUtil
• Constant Field Values

Method Details

getMetadataTitle

String getMetadataTitle()

The Title of the DOCX document.

getMetadataAuthor

String getMetadataAuthor()

The Author of the DOCX document.

getMetadataSubject

String getMetadataSubject()

The Subject of the DOCX document.

getMetadataKeywords

String getMetadataKeywords()

The Keywords of the DOCX document.

getMetadataApplication

String getMetadataApplication()

The Application for the DOCX document. Defaults to "JasperReports Library version x.x.x".

isEmbedFonts

Boolean isEmbedFonts()

Indicates whether the true type fonts used in the report should be embedded into the generated DOCX document.

See Also:

• PROPERTY_EMBED_FONTS

getEncryptionPassword

String getEncryptionPassword()

The encryption password needed to open the document, if it is encrypted.

See Also:

• PROPERTY_ENCRYPTION_PASSWORD