Interface XlsExporterConfiguration

    • Method Detail

      • isCreateCustomPalette

        java.lang.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:

        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.
        See Also:
        PROPERTY_CREATE_CUSTOM_PALETTE
      • getWorkbookTemplate

        java.lang.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

        java.lang.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

        java.lang.String getMetadataTitle()
        The Title of the XLS document.
      • getMetadataAuthor

        java.lang.String getMetadataAuthor()
        The Author of the XLS document.
      • getMetadataSubject

        java.lang.String getMetadataSubject()
        The Subject of the XLS document.
      • getMetadataKeywords

        java.lang.String getMetadataKeywords()
        The Keywords of the XLS document.
      • getMetadataApplication

        java.lang.String getMetadataApplication()
        The Application for the XLS document. Defaults to "JasperReports Library version x.x.x".
      • getEncryptionPassword

        java.lang.String getEncryptionPassword()
        The encryption password needed to open the document, if it is encrypted.
        See Also:
        PROPERTY_ENCRYPTION_PASSWORD