net.sf.jasperreports.engine.export
Class JRXlsAbstractExporterParameter

java.lang.Object
  extended by net.sf.jasperreports.engine.JRExporterParameter
      extended by net.sf.jasperreports.engine.export.JRXlsAbstractExporterParameter
Direct Known Subclasses:
JExcelApiExporterParameter, JRXlsExporterParameter

public class JRXlsAbstractExporterParameter
extends JRExporterParameter

Contains parameters useful for export in XLS format.

The XLS exporter can send data to an output stream or file on disk. The engine looks among the export parameters in order to find the selected output type in this order: OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.

Version:
$Id: JRXlsAbstractExporterParameter.java 1838 2007-09-03 13:51:06Z teodord $
Author:
Sanda Zaharia (shertage@users.sourceforge.net)

Field Summary
static JRExporterParameter FORMAT_PATTERNS_MAP
          This export parameter should be used when converting java format patterns to equivalent proprietary format patterns.
static JRXlsAbstractExporterParameter IS_AUTO_DETECT_CELL_TYPE
          Deprecated. The IS_DETECT_CELL_TYPE offers more consistent numerical cell detection.
static JRXlsAbstractExporterParameter IS_COLLAPSE_ROW_SPAN
          Flag for collapsing row span and avoid merging cells across rows.
static JRXlsAbstractExporterParameter IS_DETECT_CELL_TYPE
          Flag used to indicate whether the exporter should take into consideration the type of the original text field expressions and set the cell types and values accordingly.
static JRXlsAbstractExporterParameter IS_FONT_SIZE_FIX_ENABLED
          Flag for decreasing font size so that texts fit into the specified cell height.
static JRXlsAbstractExporterParameter IS_IGNORE_CELL_BORDER
          Flag for ignoring the cell border.
static JRXlsAbstractExporterParameter IS_IGNORE_GRAPHICS
          Flag for ignoring graphic elements and exporting text elements only.
static JRXlsAbstractExporterParameter IS_ONE_PAGE_PER_SHEET
          A boolean value specifying whether each report page should be written in a different XLS sheet
static JRXlsAbstractExporterParameter IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
          A boolean value specifying whether the empty spaces that could appear between columns should be removed or not.
static JRXlsAbstractExporterParameter IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
          A boolean value specifying whether the empty spaces that could appear between rows should be removed or not.
static JRXlsAbstractExporterParameter IS_WHITE_PAGE_BACKGROUND
          A boolean value specifying whether the page background should be white or the default XLS background color.
static JRExporterParameter MAXIMUM_ROWS_PER_SHEET
          An integer value specifying the maximum number of rows allowed to be shown in a sheet.
static java.lang.String PROPERTY_COLLAPSE_ROW_SPAN
          Property whose value is used as default state of the IS_COLLAPSE_ROW_SPAN export flag.
static java.lang.String PROPERTY_DETECT_CELL_TYPE
          Property whose value is used as default state of the IS_DETECT_CELL_TYPE export flag.
static java.lang.String PROPERTY_FONT_SIZE_FIX_ENABLED
          Property whose value is used as default state of the IS_FONT_SIZE_FIX_ENABLED export flag.
static java.lang.String PROPERTY_IGNORE_CELL_BORDER
          Property whose value is used as default state of the IS_IGNORE_CELL_BORDER export flag.
static java.lang.String PROPERTY_IGNORE_GRAPHICS
          Property whose value is used as default state of the IS_IGNORE_GRAPHICS export flag.
static java.lang.String PROPERTY_MAXIMUM_ROWS_PER_SHEET
          Property whose value is used as default of the MAXIMUM_ROWS_PER_SHEET export parameter.
static java.lang.String PROPERTY_ONE_PAGE_PER_SHEET
          Property whose value is used as default state of the IS_ONE_PAGE_PER_SHEET export flag.
static java.lang.String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
          Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS export flag.
static java.lang.String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
          Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS export flag.
static java.lang.String PROPERTY_WHITE_PAGE_BACKGROUND
          Property whose value is used as default state of the IS_WHITE_PAGE_BACKGROUND export flag.
static JRXlsAbstractExporterParameter SHEET_NAMES
          An array of strings representing custom sheet names.
 
Fields inherited from class net.sf.jasperreports.engine.JRExporterParameter
CHARACTER_ENCODING, CLASS_LOADER, END_PAGE_INDEX, FILTER, FONT_MAP, HYPERLINK_PRODUCER_FACTORY, 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, START_PAGE_INDEX, URL_HANDLER_FACTORY
 
