KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Contains parameters useful for export in plain text format.
34  * <p>
35  * The text exporter can send data to a string buffer, output stream, character stream or file on disk. The engine looks
36  * among the export parameters in order to find the selected output type in this order: OUTPUT_STRING_BUFFER, OUTPUT_WRITER,
37  * OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.
38  *
39  * @author Ionut Nedelcu (ionutned@users.sourceforge.net)
40  * @version $Id: JRTextExporterParameter.java 1413 2006-09-28 13:47:40 +0300 (Thu, 28 Sep 2006) teodord $
41  */
42 public class JRTextExporterParameter extends JRExporterParameter
43 {
44     /**
45      *
46      */
47     public JRTextExporterParameter(String JavaDoc name)
48     {
49         super(name);
50     }
51
52
53     /**
54      * An integer representing the pixel/character horizontal ratio.
55      */
56     public static final JRTextExporterParameter CHARACTER_WIDTH = new JRTextExporterParameter("Character Width");
57
58
59     /**
60      * An integer representing the pixel/character horizontal ratio.
61      */
62     public static final JRTextExporterParameter CHARACTER_HEIGHT = new JRTextExporterParameter("Character Height");
63
64
65     /**
66      * An integer representing the page width in characters.
67      */
68     public static final JRTextExporterParameter PAGE_WIDTH = new JRTextExporterParameter("Page Width");
69
70
71     /**
72      * An integer representing the page height in characters.
73      */
74     public static final JRTextExporterParameter PAGE_HEIGHT = new JRTextExporterParameter("Page Height");
75
76
77     /**
78      * A string representing text that will be inserted between pages of the generated report. By default, JasperReports
79      * separates pages by two empty lines, but this behaviour can be overriden by this parameter.
80      */
81     public static final JRTextExporterParameter BETWEEN_PAGES_TEXT = new JRTextExporterParameter("Between Pages Text");
82
83
84     /**
85      * A string representing the separator between two lines of text. This parameter is useful since line separators can
86      * vary from one operating system to another. The default value is "\n".
87      */
88     public static final JRTextExporterParameter LINE_SEPARATOR = new JRTextExporterParameter("Line Separator");
89
90 }
91
Popular Tags