All Superinterfaces:

CommonExportConfiguration

All Known Subinterfaces:

CsvMetadataReportConfiguration, CsvReportConfiguration, DocxReportConfiguration, Graphics2DReportConfiguration, HtmlReportConfiguration, JsonMetadataReportConfiguration, JsonReportConfiguration, OdsReportConfiguration, OdtReportConfiguration, PdfReportConfiguration, PptxReportConfiguration, PrintServiceReportConfiguration, RtfReportConfiguration, TextReportConfiguration, XlsMetadataReportConfiguration, XlsReportConfiguration, XlsxMetadataReportConfiguration, XlsxReportConfiguration

All Known Implementing Classes:

AbstractXlsReportConfiguration, SimpleCsvMetadataReportConfiguration, SimpleCsvReportConfiguration, SimpleDocxReportConfiguration, SimpleGraphics2DReportConfiguration, SimpleHtmlReportConfiguration, SimpleJsonMetadataReportConfiguration, SimpleJsonReportConfiguration, SimpleOdsReportConfiguration, SimpleOdtReportConfiguration, SimplePdfReportConfiguration, SimplePptxReportConfiguration, SimplePrintServiceReportConfiguration, SimpleReportExportConfiguration, SimpleRtfReportConfiguration, SimpleTextReportConfiguration, SimpleXlsMetadataReportConfiguration, SimpleXlsReportConfiguration, SimpleXlsxMetadataReportConfiguration, SimpleXlsxReportConfiguration
```
public interface ReportExportConfiguration
extends CommonExportConfiguration
```
Instances of this class are used for configuring the behavior of exporters.
see Exporter.setConfiguration(ReportExportConfiguration) see ExporterInputItem.getConfiguration()

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`PROPERTY_IGNORE_PAGE_MARGINS`	This property serves as default value for the `XlsReportConfiguration.isIgnorePageMargins()` and `HtmlReportConfiguration.isIgnorePageMargins()` exporter configuration settings.

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Integer`	`getEndPageIndex()`	Returns an integer value representing the end index of the page range to be exported.
`ExporterFilter`	`getExporterFilter()`	Returns an instance of the `ExporterFilter` interface to be used by the exporter to filter the elements to be exported.
`JRHyperlinkProducerFactory`	`getHyperlinkProducerFactory()`	Returns a `JRHyperlinkProducerFactory` which should be used for custom hyperlink types during export.
`Integer`	`getOffsetX()`	A setting that allows users to move the entire content of each page horizontally.
`Integer`	`getOffsetY()`	A setting that allows users to move the entire content of each page vertically.
`Integer`	`getPageIndex()`	Returns an integer value representing the index of the page to be exported.
`JRExportProgressMonitor`	`getProgressMonitor()`	Return a `JRExportProgressMonitor` instance for monitoring export status.
`Integer`	`getStartPageIndex()`	Returns an integer value representing the start index of the page range to be exported.

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
isOverrideHints

- Field Detail
  - PROPERTY_IGNORE_PAGE_MARGINS
```
static final String PROPERTY_IGNORE_PAGE_MARGINS
```
    This property serves as default value for the XlsReportConfiguration.isIgnorePageMargins() and HtmlReportConfiguration.isIgnorePageMargins() exporter configuration settings.
    The property itself defaults to false.
    
    See Also:
    
    JRPropertiesUtil, Constant Field Values
- Method Detail
  - getStartPageIndex
```
Integer getStartPageIndex()
```
    Returns an integer value representing the start index of the page range to be exported. This is useful when only a range of pages is needed for export.
  - getEndPageIndex
```
Integer getEndPageIndex()
```
    Returns an integer value representing the end index of the page range to be exported. This is useful when only a range of pages is needed for export.
  - getPageIndex
```
Integer getPageIndex()
```
    Returns an integer value representing the index of the page to be exported. This is useful when only one page of the entire report is needed for export.
  - getProgressMonitor
```
JRExportProgressMonitor getProgressMonitor()
```
    Return a JRExportProgressMonitor instance for monitoring export status. This is useful for users who need to be notified after each page is exported (a GUI tool that shows a progress bar might need this feature).
  - getExporterFilter
```
ExporterFilter getExporterFilter()
```
    Returns an instance of the ExporterFilter interface to be used by the exporter to filter the elements to be exported.
  - getOffsetX
```
Integer getOffsetX()
```
    A setting that allows users to move the entire content of each page horizontally. It is mostly useful for printing, when the report data does not fit inside the page margins.
  - getOffsetY
```
Integer getOffsetY()
```
    A setting that allows users to move the entire content of each page vertically. It is mostly useful for printing, when the report data does not fit inside the page margins.
  - getHyperlinkProducerFactory
```
JRHyperlinkProducerFactory getHyperlinkProducerFactory()
```
    Returns a JRHyperlinkProducerFactory which should be used for custom hyperlink types during export.

Interface ReportExportConfiguration

Field Summary

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

Method Summary

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

Field Detail

PROPERTY_IGNORE_PAGE_MARGINS

Method Detail

getStartPageIndex

getEndPageIndex

getPageIndex

getProgressMonitor

getExporterFilter

getOffsetX

getOffsetY

getHyperlinkProducerFactory