01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * 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 1590 2007-02-21 14:03:40Z teodord $
41: */
42: public class JRTextExporterParameter extends JRExporterParameter {
43: /**
44: *
45: */
46: public JRTextExporterParameter(String name) {
47: super (name);
48: }
49:
50: /**
51: * An integer representing the pixel/character horizontal ratio.
52: */
53: public static final JRTextExporterParameter CHARACTER_WIDTH = new JRTextExporterParameter(
54: "Character Width");
55:
56: /**
57: * An integer representing the pixel/character horizontal ratio.
58: */
59: public static final JRTextExporterParameter CHARACTER_HEIGHT = new JRTextExporterParameter(
60: "Character Height");
61:
62: /**
63: * An integer representing the page width in characters.
64: */
65: public static final JRTextExporterParameter PAGE_WIDTH = new JRTextExporterParameter(
66: "Page Width");
67:
68: /**
69: * An integer representing the page height in characters.
70: */
71: public static final JRTextExporterParameter PAGE_HEIGHT = new JRTextExporterParameter(
72: "Page Height");
73:
74: /**
75: * A string representing text that will be inserted between pages of the generated report. By default, JasperReports
76: * separates pages by two empty lines, but this behaviour can be overriden by this parameter.
77: */
78: public static final JRTextExporterParameter BETWEEN_PAGES_TEXT = new JRTextExporterParameter(
79: "Between Pages Text");
80:
81: /**
82: * A string representing the separator between two lines of text. This parameter is useful since line separators can
83: * vary from one operating system to another. The default value is the system "line.separator" property.
84: */
85: public static final JRTextExporterParameter LINE_SEPARATOR = new JRTextExporterParameter(
86: "Line Separator");
87:
88: }
|