net.sf.jasperreports.engine.export

Interface JRExporterContext

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface JRExporterContext

A context that represents information about an export process.

Version:

$Id: JRExporterContext.java 7199 2014-08-27 13:58:10Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Method Summary

Methods

Modifier and Type	Method and 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.
Object	getValue(String key)
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()

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)