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 |
PdfExporterConfiguration.getAllowedPermissions()
An exporter hint property representing the allowed permissions for the generated PDF document.
|
java.lang.String |
HtmlExporterConfiguration.getBetweenPagesHtml()
Returns a string representing HTML code that will be inserted between pages of the generated report.
|
java.lang.String |
HtmlReportConfiguration.getBorderCollapse()
Provides the value for the
border-collapse CSS property to be applied
to the table generated for the 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[] |
CsvMetadataReportConfiguration.getColumnNames()
Returns an array of strings representing the comma-separated names of the columns that should be exported.
|
java.lang.String[] |
XlsMetadataReportConfiguration.getColumnNames()
Returns an array of strings representing the comma-separated names of the columns that should be exported.
|
java.lang.Float |
XlsReportConfiguration.getColumnWidthRatio()
Setting used to adjust all column widths in a document or sheet with the same width ratio, in order to get column width
values suitable for Excel output.
|
java.lang.String |
PdfExporterConfiguration.getDeniedPermissions()
An exporter hint property representing the denied permissions for the generated PDF document.
|
java.lang.Integer |
PdfReportConfiguration.getEvenPageOffsetX()
Specifies the X offset for moving elements in even page number pages, to simulate gutter margins.
|
java.lang.Integer |
PdfReportConfiguration.getEvenPageOffsetY()
Specifies the Y offset for moving elements in even page number pages, to simulate gutter margins.
|
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.lang.Integer |
XlsReportConfiguration.getFirstPageNumber()
Setting that specifies the first page number in the page setup dialog.
|
java.lang.Integer |
XlsReportConfiguration.getFitHeight()
This setting indicates the number of pages height to fit the sheet in.
|
java.lang.Integer |
XlsReportConfiguration.getFitWidth()
This setting indicates the number of pages wide to fit the sheet in.
|
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.
|
java.lang.String |
PdfExporterConfiguration.getIccProfilePath()
The path to the ICC profile file for the PDF/A compliant document.
|
ImageAnchorTypeEnum |
XlsReportConfiguration.getImageAnchorType()
Specifies the image anchor type.
|
java.lang.String |
JsonMetadataReportConfiguration.getJsonSchemaResource() |
java.lang.String |
TextExporterConfiguration.getLineSeparator()
Returns a string representing the separator between two lines of text.
|
java.lang.String |
XlsxExporterConfiguration.getMacroTemplate()
Specifies the location of an existing workbook template containing a macro object.
|
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 |
PdfReportConfiguration.getOddPageOffsetX()
Specifies the X offset for moving elements in odd page number pages, to simulate gutter margins.
|
java.lang.Integer |
PdfReportConfiguration.getOddPageOffsetY()
Specifies the Y offset for moving elements in odd page number pages, to simulate gutter margins.
|
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 |
XlsReportConfiguration.getPageScale()
This setting is used to adjust the page content to a given percent of the normal size in the print preview pane.
|
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.
|
PdfPrintScalingEnum |
PdfExporterConfiguration.getPrintScaling()
Setting specifying the print scaling preference in the PDF print dialog.
|
java.lang.String |
CsvExporterConfiguration.getRecordDelimiter()
Returns the string representing the character or sequence of characters to be used to delimit two records.
|
RunDirectionEnum |
XlsReportConfiguration.getSheetDirection()
This setting indicates if the sheet is left-to-right or right-to-left oriented.
|
java.lang.String |
XlsReportConfiguration.getSheetFooterCenter()
This property stores the text content of the sheet footer's center.
|
java.lang.String |
XlsReportConfiguration.getSheetFooterLeft()
This property stores the text content of the sheet footer's left side.
|
java.lang.String |
XlsReportConfiguration.getSheetFooterRight()
This property stores the text content of the sheet footer's right side.
|
java.lang.String |
XlsReportConfiguration.getSheetHeaderCenter()
This property stores the text content of the sheet header's center.
|
java.lang.String |
XlsReportConfiguration.getSheetHeaderLeft()
This property stores the text content of the sheet header's left side.
|
java.lang.String |
XlsReportConfiguration.getSheetHeaderRight()
This property stores the text content of the sheet header's right side.
|
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.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.String |
XlsExporterConfiguration.getWorkbookTemplate()
Setting that specifies the location of an existing workbook template.
|
java.lang.Boolean |
PdfExporterConfiguration.is128BitKey()
Returns a boolean value specifying whether the encryption key is 128 bits.
|
java.lang.Boolean |
HtmlReportConfiguration.isAccessibleHtml()
Configuration setting that determines the exporter to produce accessible HTML.
|
java.lang.Boolean |
XlsReportConfiguration.isAutoFitPageHeight()
Flag that specifies whether the fit height should be estimated automatically.
|
java.lang.Boolean |
XlsReportConfiguration.isCellHidden()
This flag indicates whether the cell content is hidden.
|
java.lang.Boolean |
XlsReportConfiguration.isCellLocked()
This flag indicates whether the cell is locked.
|
java.lang.Boolean |
PdfReportConfiguration.isCollapseMissingBookmarkLevels()
Flag that determines if missing bookmark levels are collapsed, or if
empty bookmarks are created for the missing levels.
|
java.lang.Boolean |
XlsReportConfiguration.isCollapseRowSpan()
Flag for collapsing row span and avoid merging cells across rows.
|
java.lang.Boolean |
JxlReportConfiguration.isComplexFormat()
Deprecated.
Flag specifying whether the cell format pattern is user-defined.
|
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 |
PdfExporterConfiguration.isDisplayMetadataTitle()
Specifies whether the document title should be displayed in the title bar instead of the file name.
|
java.lang.Boolean |
PdfExporterConfiguration.isEncrypted()
Returns a boolean value specifying whether the final PDF document should be encrypted.
|
java.lang.Boolean |
JsonMetadataReportConfiguration.isEscapeMembers() |
java.lang.Boolean |
OdsReportConfiguration.isFlexibleRowHeight()
Indicates whether table rows in ODS documents 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 |
DocxReportConfiguration.isFlexibleRowHeight()
Indicates whether table rows can grow if more text is added into cells.
|
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 |
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 |
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 |
XlsReportConfiguration.isForcePageBreaks()
Flag that specifies whether the page breaks to be marked automatically on each sheet.
|
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.isIgnoreAnchors()
Flag that indicates whether local anchors should be ignored when elements are exported to Excel.
|
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 |
OdtReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
PdfReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
HtmlReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
XlsReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
JsonReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
RtfReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
DocxReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
PptxReportConfiguration.isIgnoreHyperlink() |
java.lang.Boolean |
Graphics2DReportConfiguration.isIgnoreMissingFont() |
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.isIgnorePageMargins()
Indicates whether page margins should be ignored when the report is exported using a grid-based exporter
|
java.lang.Boolean |
XlsReportConfiguration.isIgnoreTextFormatting()
Flag that indicates whether the text elements should be exported without text formatting features,
such as bold, italic, underline, text color, backcolor, etc.
|
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 |
XlsExporterConfiguration.isKeepWorkbookTemplateSheets()
Flag that specifies whether to keep the sheets of the existing template into generated document.
|
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 |
DocxReportConfiguration.isNewLineAsParagraph()
Indicates whether the newline element present in a justified paragraph introduces a new justified paragraph.
|
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 |
HtmlReportConfiguration.isRemoveEmptySpaceBetweenRows()
Returns a boolean value specifying whether the blank lines, that sometimes appear between rows, should be deleted.
|
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 |
XlsReportConfiguration.isShowGridLines()
Flag that specifies if the gridlines in a given sheet are shown.
|
java.lang.Boolean |
XlsReportConfiguration.isShrinkToFit()
Flag that indicates whether the text font size should be decreased in order to
keep the entire text visible in the cell.
|
java.lang.Boolean |
PdfReportConfiguration.isSizePageToContent()
Flag which specifies if the size of each page should be increased to accommodate its content.
|
java.lang.Boolean |
PdfExporterConfiguration.isTagged()
Specifies whether the exporter should put structure tags in the generated PDF.
|
java.lang.Boolean |
TextExporterConfiguration.isTrimLineRight()
Returns a boolean value specifying whether the lines of text in the document should be trimmed to the right.
|
java.lang.Boolean |
JxlExporterConfiguration.isUseTempFile()
Deprecated.
Flag enabling the JExcelApiExporter to use temporary files when creating large documents.
|
java.lang.Boolean |
XlsReportConfiguration.isUseTimeZone()
Flag that determines whether date values are to be translated to the timezone
that was used to fill the report.
|
java.lang.Boolean |
HtmlReportConfiguration.isWhitePageBackground()
Returns a boolean value specifying whether the report background should be white.
|
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.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 |
XlsReportConfiguration.isWrapText()
This flag indicates whether text wrapping is allowed in a given cell.
|
java.lang.Boolean |
CsvExporterConfiguration.isWriteBOM()
Specifies whether the exporter should put a BOM character at the beginning of the output.
|
java.lang.Boolean |
CsvMetadataReportConfiguration.isWriteHeader()
Returns a boolean that specifies whether the export header (the column names) should be written or not.
|
java.lang.Boolean |
XlsMetadataReportConfiguration.isWriteHeader()
Returns a boolean that specifies whether the export header (the column names) should be written or not.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.Object |
PropertiesDefaultsConfigurationFactory.getPropertyValue(JasperReportsContext jasperReportsContext,
ExporterProperty exporterProperty,
java.lang.Class<?> type) |
static java.lang.Object |
PropertiesNoDefaultsConfigurationFactory.getPropertyValue(JasperReportsContext jasperReportsContext,
JRPropertiesHolder propertiesHolder,
ExporterProperty exporterProperty,
java.lang.Class<?> type) |
static java.lang.Object |
PropertiesExporterConfigurationFactory.getPropertyValue(JasperReportsContext jasperReportsContext,
JRPropertiesHolder propertiesHolder,
ExporterProperty exporterProperty,
java.lang.Class<?> type)
FIXMEEXPORT this static method can be moved
|
© 2001-2014 TIBCO Software Inc. www.jaspersoft.com