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$
Author:
Sanda Zaharia (szaharia@users.sourceforge.net)

Field Summary
static JRXlsAbstractExporterParameter IS_AUTO_DETECT_CELL_TYPE
          Deprecated. The IS_DETECT_CELL_TYPE offers more consistent numerical cell detection.
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_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_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 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, FONT_MAP, 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, PROGRESS_MONITOR, 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


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.


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.


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.


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.

Constructor Detail

JRXlsAbstractExporterParameter

protected JRXlsAbstractExporterParameter(java.lang.String name)


© 2001-2006 JasperSoft Corporation www.jaspersoft.com