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 (teodord@users.sourceforge.net)
-
Field Summary
Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTSFields 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 -
Method Summary
Modifier and TypeMethodDescriptionThe encryption password needed to open the document, if it is encrypted.The Application for the XLS document.The Author of the XLS document.The Keywords of the XLS document.The Subject of the XLS document.The Title of the XLS document.Setting that specifies the location of an existing workbook template.Returns a boolean value specifying whether the standard color palette should be customized so that the XLS result uses the original report colors.Flag that specifies whether to keep the sheets of the existing template into generated document.voidsetCreateCustomPalette(Boolean isCreateCustomPalette) voidsetEncryptionPassword(String encryptionPassword) voidsetKeepWorkbookTemplateSheets(Boolean isKeepWorkbookTemplateSheets) voidsetMetadataApplication(String metadataApplication) voidsetMetadataAuthor(String metadataAuthor) voidsetMetadataKeywords(String metadataKeywords) voidsetMetadataSubject(String metadataSubject) voidsetMetadataTitle(String metadataTitle) voidsetWorkbookTemplate(String workbookTemplate) Methods inherited from class net.sf.jasperreports.export.SimpleCommonExportConfiguration
isOverrideHints, setOverrideHintsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
isOverrideHints
-
Constructor Details
-
AbstractXlsExporterConfiguration
public AbstractXlsExporterConfiguration()
-
-
Method Details
-
isCreateCustomPalette
Description copied from interface:XlsExporterConfigurationReturns 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 thenet.sf.jasperreports.export.xls.create.custom.paletteproperty. The colors used in the result XLS are determined in the following manner:- If this flag is not set, the nearest color from the standard XLS palette is chosen for a report color.
- 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:
isCreateCustomPalettein interfaceXlsExporterConfiguration- See Also:
-
setCreateCustomPalette
-
getWorkbookTemplate
Description copied from interface:XlsExporterConfigurationSetting 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 theJRXlsxExporter.- Specified by:
getWorkbookTemplatein interfaceXlsExporterConfiguration- See Also:
-
setWorkbookTemplate
-
isKeepWorkbookTemplateSheets
Description copied from interface:XlsExporterConfigurationFlag 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:
isKeepWorkbookTemplateSheetsin interfaceXlsExporterConfiguration- See Also:
-
setKeepWorkbookTemplateSheets
-
getMetadataTitle
Description copied from interface:XlsExporterConfigurationThe Title of the XLS document.- Specified by:
getMetadataTitlein interfaceXlsExporterConfiguration
-
setMetadataTitle
-
getMetadataAuthor
Description copied from interface:XlsExporterConfigurationThe Author of the XLS document.- Specified by:
getMetadataAuthorin interfaceXlsExporterConfiguration
-
setMetadataAuthor
-
getMetadataSubject
Description copied from interface:XlsExporterConfigurationThe Subject of the XLS document.- Specified by:
getMetadataSubjectin interfaceXlsExporterConfiguration
-
setMetadataSubject
-
getMetadataKeywords
Description copied from interface:XlsExporterConfigurationThe Keywords of the XLS document.- Specified by:
getMetadataKeywordsin interfaceXlsExporterConfiguration
-
setMetadataKeywords
-
getMetadataApplication
Description copied from interface:XlsExporterConfigurationThe Application for the XLS document. Defaults to "JasperReports Library version x.x.x".- Specified by:
getMetadataApplicationin interfaceXlsExporterConfiguration
-
setMetadataApplication
-
getEncryptionPassword
Description copied from interface:XlsExporterConfigurationThe encryption password needed to open the document, if it is encrypted.- Specified by:
getEncryptionPasswordin interfaceXlsExporterConfiguration- See Also:
-
setEncryptionPassword
-