Constructor Summary
protected JRXlsAbstractExporterParameter(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

IS_ONE_PAGE_PER_SHEET

public static final JRXlsAbstractExporterParameter IS_ONE_PAGE_PER_SHEET
A boolean value specifying whether each report page should be written in a different XLS sheet


PROPERTY_ONE_PAGE_PER_SHEET

public static final java.lang.String PROPERTY_ONE_PAGE_PER_SHEET
Property whose value is used as default state of the IS_ONE_PAGE_PER_SHEET export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS

public static final JRXlsAbstractExporterParameter IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
A boolean value specifying whether the empty spaces that could appear between rows should be removed or not.


PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS

public static final java.lang.String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS

public static final JRXlsAbstractExporterParameter IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
A boolean value specifying whether the empty spaces that could appear between columns should be removed or not.


PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS

public static final java.lang.String PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

IS_WHITE_PAGE_BACKGROUND

public static final JRXlsAbstractExporterParameter IS_WHITE_PAGE_BACKGROUND
A boolean value specifying whether the page background should be white or the default XLS background color. This background may vary depending on the XLS viewer properties or the operating system color scheme.


PROPERTY_WHITE_PAGE_BACKGROUND

public static final java.lang.String PROPERTY_WHITE_PAGE_BACKGROUND
Property whose value is used as default state of the IS_WHITE_PAGE_BACKGROUND export flag.

This property is set by default (true).

See Also:
JRProperties, Constant Field Values

IS_AUTO_DETECT_CELL_TYPE

public static final JRXlsAbstractExporterParameter IS_AUTO_DETECT_CELL_TYPE
Deprecated. The IS_DETECT_CELL_TYPE offers more consistent numerical cell detection.
A boolean value specifying whether the exporter should try to automatically detect cell types based on the cell value.


IS_DETECT_CELL_TYPE

public static final JRXlsAbstractExporterParameter IS_DETECT_CELL_TYPE
Flag used to indicate whether the exporter should take into consideration the type of the original text field expressions and set the cell types and values accordingly.

Text fields having numerical or date expressions save type and formatting (format pattern, locale and time zone) information in the JasperPrint/JRPrintText object created by the report fill process.

When this flag is set, the exporter will parse back the String value of numerical/date texts. Numerical/date cells will be created and the original pattern of the text will be included as part of the cell style.

Note that this mechanism would not work when the text field overflows and splits on two pages/columns. Also, it is required that the text field expression has a numerical or date type set.

This flag is off by default to ensure backwards compatibility.


PROPERTY_DETECT_CELL_TYPE

public static final java.lang.String PROPERTY_DETECT_CELL_TYPE
Property whose value is used as default state of the IS_DETECT_CELL_TYPE export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

SHEET_NAMES

public static final JRXlsAbstractExporterParameter SHEET_NAMES
An array of strings representing custom sheet names. This is useful when used with the IS_ONE_PAGE_PER_SHEET parameter.


IS_FONT_SIZE_FIX_ENABLED

public static final JRXlsAbstractExporterParameter IS_FONT_SIZE_FIX_ENABLED
Flag for decreasing font size so that texts fit into the specified cell height.


PROPERTY_FONT_SIZE_FIX_ENABLED

public static final java.lang.String PROPERTY_FONT_SIZE_FIX_ENABLED
Property whose value is used as default state of the IS_FONT_SIZE_FIX_ENABLED export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

FORMAT_PATTERNS_MAP

public static final JRExporterParameter FORMAT_PATTERNS_MAP
This export parameter should be used when converting java format patterns to equivalent proprietary format patterns. It should be constructed as a Map containing java format patterns as keys and the correspondent proprietary format pattern as correspondent value

See Also:
HSSFDataFormat, jxl.write.NumberFormat

MAXIMUM_ROWS_PER_SHEET

public static final JRExporterParameter MAXIMUM_ROWS_PER_SHEET
An integer value specifying the maximum number of rows allowed to be shown in a sheet. When set, a new sheet is created for the remaining rows to be displayed. Negative values or zero means that no limit has been set.


PROPERTY_MAXIMUM_ROWS_PER_SHEET

public static final java.lang.String PROPERTY_MAXIMUM_ROWS_PER_SHEET
Property whose value is used as default of the MAXIMUM_ROWS_PER_SHEET export parameter.

This property is by default to zero.

See Also:
JRProperties, Constant Field Values

IS_IGNORE_GRAPHICS

public static final JRXlsAbstractExporterParameter IS_IGNORE_GRAPHICS
Flag for ignoring graphic elements and exporting text elements only.


PROPERTY_IGNORE_GRAPHICS

public static final java.lang.String PROPERTY_IGNORE_GRAPHICS
Property whose value is used as default state of the IS_IGNORE_GRAPHICS export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

IS_COLLAPSE_ROW_SPAN

public static final JRXlsAbstractExporterParameter IS_COLLAPSE_ROW_SPAN
Flag for collapsing row span and avoid merging cells across rows.


PROPERTY_COLLAPSE_ROW_SPAN

public static final java.lang.String PROPERTY_COLLAPSE_ROW_SPAN
Property whose value is used as default state of the IS_COLLAPSE_ROW_SPAN export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values

IS_IGNORE_CELL_BORDER

public static final JRXlsAbstractExporterParameter IS_IGNORE_CELL_BORDER
Flag for ignoring the cell border.


PROPERTY_IGNORE_CELL_BORDER

public static final java.lang.String PROPERTY_IGNORE_CELL_BORDER
Property whose value is used as default state of the IS_IGNORE_CELL_BORDER export flag.

This property is by default not set (false).

See Also:
JRProperties, Constant Field Values
Constructor Detail

JRXlsAbstractExporterParameter

protected JRXlsAbstractExporterParameter(java.lang.String name)


© 2001-2006 JasperSoft Corporation www.jaspersoft.com