Package net.sf.jasperreports.engine.export

Interface JRExporterContext

All Known Subinterfaces:

JRCsvExporterContext, JRDocxExporterContext, JRGraphics2DExporterContext, JRHtmlExporterContext, JROdsExporterContext, JROdtExporterContext, JRPdfExporterContext, JRPptxExporterContext, JRRtfExporterContext, JRTextExporterContext, JRXlsExporterContext, JRXlsxExporterContext, JRXmlExporterContext, JsonExporterContext

All Known Implementing Classes:

HtmlExporter.ExporterContext, JRAbstractExporter.BaseExporterContext, JRCsvExporter.ExporterContext, JRCsvMetadataExporter.ExporterContext, JRDocxExporter.ExporterContext, JRGraphics2DExporter.ExporterContext, JROdsExporter.ExporterContext, JROdtExporter.ExporterContext, JRPdfExporter.ExporterContext, JRPptxExporter.ExporterContext, JRPrintServiceExporter.ExporterContext, JRRtfExporter.ExporterContext, JRTextExporter.ExporterContext, JRXlsExporter.ExporterContext, JRXlsMetadataExporter.ExporterContext, JRXlsxExporter.ExporterContext, JRXmlExporter.ExporterContext, JsonExporter.ExporterContext, JsonMetadataExporter.ExporterContext

public interface JRExporterContext

A context that represents information about an export process.

Author:

Lucian Chirita ([email protected])

Method Summary

Modifier and Type	Method	Description
JasperPrint	getExportedReport()	Returns the report which is currently exported.
JRExporter	getExporter()	Deprecated. Replaced by getExporterRef().
Exporter	getExporterRef()	Returns the current exporter.
Map<JRExporterParameter,Object>	getExportParameters()	Deprecated. To be removed.
String	getExportPropertiesPrefix()	Deprecated. Replaced by JRAbstractExporter.getExporterPropertiesPrefix().
JasperReportsContext	getJasperReportsContext()
int	getOffsetX()	Returns the current X-axis offset at which elements should be exported.
int	getOffsetY()	Returns the current Y-axis offset at which elements should be exported.
default RepositoryUtil	getRepository()
Object	getValue(String key)
Map<String,Object>	getValues()
void	setValue(String key, Object value)

Method Detail

getExporter

JRExporter getExporter()

Deprecated.

Replaced by getExporterRef().

getExporterRef

Exporter getExporterRef()

Returns the current exporter.

Returns:

current exporter

getJasperReportsContext

JasperReportsContext getJasperReportsContext()

getRepository

default RepositoryUtil getRepository()

getExportedReport

JasperPrint getExportedReport()

Returns the report which is currently exported.

Returns:

currently exported report

getExportPropertiesPrefix

String getExportPropertiesPrefix()

Deprecated.

Replaced by JRAbstractExporter.getExporterPropertiesPrefix().

getExportParameters

Map<JRExporterParameter,Object> getExportParameters()

Deprecated.

To be removed.

Returns the map of export parameters.

The map uses JRExporterParameter instances as keys.

Returns:

the map of export parameters

getOffsetX

int getOffsetX()

Returns the current X-axis offset at which elements should be exported.

Returns:

the current X-axis offset

getOffsetY

int getOffsetY()

Returns the current Y-axis offset at which elements should be exported.

Returns:

the current Y-axis offset

getValue

Object getValue(String key)

setValue

void setValue(String key,
              Object value)

getValues

Map<String,Object> getValues()