net.sf.jasperreports.engine.export
Interface JRExporterContext

All Known Subinterfaces:

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

All Known Implementing Classes:

JExcelApiExporter.ExporterContext, JExcelApiMetadataExporter.ExporterContext, JRAbstractExporter.BaseExporterContext, JRDocxExporter.ExporterContext, JRGraphics2DExporter.ExporterContext, JRHtmlExporter.ExporterContext, JROdsExporter.ExporterContext, JROdtExporter.ExporterContext, JRPdfExporter.ExporterContext, JRPptxExporter.ExporterContext, JRRtfExporter.ExporterContext, JRXhtmlExporter.ExporterContext, JRXlsExporter.ExporterContext, JRXlsxExporter.ExporterContext, JRXmlExporter.ExporterContext

public interface JRExporterContext

A context that represents information about an export process.

Version:

$Id: JRExporterContext.java 5050 2012-03-12 10:11:26Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Method Summary

JasperPrint	getExportedReport() Returns the report which is currently exported.
JRExporter	getExporter() Returns the current exporter.
Map<JRExporterParameter,Object>	getExportParameters() Returns the map of export parameters.
String	getExportPropertiesPrefix() Returns the properties prefix for the current exporter.
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.

Method Detail

getExporter

JRExporter getExporter()

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()

Returns the properties prefix for the current exporter.

Returns:

the properties prefix for the current exporter

getExportParameters

Map<JRExporterParameter,Object> getExportParameters()

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