Java Doc for JRExporterParameter.java in » Report » jasperreports-2.0.1 » net » sf » jasperreports » engine » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Report » jasperreports 2.0.1 » net.sf.jasperreports.engine

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

net.sf.jasperreports.engine .JRExporterParameter

All known Subclasses:   net.sf.jasperreports.engine.export .JRCsvExporterParameter,  net.sf.jasperreports.engine.export .JRHtmlExporterParameter,  net.sf.jasperreports.engine.export .JRXmlExporterParameter,  net.sf.jasperreports.engine.export .JRTextExporterParameter,  net.sf.jasperreports.engine.export .JRGraphics2DExporterParameter,  net.sf.jasperreports.engine.export .JRPdfExporterParameter,  net.sf.jasperreports.engine.export .JRXlsAbstractExporterParameter,  net.sf.jasperreports.engine.export .JRPrintServiceExporterParameter,
JRExporterParameter
public class JRExporterParameter (Code)
Instances of this class are used for defining and setting exporter parameters.
The JasperPrint object needed for the export can be specified in many ways: an instance of JasperPrint, an input stream, a file on disk, or an URL. The export engine will search for this object through parameters in the following order: JASPER_PRINT_LIST, JASPER_PRINT, INPUT_STREAM, INPUT_URL, INPUT_FILE, INPUT_FILE_NAME.
The output type of the export process can also vary: a string buffer, an output stream / writer of a file on disk. The order of parameters used by JasperReports when looking for the output depends on the final document format and is explained in detail for each format (see documentation for the children of this class).
JasperReports allows users to export only a page range from the entire report or even a single page. The engine first searches for the PAGE_INDEX parameter. If this is not present, it looks for the START_PAGE_INDEX and END_PAGE_INDEX parameters. The engine will try to narrow the page range (which is initially the entire report) by using these two parameters, if present.
author:
   Teodor Danciu (teodord@users.sourceforge.net)
version:
   $Id: JRExporterParameter.java 1824 2007-08-23 14:19:12Z teodord $

Field Summary
final public static JRExporterParameter CHARACTER_ENCODING
     The character encoding used for export.
final public static JRExporterParameter CLASS_LOADER

final public static JRExporterParameter END_PAGE_INDEX
     An integer value representing the end index of the page range to be exported.
final public static JRExporterParameter FONT_MAP

final public static JRExporterParameter HYPERLINK_PRODUCER_FACTORY
     A JRHyperlinkProducerFactory JRHyperlinkProducerFactory which should be used for custom hyperlink types during export.
final public static JRExporterParameter INPUT_FILE
     A java.io.File pointing to a file representing the serialized form of the JasperPrint object.
final public static JRExporterParameter INPUT_FILE_NAME
     A file representing the serialized form of the JasperPrint object.
final public static JRExporterParameter INPUT_STREAM
     The input stream that the exported JasperPrint object will be read from.
final public static JRExporterParameter INPUT_URL
     The URL that the JasperPrint object will be read from.
final public static JRExporterParameter JASPER_PRINT
     The JasperPrint object that will be exported.
final public static JRExporterParameter JASPER_PRINT_LIST
     A list of JasperPrint objects to be exported.
final public static JRExporterParameter OFFSET_X
     A parameter that allows users to move the entire content of each page horizontally.
final public static JRExporterParameter OFFSET_Y
     A parameter that allows users to move the entire content of each page vertically.
final public static JRExporterParameter OUTPUT_FILE
     The java.io.File instance that will be used to specify the file name of the exported report.
final public static JRExporterParameter OUTPUT_FILE_NAME
     The file name of the exported report.
final public static JRExporterParameter OUTPUT_STREAM
     The java.io.OutputStream instance that will be used to send the export output to.
final public static JRExporterParameter OUTPUT_STRING_BUFFER
     The string buffer to send the export output to.
final public static JRExporterParameter OUTPUT_WRITER
     The java.io.Writer instance that will be used to send the export output to.
final public static JRExporterParameter PAGE_INDEX
     An integer value representing the index of the page to be exported.
final public static JRExporterParameter PROGRESS_MONITOR
     A JRExportProgressMonitor instance for monitoring export status.
final public static String PROPERTY_CHARACTER_ENCODING
     Property whose value is used as default for the JRExporterParameter.CHARACTER_ENCODING CHARACTER_ENCODING export parameter.
final public static JRExporterParameter START_PAGE_INDEX
     An integer value representing the start index of the page range to be exported.
final public static JRExporterParameter URL_HANDLER_FACTORY
     URL stream handler factory to be used while exporting the report.

Constructor Summary
protected JRExporterParameter(String name)


Method Summary
public String toString()


Field Detail
CHARACTER_ENCODING
final public static JRExporterParameter CHARACTER_ENCODING(Code)
The character encoding used for export.

