|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.JRExporterParameter
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.
Field Summary | |
static JRExporterParameter |
CHARACTER_ENCODING
The character encoding used for export. |
static JRExporterParameter |
CLASS_LOADER
|
static JRExporterParameter |
END_PAGE_INDEX
An integer value representing the end index of the page range to be exported. |
static JRExporterParameter |
FONT_MAP
|
static JRExporterParameter |
INPUT_FILE
A java.io.File pointing to a file representing the serialized form of the JasperPrint object. |
static JRExporterParameter |
INPUT_FILE_NAME
A file representing the serialized form of the JasperPrint object. |
static JRExporterParameter |
INPUT_STREAM
The input stream that the exported JasperPrint object will be read from. |
static JRExporterParameter |
INPUT_URL
The URL that the JasperPrint object will be read from. |
static JRExporterParameter |
JASPER_PRINT
The JasperPrint object that will be exported. |
static JRExporterParameter |
JASPER_PRINT_LIST
A list of JasperPrint objects to be exported. |
static JRExporterParameter |
OFFSET_X
A parameter that allows users to move the entire content of each page horizontally. |
static JRExporterParameter |
OFFSET_Y
A parameter that allows users to move the entire content of each page vertically. |
static JRExporterParameter |
OUTPUT_FILE
The java.io.File instance that will be used to specify the file name of the exported report. |
static JRExporterParameter |
OUTPUT_FILE_NAME
The file name of the exported report. |
static JRExporterParameter |
OUTPUT_STREAM
The java.io.OutputStream instance that will be used to send the export output to. |
static JRExporterParameter |
OUTPUT_STRING_BUFFER
The string buffer to send the export output to. |
static JRExporterParameter |
OUTPUT_WRITER
The java.io.Writer instance that will be used to send the export output to. |
static JRExporterParameter |
PAGE_INDEX
An integer value representing the index of the page to be exported. |
static JRExporterParameter |
PROGRESS_MONITOR
A JRExportProgressMonitor instance for monitoring export status. |
static JRExporterParameter |
START_PAGE_INDEX
An integer value representing the start index of the page range to be exported. |
Constructor Summary | |
protected |
JRExporterParameter(java.lang.String name)
|
Method Summary | |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final JRExporterParameter JASPER_PRINT
JasperPrint
object that will be exported. If you already have a JasperPrint object, you can pass it
to the export engine.
public static final JRExporterParameter JASPER_PRINT_LIST
JasperPrint
objects to be exported. If you need to concatenate several reports into the same
document, you can use this feature.
public static final JRExporterParameter INPUT_STREAM
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.
public static final JRExporterParameter INPUT_URL
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.
public static final JRExporterParameter INPUT_FILE
JasperPrint
object. This is
useful if the JasperPrint object is representing a file on disk.
public static final JRExporterParameter INPUT_FILE_NAME
JasperPrint
object. You can use this parameter to specify a file
name where the object can be found.
public static final JRExporterParameter OUTPUT_STRING_BUFFER
public static final JRExporterParameter OUTPUT_WRITER
public static final JRExporterParameter OUTPUT_STREAM
public static final JRExporterParameter OUTPUT_FILE
public static final JRExporterParameter OUTPUT_FILE_NAME
public static final JRExporterParameter PAGE_INDEX
public static final JRExporterParameter START_PAGE_INDEX
public static final JRExporterParameter END_PAGE_INDEX
public static final JRExporterParameter CHARACTER_ENCODING
public static final JRExporterParameter PROGRESS_MONITOR
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).
public static final JRExporterParameter OFFSET_X
public static final JRExporterParameter OFFSET_Y
public static final JRExporterParameter FONT_MAP
public static final JRExporterParameter CLASS_LOADER
Constructor Detail |
protected JRExporterParameter(java.lang.String name)
Method Detail |
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |