net.sf.jasperreports.engine.export
Class JExcelApiExporterParameter

java.lang.Object
  net.sf.jasperreports.engine.JRExporterParameter
      net.sf.jasperreports.engine.export.JRXlsAbstractExporterParameter
          net.sf.jasperreports.engine.export.JExcelApiExporterParameter

public class JExcelApiExporterParameter
extends JRXlsAbstractExporterParameter

Version:

$Id: JExcelApiExporterParameter.java 2253 2008-08-07 14:29:38Z teodord $

Author:

Manuel Paul (mpaul@ratundtat.com)

Field Summary

static JRExporterParameter	CREATE_CUSTOM_PALETTE A boolean value specifying whether the standard color palette should be customized so that the XLS result uses the original report colors.
static JRExporterParameter	PASSWORD A String value representing the password in case of password protected documents
static java.lang.String	PROPERTY_CREATE_CUSTOM_PALETTE Property whose value is used as default state of the CREATE_CUSTOM_PALETTE export flag.
static java.lang.String	PROPERTY_PASSWORD Property whose value is used as default value of the PASSWORD export parameter.

Fields inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporterParameter

FORMAT_PATTERNS_MAP, IS_AUTO_DETECT_CELL_TYPE, IS_COLLAPSE_ROW_SPAN, IS_DETECT_CELL_TYPE, IS_FONT_SIZE_FIX_ENABLED, IS_IGNORE_CELL_BORDER, IS_IGNORE_GRAPHICS, IS_IMAGE_BORDER_FIX_ENABLED, IS_ONE_PAGE_PER_SHEET, IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS, IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS, IS_WHITE_PAGE_BACKGROUND, MAXIMUM_ROWS_PER_SHEET, PROPERTY_COLLAPSE_ROW_SPAN, PROPERTY_DETECT_CELL_TYPE, PROPERTY_FONT_SIZE_FIX_ENABLED, PROPERTY_IGNORE_CELL_BORDER, PROPERTY_IGNORE_GRAPHICS, PROPERTY_IMAGE_BORDER_FIX_ENABLED, PROPERTY_MAXIMUM_ROWS_PER_SHEET, PROPERTY_ONE_PAGE_PER_SHEET, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS, PROPERTY_WHITE_PAGE_BACKGROUND, SHEET_NAMES

Fields inherited from class net.sf.jasperreports.engine.JRExporterParameter

CHARACTER_ENCODING, CLASS_LOADER, END_PAGE_INDEX, FILE_RESOLVER, FILTER, FONT_MAP, HYPERLINK_PRODUCER_FACTORY, IGNORE_PAGE_MARGINS, INPUT_FILE, INPUT_FILE_NAME, INPUT_STREAM, INPUT_URL, JASPER_PRINT, JASPER_PRINT_LIST, OFFSET_X, OFFSET_Y, OUTPUT_FILE, OUTPUT_FILE_NAME, OUTPUT_STREAM, OUTPUT_STRING_BUFFER, OUTPUT_WRITER, PAGE_INDEX, PARAMETERS_OVERRIDE_REPORT_HINTS, PROGRESS_MONITOR, PROPERTY_CHARACTER_ENCODING, PROPERTY_EXPORT_PARAMETERS_OVERRIDE_REPORT_HINTS, PROPERTY_IGNORE_PAGE_MARGINS, START_PAGE_INDEX, URL_HANDLER_FACTORY

Constructor Summary

protected

JExcelApiExporterParameter(java.lang.String name)

Method Summary

Methods inherited from class net.sf.jasperreports.engine.JRExporterParameter

toString

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_CUSTOM_PALETTE

public static final JRExporterParameter CREATE_CUSTOM_PALETTE

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

PROPERTY_CREATE_CUSTOM_PALETTE

public static final java.lang.String PROPERTY_CREATE_CUSTOM_PALETTE

Property whose value is used as default state of the CREATE_CUSTOM_PALETTE export flag.

This property is by default not set (false).

See Also:

JRProperties, Constant Field Values

PASSWORD

public static final JRExporterParameter PASSWORD

A String value representing the password in case of password protected documents

PROPERTY_PASSWORD

public static final java.lang.String PROPERTY_PASSWORD

Property whose value is used as default value of the PASSWORD export parameter.

This property is by default not set (null).

See Also:

JRProperties, Constant Field Values

Constructor Detail

JExcelApiExporterParameter

protected JExcelApiExporterParameter(java.lang.String name)