CLASS_LOADER
final public static JRExporterParameter CLASS_LOADER(Code)

END_PAGE_INDEX
final public static JRExporterParameter END_PAGE_INDEX(Code)
An integer value representing the end index of the page range to be exported. This is useful when only a range of pages is needed for export.

FONT_MAP
final public static JRExporterParameter FONT_MAP(Code)

HYPERLINK_PRODUCER_FACTORY
final public static JRExporterParameter HYPERLINK_PRODUCER_FACTORY(Code)
A JRHyperlinkProducerFactory JRHyperlinkProducerFactory which should be used for custom hyperlink types during export.

INPUT_FILE
final public static JRExporterParameter INPUT_FILE(Code)
A java.io.File pointing to a file representing the serialized form of the JasperPrint object. This is useful if the JasperPrint object is representing a file on disk.

INPUT_FILE_NAME
final public static JRExporterParameter INPUT_FILE_NAME(Code)
A file representing the serialized form of the JasperPrint object. You can use this parameter to specify a file name where the object can be found.

INPUT_STREAM
final public static JRExporterParameter INPUT_STREAM(Code)
The input stream that the exported JasperPrint object will be read from. If you want to read the JasperPrint object from an input stream (like a web location), you can pass the stream to this parameter.

INPUT_URL
final public static JRExporterParameter INPUT_URL(Code)
The URL that the JasperPrint object will be read from. If the JasperPrint object is available as a web resource, you can use this parameter, instead of opening a HTTP connection and read from the input stream.

JASPER_PRINT
final public static JRExporterParameter JASPER_PRINT(Code)
The JasperPrint object that will be exported. If you already have a JasperPrint object, you can pass it to the export engine.

JASPER_PRINT_LIST
final public static JRExporterParameter JASPER_PRINT_LIST(Code)
A list of JasperPrint objects to be exported. If you need to concatenate several reports into the same document, you can use this feature.

OFFSET_X
final public static JRExporterParameter OFFSET_X(Code)
A parameter that allows users to move the entire content of each page horizontally. It is mostly useful for printing, when the report data does not fit inside the page margins.

OFFSET_Y
final public static JRExporterParameter OFFSET_Y(Code)
A parameter that allows users to move the entire content of each page vertically. It is mostly useful for printing, when the report data does not fit inside the page margins.

OUTPUT_FILE
final public static JRExporterParameter OUTPUT_FILE(Code)
The java.io.File instance that will be used to specify the file name of the exported report. This is useful when exporting to a file and the File instance is already there.

OUTPUT_FILE_NAME
final public static JRExporterParameter OUTPUT_FILE_NAME(Code)
The file name of the exported report. This is an alternative to the OUTPUT_FILE parameter.

OUTPUT_STREAM
final public static JRExporterParameter OUTPUT_STREAM(Code)
The java.io.OutputStream instance that will be used to send the export output to. This is useful for sending the export result to an output stream, such as a ServletOutputStream.

OUTPUT_STRING_BUFFER
final public static JRExporterParameter OUTPUT_STRING_BUFFER(Code)
The string buffer to send the export output to. Useful for just storing the result in a string for later use.

OUTPUT_WRITER
final public static JRExporterParameter OUTPUT_WRITER(Code)
The java.io.Writer instance that will be used to send the export output to. This is useful for sending the export result to a character stream, such as the PrintWriter of a servlet.

PAGE_INDEX
final public static JRExporterParameter PAGE_INDEX(Code)
An integer value representing the index of the page to be exported. This is useful when only one page of the entire report is needed for export.

PROGRESS_MONITOR
final public static JRExporterParameter PROGRESS_MONITOR(Code)
A JRExportProgressMonitor instance for monitoring export status. This is useful for users who need to be notified after each page is exported (a GUI tool that shows a progress bar might need this feature).

PROPERTY_CHARACTER_ENCODING
final public static String PROPERTY_CHARACTER_ENCODING(Code)
Property whose value is used as default for the JRExporterParameter.CHARACTER_ENCODING CHARACTER_ENCODING export parameter.
See Also:   JRProperties

START_PAGE_INDEX
final public static JRExporterParameter START_PAGE_INDEX(Code)
An integer value representing the start index of the page range to be exported. This is useful when only a range of pages is needed for export.

URL_HANDLER_FACTORY
final public static JRExporterParameter URL_HANDLER_FACTORY(Code)
URL stream handler factory to be used while exporting the report.
The values should be of type java.net.URLStreamHandlerFactory java.net.URLStreamHandlerFactory .
See Also:   net.sf.jasperreports.engine.util.JRResourcesUtil.createURL(Stringjava.net.URLStreamHandlerFactory)

Constructor Detail
JRExporterParameter
protected JRExporterParameter(String name)(Code)

Method Detail
toString
public String toString()(Code)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.