Package net.sf.jasperreports.engine.export

Interface JRExporterContext

All Known Subinterfaces:
JRCsvExporterContext, JRDocxExporterContext, JRGraphics2DExporterContext, JRHtmlExporterContext, JROdsExporterContext, JROdtExporterContext, JRPptxExporterContext, JRRtfExporterContext, JRTextExporterContext, JRXlsExporterContext, JRXlsxExporterContext, JRXmlExporterContext, JsonExporterContext
All Known Implementing Classes:
AbstractMetadataExporter.ExporterContext, HtmlExporter.ExporterContext, JRAbstractExporter.BaseExporterContext, JRCsvExporter.ExporterContext, JRCsvMetadataExporter.ExporterContext, JRDocxExporter.ExporterContext, JRGraphics2DExporter.ExporterContext, JROdsExporter.ExporterContext, JROdtExporter.ExporterContext, JRPptxExporter.ExporterContext, JRPrintServiceExporter.ExporterContext, JRRtfExporter.ExporterContext, JRTextExporter.ExporterContext, JRXlsExporter.ExporterContext, JRXlsMetadataExporter.ExporterContext, JRXlsxExporter.ExporterContext, JRXmlExporter.ExporterContext, JsonExporter.ExporterContext, XlsxMetadataExporter.ExporterContext
public interface JRExporterContext
A context that represents information about an export process.
Author:
Lucian Chirita (lucianc@users.sourceforge.net)

  • Method Details

    • 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

    • getCurrentPageFormat

      default PrintPageFormat getCurrentPageFormat()
      Returns the page format of the page which is currently exported.

      In documents made of parts, pages can have a page format that differs from the page format of the document, including the resolution at which they were filled. Exporters that iterate the pages of such documents return here the format of the page being exported, so that element handlers can rely on it instead of on the document level values available from getExportedReport().

      Returns:
      the page format of the page currently exported

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