Package net.sf.jasperreports.export

Class AbstractXlsExporterConfiguration

java.lang.Object

net.sf.jasperreports.export.SimpleCommonExportConfiguration

net.sf.jasperreports.export.SimpleExporterConfiguration

net.sf.jasperreports.export.AbstractXlsExporterConfiguration

All Implemented Interfaces:

CommonExportConfiguration, ExporterConfiguration, XlsExporterConfiguration

Direct Known Subclasses:

SimpleOdsExporterConfiguration, SimpleXlsExporterConfiguration, SimpleXlsMetadataExporterConfiguration

public abstract class AbstractXlsExporterConfiguration
extends SimpleExporterConfiguration
implements XlsExporterConfiguration

Author:

Teodor Danciu ([email protected])

Field Summary

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

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

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

PROPERTY_CREATE_CUSTOM_PALETTE, PROPERTY_ENCRYPTION_PASSWORD, PROPERTY_METADATA_APPLICATION, PROPERTY_METADATA_AUTHOR, PROPERTY_METADATA_KEYWORDS, PROPERTY_METADATA_SUBJECT, PROPERTY_METADATA_TITLE, PROPERTY_WORKBOOK_TEMPLATE, PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS

Constructor Summary

Constructors

Constructor	Description
AbstractXlsExporterConfiguration()

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 XLS document.
String	getMetadataAuthor()	The Author of the XLS document.
String	getMetadataKeywords()	The Keywords of the XLS document.
String	getMetadataSubject()	The Subject of the XLS document.
String	getMetadataTitle()	The Title of the XLS document.
String	getWorkbookTemplate()	Setting that specifies the location of an existing workbook template.
Boolean	isCreateCustomPalette()	Returns a boolean value specifying whether the standard color palette should be customized so that the XLS result uses the original report colors.
Boolean	isKeepWorkbookTemplateSheets()	Flag that specifies whether to keep the sheets of the existing template into generated document.
void	setCreateCustomPalette(Boolean isCreateCustomPalette)
void	setEncryptionPassword(String encryptionPassword)
void	setKeepWorkbookTemplateSheets(Boolean isKeepWorkbookTemplateSheets)
void	setMetadataApplication(String metadataApplication)
void	setMetadataAuthor(String metadataAuthor)
void	setMetadataKeywords(String metadataKeywords)
void	setMetadataSubject(String metadataSubject)
void	setMetadataTitle(String metadataTitle)
void	setWorkbookTemplate(String workbookTemplate)

Methods inherited from class net.sf.jasperreports.export.SimpleCommonExportConfiguration

isOverrideHints, setOverrideHints

Methods inherited from class java.lang.Object

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

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

isOverrideHints

Constructor Detail

AbstractXlsExporterConfiguration

public AbstractXlsExporterConfiguration()

Method Detail

isCreateCustomPalette

public Boolean isCreateCustomPalette()

Description copied from interface: XlsExporterConfiguration

Returns a boolean value specifying whether the standard color palette should be customized so that the XLS result uses the original report colors.

The default state of this flag is given by the net.sf.jasperreports.export.xls.create.custom.palette property.

The colors used in the result XLS are determined in the following manner:

1. If this flag is not set, the nearest color from the standard XLS palette is chosen for a report color.
2. If the flag is set, the nearest not yet modified color from the palette is chosen and modified to exactly match the report color. If all the colors from the palette are modified (the palette has a fixed size), the nearest color from the palette is chosen for further report colors.

Specified by:

isCreateCustomPalette in interface XlsExporterConfiguration

See Also:

XlsExporterConfiguration.PROPERTY_CREATE_CUSTOM_PALETTE

setCreateCustomPalette

public void setCreateCustomPalette(Boolean isCreateCustomPalette)

getWorkbookTemplate

public String getWorkbookTemplate()

Description copied from interface: XlsExporterConfiguration

Setting that specifies the location of an existing workbook template. The content of an existing workbook document or template can be embedded into exported document if the template location is known. In this case the content of the template will be exported first and the content of the exported report will be appended to this one. Macros and other settings in the existing template will be also preserved in the generated document. Templates can be loaded from Excel template files (*.xlt) as well as from valid Excel documents (*.xls).

This setting is used in the Excel exporter based on Apache POI APIs (JRXlsExporter). There's no similar property for the JRXlsxExporter.

Specified by:

getWorkbookTemplate in interface XlsExporterConfiguration

See Also:

XlsExporterConfiguration.PROPERTY_WORKBOOK_TEMPLATE

setWorkbookTemplate

public void setWorkbookTemplate(String workbookTemplate)

isKeepWorkbookTemplateSheets

public Boolean isKeepWorkbookTemplateSheets()

Description copied from interface: XlsExporterConfiguration

Flag that specifies whether to keep the sheets of the existing template into generated document. Sometimes is important to embed in a generated document only macros and/or other global settings from an existing template, but without keeping the own sheets of the template document. If set to false, this property prevent the template sheets to be exported.

This setting is used in conjunction with XlsExporterConfiguration.getWorkbookTemplate().

Specified by:

isKeepWorkbookTemplateSheets in interface XlsExporterConfiguration

See Also:

XlsExporterConfiguration.PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS

setKeepWorkbookTemplateSheets

public void setKeepWorkbookTemplateSheets(Boolean isKeepWorkbookTemplateSheets)

getMetadataTitle

public String getMetadataTitle()

Description copied from interface: XlsExporterConfiguration

The Title of the XLS document.

Specified by:

getMetadataTitle in interface XlsExporterConfiguration

setMetadataTitle

public void setMetadataTitle(String metadataTitle)

getMetadataAuthor

public String getMetadataAuthor()

Description copied from interface: XlsExporterConfiguration

The Author of the XLS document.

Specified by:

getMetadataAuthor in interface XlsExporterConfiguration

setMetadataAuthor

public void setMetadataAuthor(String metadataAuthor)

getMetadataSubject

public String getMetadataSubject()

Description copied from interface: XlsExporterConfiguration

The Subject of the XLS document.

Specified by:

getMetadataSubject in interface XlsExporterConfiguration

setMetadataSubject

public void setMetadataSubject(String metadataSubject)

getMetadataKeywords

public String getMetadataKeywords()

Description copied from interface: XlsExporterConfiguration

The Keywords of the XLS document.

Specified by:

getMetadataKeywords in interface XlsExporterConfiguration

setMetadataKeywords

public void setMetadataKeywords(String metadataKeywords)

getMetadataApplication

public String getMetadataApplication()

Description copied from interface: XlsExporterConfiguration

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

Specified by:

getMetadataApplication in interface XlsExporterConfiguration

setMetadataApplication

public void setMetadataApplication(String metadataApplication)

getEncryptionPassword

public String getEncryptionPassword()

Description copied from interface: XlsExporterConfiguration

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

Specified by:

getEncryptionPassword in interface XlsExporterConfiguration

See Also:

XlsExporterConfiguration.PROPERTY_ENCRYPTION_PASSWORD

setEncryptionPassword

public void setEncryptionPassword(String encryptionPassword)