|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRExporter
All document exporting in JasperReports is done through this interface. There is an implementation of this interface for every document format that JasperReports supports at the moment.
Export customization is realized by using export parameters. Each exporter is able to recognize and use
its own parameters, but there is a subset of predefined parameters that are common to all exporters.
Those are identified by constants in the JRExporterParameter
base class. All parameters are documented
inside the classes where they are defined.
An important aspect is the output type of each exporter. There are three types of exporters depending on the type of output they produce:
All existing exporters fall into two categories depending on the way the content of the documents they produce could be structured:
Method Summary | |
---|---|
void |
exportReport()
Actually starts the export process. |
java.lang.Object |
getParameter(JRExporterParameter parameter)
Gets an export parameter. |
java.util.Map<JRExporterParameter,java.lang.Object> |
getParameters()
Gets a map containing all export parameters. |
ReportContext |
getReportContext()
|
void |
setParameter(JRExporterParameter parameter,
java.lang.Object value)
Sets an export parameter for advanced customization of the export process. |
void |
setParameters(java.util.Map<JRExporterParameter,java.lang.Object> parameters)
Sets export parameters from a specified map. |
void |
setReportContext(ReportContext reportContext)
|
Method Detail |
---|
void setParameter(JRExporterParameter parameter, java.lang.Object value)
parameter
- the parameter, selected from the static parameters defined by JasperReportsvalue
- the parameter valueJRExporterParameter
java.lang.Object getParameter(JRExporterParameter parameter)
void setParameters(java.util.Map<JRExporterParameter,java.lang.Object> parameters)
setParameter(JRExporterParameter, Object)
java.util.Map<JRExporterParameter,java.lang.Object> getParameters()
void setReportContext(ReportContext reportContext)
ReportContext getReportContext()
void exportReport() throws JRException
JRException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |