Package | Description |
---|---|
net.sf.jasperreports.engine.export |
Provides utility classes for exporting reports to various popular formats such as
PDF, HTML, RTF, CSV, Excel, DOCX, PPTX, ODT, ODS, XML, Text, etc.
|
net.sf.jasperreports.export |
Provides exporter input, exporter output and exporter configurations
|
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
JRHtmlReportConfiguration.isFramesAsNestedTables()
Deprecated.
Indicates whether
frames are to be exported as nested HTML tables. |
java.lang.Boolean |
JRHtmlExporterConfiguration.isUsingImagesToAlign()
Deprecated.
Returns a boolean value specifying whether the export engine should use small images for aligning.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
HtmlExporterConfiguration.getBetweenPagesHtml()
Returns a string representing HTML code that will be inserted between pages of the generated report.
|
java.lang.Float |
TextReportConfiguration.getCharHeight()
Returns a float value representing the pixel/character vertical ratio.
|
java.lang.Float |
TextReportConfiguration.getCharWidth()
Returns a float value representing the pixel/character horizontal ratio.
|
java.lang.String[] |
XlsMetadataReportConfiguration.getColumnNames()
Returns an array of strings representing the comma-separated names of the columns that should be exported.
|
java.lang.String[] |
CsvMetadataReportConfiguration.getColumnNames()
Returns an array of strings representing the comma-separated names of the columns that should be exported.
|
java.lang.Integer |
ReportExportConfiguration.getEndPageIndex()
Returns an integer value representing the end index of the page range to be exported.
|
ExporterFilter |
ReportExportConfiguration.getExporterFilter()
Returns an instance of the
ExporterFilter interface to be used by the exporter
to filter the elements to be exported. |
java.lang.String |
CsvExporterConfiguration.getFieldDelimiter()
Returns the string representing the character or sequence of characters to be used to delimit two fields on the same record.
|
java.util.Map<java.lang.String,java.lang.String> |
XlsReportConfiguration.getFormatPatternsMap()
This export configuration setting should be used when converting java format patterns to equivalent proprietary
format patterns.
|
java.lang.String |
HtmlExporterConfiguration.getHtmlFooter()
Returns a string representing HTML code that will be inserted after the generated report.
|
java.lang.String |
HtmlExporterConfiguration.getHtmlHeader()
Returns a string representing HTML code that will be inserted in front of the generated report.
|
JRHyperlinkProducerFactory |
ReportExportConfiguration.getHyperlinkProducerFactory()
Returns a
JRHyperlinkProducerFactory which should be used for custom
hyperlink types during export. |
java.lang.String |
PdfExporterConfiguration.getIccProfilePath()
The path to the ICC profile file for the PDF/A compliant document.
|
java.lang.String |
TextExporterConfiguration.getLineSeparator()
Returns a string representing the separator between two lines of text.
|
java.lang.Integer |
XlsReportConfiguration.getMaxRowsPerSheet()
Returns an integer value specifying the maximum number of rows allowed to be shown in a sheet.
|
java.lang.String |
PdfExporterConfiguration.getMetadataAuthor()
The Author of the PDF document.
|
java.lang.String |
PdfExporterConfiguration.getMetadataCreator()
The Creator or Application for the PDF document.
|
java.lang.String |
PdfExporterConfiguration.getMetadataKeywords()
The Keywords of the PDF document, as comma-separated String.
|
java.lang.String |
PdfExporterConfiguration.getMetadataSubject()
The Subject of the PDF document.
|
java.lang.String |
PdfExporterConfiguration.getMetadataTitle()
The Title of the PDF document.
|
java.lang.Integer |
ReportExportConfiguration.getOffsetX()
A setting that allows users to move the entire content of each page horizontally.
|
java.lang.Integer |
ReportExportConfiguration.getOffsetY()
A setting that allows users to move the entire content of each page vertically.
|
java.lang.String |
PdfExporterConfiguration.getOwnerPassword()
The password belonging to the owner of the document, if it is encrypted.
|
java.lang.Integer |
TextReportConfiguration.getPageHeightInChars()
Returns an integer representing the page height in characters.
|
java.lang.Integer |
ReportExportConfiguration.getPageIndex()
Returns an integer value representing the index of the page to be exported.
|
java.lang.String |
TextExporterConfiguration.getPageSeparator()
Returns a string representing text that will be inserted between pages of the generated report.
|
java.lang.Integer |
TextReportConfiguration.getPageWidthInChars()
Returns an integer representing the page width in characters.
|
java.lang.String |
XlsReportConfiguration.getPassword()
Returns a String value representing the password in case of password protected documents.
|
PdfaConformanceEnum |
PdfExporterConfiguration.getPdfaConformance()
The Conformance level of the PDF/A document.
|
java.lang.String |
PdfExporterConfiguration.getPdfJavaScript()
The user defined JavaScript piece of code to be inserted in the generated PDF document.
|
PdfVersionEnum |
PdfExporterConfiguration.getPdfVersion()
Returns a Character instance representing the version of the generated PDF.
|
java.lang.Integer |
PdfExporterConfiguration.getPermissions()
An integer value representing the PDF permissions for the generated document.
|
javax.print.attribute.PrintRequestAttributeSet |
PrintServiceExporterConfiguration.getPrintRequestAttributeSet()
Returns an instance of javax.print.attribute.PrintRequestAttributeSet.
|
PdfPrintScalingEnum |
PdfExporterConfiguration.getPrintScaling()
Setting specifying the print scaling preference in the PDF print dialog.
|
javax.print.PrintService |
PrintServiceExporterConfiguration.getPrintService()
Returns an instance of javax.print.PrintService, useful if users do not want JPS to lookup for an available print service.
|
javax.print.attribute.PrintServiceAttributeSet |
PrintServiceExporterConfiguration.getPrintServiceAttributeSet()
Returns an instance of javax.print.attribute.PrintServiceAttributeSet.
|
JRExportProgressMonitor |
ReportExportConfiguration.getProgressMonitor()
Return a
JRExportProgressMonitor instance for monitoring export status. |
java.lang.String |
CsvExporterConfiguration.getRecordDelimiter()
Returns the string representing the character or sequence of characters to be used to delimit two records.
|
java.lang.String[] |
XlsReportConfiguration.getSheetNames()
Returns an array of strings representing custom sheet names.
|
HtmlSizeUnitEnum |
HtmlReportConfiguration.getSizeUnit()
Returns a String value specifying the unit to use when measuring lengths or font size.
|
java.lang.Integer |
ReportExportConfiguration.getStartPageIndex()
Returns an integer value representing the start index of the page range to be exported.
|
java.lang.String |
PdfExporterConfiguration.getTagLanguage()
Specifies the language that the exporter should put in the language tag of the generated PDF.
|
java.lang.String |
PdfExporterConfiguration.getUserPassword()
The user password needed to open the document, if it is encrypted.
|
java.lang.Float |
HtmlReportConfiguration.getZoomRatio()
The zoom ratio used for the export.
|
java.lang.Float |
Graphics2DReportConfiguration.getZoomRatio()
The zoom ratio used for the export.
|
java.lang.Boolean |
PdfExporterConfiguration.is128BitKey()
Returns a boolean value specifying whether the encryption key is 128 bits.
|
java.lang.Boolean |
XlsReportConfiguration.isCollapseRowSpan()
Flag for collapsing row span and avoid merging cells across rows.
|
java.lang.Boolean |
PdfExporterConfiguration.isCompressed()
Returns a boolean value specifying whether the PDF document should be compressed.
|
java.lang.Boolean |
XlsExporterConfiguration.isCreateCustomPalette()
Returns a boolean value specifying whether the standard color palette should be customized
so that the XLS result uses the original report colors.
|
java.lang.Boolean |
PdfExporterConfiguration.isCreatingBatchModeBookmarks()
Returns a boolean value specifying whether the PDF document should contain an outline section.
|
java.lang.Boolean |
XlsReportConfiguration.isDetectCellType()
Flag used to indicate whether the exporter should take into consideration the type of the
original text field expressions and set the cell types and values accordingly.
|
java.lang.Boolean |
PrintServiceExporterConfiguration.isDisplayPageDialog()
Returns a boolean value specifying whether a page setup dialog should be opened before printing.
|
java.lang.Boolean |
PrintServiceExporterConfiguration.isDisplayPageDialogOnlyOnce()
Returns a boolean value specifying whether a page setup dialog should be opened only once before printing in a batch export job.
|
java.lang.Boolean |
PrintServiceExporterConfiguration.isDisplayPrintDialog()
Returns a boolean value specifying whether a print setup dialog should be opened before printing.
|
java.lang.Boolean |
PrintServiceExporterConfiguration.isDisplayPrintDialogOnlyOnce()
Returns a boolean value specifying whether a print setup dialog should be opened only once in a batch export job.
|
java.lang.Boolean |
PdfExporterConfiguration.isEncrypted()
Returns a boolean value specifying whether the final PDF document should be encrypted.
|
java.lang.Boolean |
DocxReportConfiguration.isFlexibleRowHeight()
Indicates whether table rows can grow if more text is added into cells.
|
java.lang.Boolean |
OdtReportConfiguration.isFlexibleRowHeight()
Indicates whether table rows in ODT documents can grow if more text is added into cells.
|
java.lang.Boolean |
OdsReportConfiguration.isFlexibleRowHeight()
Indicates whether table rows in ODS documents can grow if more text is added into cells.
|
java.lang.Boolean |
HtmlExporterConfiguration.isFlushOutput()
A flag that determines whether the HTML exporter should flush the
output stream after writing the HTML content to it.
|
java.lang.Boolean |
JsonExporterConfiguration.isFlushOutput()
A flag that determines whether the JSON exporter should flush the
output stream after writing the JSON content to it.
|
java.lang.Boolean |
XlsReportConfiguration.isFontSizeFixEnabled()
Flag for decreasing font size so that texts fit into the specified cell height.
|
java.lang.Boolean |
PdfReportConfiguration.isForceLineBreakPolicy()
Flag that decides whether the PDF exporter should use a
SplitCharacter
implementation which ensures that report texts are broken into lines by iText in the same manner as done by the
fill process. |
java.lang.Boolean |
PdfReportConfiguration.isForceSvgShapes()
Flag to force the rendering of SVG images using shapes, on the PDF Graphics2D context.
|
java.lang.Boolean |
DocxReportConfiguration.isFramesAsNestedTables()
Indicates whether
frames are to be exported as nested tables. |
java.lang.Boolean |
XlsReportConfiguration.isIgnoreCellBackground()
Flag for ignoring the cell background color.
|
java.lang.Boolean |
XlsReportConfiguration.isIgnoreCellBorder()
Flag for ignoring the cell border.
|
java.lang.Boolean |
XlsReportConfiguration.isIgnoreGraphics()
Flag for ignoring graphic elements and exporting text elements only.
|
java.lang.Boolean |
XlsReportConfiguration.isIgnorePageMargins()
Indicates whether page margins should be ignored when the report is exported using a grid-based exporter
|
java.lang.Boolean |
HtmlReportConfiguration.isIgnorePageMargins()
Indicates whether page margins should be ignored when the report is exported using a grid-based exporter
|
java.lang.Boolean |
XlsReportConfiguration.isImageBorderFixEnabled()
Flag for forcing the minimum image padding to 1 pixel, to avoid situations where the image hides the cell border.
|
java.lang.Boolean |
Graphics2DReportConfiguration.isMinimizePrinterJobSize()
Flag to control the use of an AWT rendering fix which causes the printer job size to be reduced when
the exporter draws onto a printer graphic context.
|
java.lang.Boolean |
XlsReportConfiguration.isOnePagePerSheet()
Returns a boolean value specifying whether each report page should be written in a different XLS sheet.
|
java.lang.Boolean |
XlsReportConfiguration.isRemoveEmptySpaceBetweenColumns()
Returns a boolean value specifying whether the empty spaces that could appear between columns should be removed or not.
|
java.lang.Boolean |
XlsReportConfiguration.isRemoveEmptySpaceBetweenRows()
Returns a boolean value specifying whether the empty spaces that could appear between rows should be removed or not.
|
java.lang.Boolean |
HtmlReportConfiguration.isRemoveEmptySpaceBetweenRows()
Returns a boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted.
|
java.lang.Boolean |
JsonExporterConfiguration.isReportComponentsExportOnly()
A flag that determines whether the JSON exporter should export only the
report components, thus ignoring the page components
|
java.lang.Boolean |
PdfExporterConfiguration.isTagged()
Specifies whether the exporter should put structure tags in the generated PDF.
|
java.lang.Boolean |
XlsReportConfiguration.isWhitePageBackground()
Returns a boolean value specifying whether the page background should be white or the default XLS background color.
|
java.lang.Boolean |
HtmlReportConfiguration.isWhitePageBackground()
Returns a boolean value specifying whether the report background should be white.
|
java.lang.Boolean |
HtmlReportConfiguration.isWrapBreakWord()
Returns a boolean value specifying whether the export engine should use force wrapping by breaking words (CSS
word-wrap: break-word ). |
java.lang.Boolean |
XlsMetadataReportConfiguration.isWriteHeader()
Returns a boolean that specifies whether the export header (the column names) should be written or not.
|
java.lang.Boolean |
CsvMetadataReportConfiguration.isWriteHeader()
Returns a boolean that specifies whether the export header (the column names) should be written or not.
|
© 2001-2014 TIBCO Software Inc. www.jaspersoft.com