All Superinterfaces:

CommonExportConfiguration, ExporterConfiguration

All Known Subinterfaces:

OdsExporterConfiguration, XlsMetadataExporterConfiguration, XlsxExporterConfiguration, XlsxMetadataExporterConfiguration

All Known Implementing Classes:

AbstractXlsExporterConfiguration, SimpleOdsExporterConfiguration, SimpleXlsExporterConfiguration, SimpleXlsMetadataExporterConfiguration, SimpleXlsxExporterConfiguration, SimpleXlsxMetadataExporterConfiguration
```
public interface XlsExporterConfiguration
extends ExporterConfiguration
```
Interface containing settings used by the Excel exporters.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

JRXlsExporter, JRXlsxExporter, JROdsExporter, JRXlsMetadataExporter

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`PROPERTY_CREATE_CUSTOM_PALETTE`	Property whose value is used as default state of the `isCreateCustomPalette()` export configuration flag.
`static String`	`PROPERTY_ENCRYPTION_PASSWORD`	Property whose value is used as default for the `getEncryptionPassword()` export configuration setting.
`static String`	`PROPERTY_METADATA_APPLICATION`	Property whose value is used as default for the `getMetadataApplication()` export configuration setting.
`static String`	`PROPERTY_METADATA_AUTHOR`	Property whose value is used as default for the `getMetadataAuthor()` export configuration setting.
`static String`	`PROPERTY_METADATA_KEYWORDS`	Property whose value is used as default for the `getMetadataKeywords()` export configuration setting.
`static String`	`PROPERTY_METADATA_SUBJECT`	Property whose value is used as default for the `getMetadataSubject()` export configuration setting.
`static String`	`PROPERTY_METADATA_TITLE`	Property whose value is used as default for the `getMetadataTitle()` export configuration setting.
`static String`	`PROPERTY_WORKBOOK_TEMPLATE`	Property that provides a default value for the `getWorkbookTemplate()` export configuration setting.
`static String`	`PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS`	Property that provides a default value for the `isKeepWorkbookTemplateSheets()` export configuration flag.

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

Method Summary

All Methods Instance Methods Abstract Methods
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.

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

- Field Detail
  - PROPERTY_CREATE_CUSTOM_PALETTE
```
static final String PROPERTY_CREATE_CUSTOM_PALETTE
```
    Property whose value is used as default state of the isCreateCustomPalette() export configuration flag.
    This property is by default not set (false).
    
    See Also:
    
    JRPropertiesUtil, Constant Field Values
  - PROPERTY_WORKBOOK_TEMPLATE
```
static final String PROPERTY_WORKBOOK_TEMPLATE
```
    Property that provides a default value for the getWorkbookTemplate() export configuration setting.
    
    Since:
    
    4.5.1
    
    See Also:
    
    JRPropertiesUtil, Constant Field Values
  - PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS
```
static final String PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS
```
    Property that provides a default value for the isKeepWorkbookTemplateSheets() export configuration flag.
    This property is used in conjunction with PROPERTY_WORKBOOK_TEMPLATE.
    Default value is false.
    
    Since:
    
    4.5.1
    
    See Also:
    
    JRPropertiesUtil, Constant Field Values
  - 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_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 Detail
  - isCreateCustomPalette
```
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.
    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:
    
    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.
    See Also:
    
    PROPERTY_CREATE_CUSTOM_PALETTE
  - getWorkbookTemplate
```
String getWorkbookTemplate()
```
    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.
    
    See Also:
    
    PROPERTY_WORKBOOK_TEMPLATE
  - isKeepWorkbookTemplateSheets
```
Boolean isKeepWorkbookTemplateSheets()
```
    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 getWorkbookTemplate().
    
    See Also:
    
    PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS
  - getMetadataTitle
```
String getMetadataTitle()
```
    The Title of the XLS document.
  - getMetadataAuthor
```
String getMetadataAuthor()
```
    The Author of the XLS document.
  - getMetadataSubject
```
String getMetadataSubject()
```
    The Subject of the XLS document.
  - getMetadataKeywords
```
String getMetadataKeywords()
```
    The Keywords of the XLS document.
  - getMetadataApplication
```
String getMetadataApplication()
```
    The Application for the XLS document. Defaults to "JasperReports Library version x.x.x".
  - getEncryptionPassword
```
String getEncryptionPassword()
```
    The encryption password needed to open the document, if it is encrypted.
    
    See Also:
    
    PROPERTY_ENCRYPTION_PASSWORD

Interface XlsExporterConfiguration

Field Summary

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

Method Summary

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

Field Detail

PROPERTY_CREATE_CUSTOM_PALETTE

PROPERTY_WORKBOOK_TEMPLATE

PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS

PROPERTY_METADATA_TITLE

PROPERTY_METADATA_AUTHOR

PROPERTY_METADATA_SUBJECT

PROPERTY_METADATA_KEYWORDS

PROPERTY_METADATA_APPLICATION

PROPERTY_ENCRYPTION_PASSWORD

Method Detail

isCreateCustomPalette

getWorkbookTemplate

isKeepWorkbookTemplateSheets

getMetadataTitle

getMetadataAuthor

getMetadataSubject

getMetadataKeywords

getMetadataApplication

getEncryptionPassword