KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > export > JRXlsAbstractExporterParameter


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * JasperSoft Corporation
24  * 303 Second Street, Suite 450 North
25  * San Francisco, CA 94107
26  * http://www.jaspersoft.com
27  */
28 package net.sf.jasperreports.engine.export;
29
30 import net.sf.jasperreports.engine.JRExporterParameter;
31
32
33 /**
34  * Contains parameters useful for export in XLS format.
35  * <p>
36  * The XLS exporter can send data to an output stream or file on disk. The engine looks among the export parameters in
37  * order to find the selected output type in this order: OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.
38  *
39  * @author Sanda Zaharia (szaharia@users.sourceforge.net)
40  * @version $Id$
41  */
42 public class JRXlsAbstractExporterParameter extends JRExporterParameter
43 {
44
45
46     /**
47      *
48      */
49     protected JRXlsAbstractExporterParameter(String JavaDoc name)
50     {
51         super(name);
52     }
53
54
55     /**
56      * A boolean value specifying whether each report page should be written in a different XLS sheet
57      */
58     public static final JRXlsAbstractExporterParameter IS_ONE_PAGE_PER_SHEET = new JRXlsAbstractExporterParameter("Is One Page per Sheet");
59
60
61     /**
62      * A boolean value specifying whether the empty spaces that could appear between rows should be removed or not.
63      */
64     public static final JRXlsAbstractExporterParameter IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS = new JRXlsAbstractExporterParameter("Is Remove Empty Space Between Rows");
65
66
67     /**
68      * A boolean value specifying whether the page background should be white or the default XLS background color. This background
69      * may vary depending on the XLS viewer properties or the operating system color scheme.
70      */
71     public static final JRXlsAbstractExporterParameter IS_WHITE_PAGE_BACKGROUND = new JRXlsAbstractExporterParameter("Is White Page Background");
72
73
74     /**
75      * A boolean value specifying whether the exporter should try to automatically detect cell types based on the cell value.
76      *
77      * @deprecated The {@link #IS_DETECT_CELL_TYPE IS_DETECT_CELL_TYPE} offers more consistent numerical cell detection.
78      */
79     public static final JRXlsAbstractExporterParameter IS_AUTO_DETECT_CELL_TYPE = new JRXlsAbstractExporterParameter("Is Auto Detect Cell Type");
80     
81     
82     /**
83      * Flag used to indicate whether the exporter should take into consideration the type of the
84      * original text field expressions and set the cell types and values accordingly.
85      * <p>
86      * Text fields having numerical or date expressions save type and formatting (format pattern, locale and time zone)
87      * information in the {@link net.sf.jasperreports.engine.JasperPrint JasperPrint}/{@link net.sf.jasperreports.engine.JRPrintText JRPrintText}
88      * object created by the report fill process.
89      * </p>
90      * <p>
91      * When this flag is set, the exporter will parse back the <code>String</code> value of numerical/date texts.
92      * Numerical/date cells will be created and the original pattern of the text will be included
93      * as part of the cell style.
94      * </p>
95      * <p>
96      * Note that this mechanism would not work when the text field overflows and splits on two pages/columns.
97      * Also, it is required that the text field expression has a numerical or date type set.
98      * </p>
99      * <p>
100      * This flag is off by default to ensure backwards compatibility.
101      * </p>
102      */
103     public static final JRXlsAbstractExporterParameter IS_DETECT_CELL_TYPE = new JRXlsAbstractExporterParameter("Is Detect Cell Type");
104
105
106     /**
107      * An array of strings representing custom sheet names. This is useful when used with the <i>IS_ONE_PAGE_PER_SHEET</i>
108      * parameter.
109      */
110     public static final JRXlsAbstractExporterParameter SHEET_NAMES = new JRXlsAbstractExporterParameter("Sheet Names");
111
112
113     /**
114      * Flag for decreasing font size so that texts fit into the specified cell height.
115      */
116     public static final JRXlsAbstractExporterParameter IS_FONT_SIZE_FIX_ENABLED = new JRXlsAbstractExporterParameter("Is Font Size Fix Enabled");
117     
118 }
119
Popular Tags