Its value is used as default for the getFitWidth() Excel export configuration setting. Print pages for a given sheet in Excel are generated according to 'Paper size' settings in the Print menu, with no respect to the initial pagination of the report. In this case differences between a JasperReport print page and a page in Excel may occur. In most common cases the content of a given sheet is supposed to be printed into a single page. But problems may occur when a sheet contains too many rows and/or columns and the printed page becomes unreadable. If too many columns are involved, we can split the sheet width into multiple print pages, in order to make the content readable. In JasperReports this number of pages can be set with the net.sf.jasperreports.export.xls.fit.width property. Note: When this property is set to a value (for instance, n), Excel will estimate if n pages are enough to cover the entire sheet width, keeping font settings and column widths unchanged. If the number of pages is too small, font and column width adjustments will be performed in order to include the entire content into available pages. The printed document will come out with smaller fonts and thinner columns than those exposed in the related sheet. See also the net.sf.jasperreports.export.xls.fit.height property. |
||||
|
|
||||
| API: | PROPERTY_FIT_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.font.size.fix.enabled | ||||
|
Flag property that indicates whether the font size should be decreased so that texts fit into the specified cell height.
Its value is used as default for the isFontSizeFixEnabled() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_FONT_SIZE_FIX_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.force.page.breaks | ||||
|
Flag property that provides a default value for the isForcePageBreaks() export setting.
If set to true, the exporter will automatically add a page break at the end of each page exported on the current sheet.
Allowed values are:
|
||||
|
|
||||
| API: | PROPERTY_FORCE_PAGE_BREAKS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.formula | ||||
| Property that stores the formula which has to be applied to a given cell in an Excel sheet. | ||||
|
|
||||
| API: | PROPERTY_CELL_FORMULA
|
|||
| Default: | N/A | |||
| Scope: | Text Element | |||
| Since: | 3.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.freeze.column | ||||
|
Indicates the name of the first unlocked column in document's sheets. All columns to the left of this one will be 'frozen'.
Allowed values are letters or letter combinations representing valid column names in Excel, such as A, B, AB, AC, etc.
The property should be used when all sheets in the document have the same freeze column name.
The property is available for: |
||||
|
|
||||
| API: | PROPERTY_FREEZE_COLUMN
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.freeze.column.edge | ||||
|
Property that indicates the vertical edge of the freeze pane, relative to the current cell. If set, it overrides the
PROPERTY_FREEZE_COLUMN value.
Allowed values are:
The property is available for:
|
||||
|
|
||||
| API: | PROPERTY_FREEZE_COLUMN_EDGE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.freeze.row | ||||
|
Specifies the index of the first unlocked row in document's sheets. All rows above this will be 'frozen'.
Allowed values are represented by positive integers in the 1..65536 range. Negative values are not considered.
The property should be used when all sheets in the document have the same freeze row index.
The property is available for: |
||||
|
|
||||
| API: | PROPERTY_FREEZE_ROW
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.freeze.row.edge | ||||
|
Property that indicates the horizontal edge of the freeze pane, relative to the current cell. If set, it overrides the
PROPERTY_FREEZE_ROW value.
Allowed values are:
The property is available for:
|
||||
|
|
||||
| API: | PROPERTY_FREEZE_ROW_EDGE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.ignore.anchors | ||||
|
Flag property that indicates whether local anchors should be ignored when elements are exported to Excel.
Its value is used as default for the isIgnoreAnchors() Excel export configuration setting. If set to true, local anchors will be excluded from export. Otherwise they will be exported along with elements they belong to. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_ANCHORS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.ignore.cell.background | ||||
|
Property that specifies whether cell background color should be ignored in the generated document.
Its value is used as default for the isIgnoreCellBackground() Excel export configuration setting. If the property is set at element level, its value will be applied only to the sheet containing that element. Other sheets in the document will not be affected. Note: Since v.6.2.0 this property can be set also per report element. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_CELL_BACKGROUND
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.6.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.ignore.cell.border | ||||
|
Property that specifies whether cell borders should be ignored in the generated document.
Its value is used as default for the isIgnoreCellBorder() Excel export configuration setting. If the property is set at element level, its value will be applied only to the sheet containing that element. Other sheets in the document will not be affected. Note: Since v.6.2.0 this property can be set also per report element. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_CELL_BORDER
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.ignore.graphics | ||||
|
Property that specifies whether graphic elements should be ignored and only text elements will be exported.
Its value is used as default for the isIgnoreGraphics() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_GRAPHICS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.ignore.hyperlink | ||||
| This property is used by XLS, XLSX and ODS exporters to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.ignore.text.formatting | ||||
|
Property that specifies whether the text formatting (such as text color, background color, bold style, italic, underline, etc)
should be ignored in the resulting Excel document at export time or not.
Its value is used as default for the isIgnoreTextFormatting() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_TEXT_FORMATTING
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 6.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.image.anchor.type | ||||
Property that specifies the image anchor type. Possible values are:
Its value is used as default for the getImageAnchorType() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_IMAGE_ANCHOR_TYPE
|
|||
| Default: | MoveNoSize | |||
| Scope: | Global | Context | Report | Image Element | Chart | Component | |||
| Since: | 5.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.image.border.fix.enabled | ||||
|
Flag property that specifies whether the minimum image padding will be forced to 1 pixel, to avoid situations where the image hides the cell border.
Its value is used as default for the isImageBorderFixEnabled() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_IMAGE_BORDER_FIX_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.max.rows.per.sheet | ||||
|
Property that specifies the maximum number of rows allowed to be exported to the same sheet. Negative values or zero means that no limit has been set.
Its value is used as default for the getMaxRowsPerSheet() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_MAXIMUM_ROWS_PER_SHEET
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.metadata.application | ||||
|
Property that contains the application information to use for the generated XLS metadata.
Its value is used as default for the getMetadataApplication() XLS export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_APPLICATION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.metadata.author | ||||
|
Property that contains the author information to use for the generated XLS metadata.
Its value is used as default for the getMetadataAutor() XLS export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_AUTHOR
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.metadata.keywords | ||||
|
Property that contains the keywords to use for the generated XLS metadata.
Its value is used as default for the getMetadataKeywords() XLS export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_KEYWORDS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.metadata.subject | ||||
|
Property that contains the subject information to use for the generated XLS metadata.
Its value is used as default for the getMetadataSubject() XLS export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_SUBJECT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.metadata.title | ||||
|
Property that contains the title information to use for the generated XLS metadata.
Its value is used as default for the getMetadataTitle() XLS export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_TITLE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.one.page.per.sheet | ||||
|
Property that specifies whether each report page should be written in a different XLS sheet.
Its value is used as default for the isOnePagePerSheet() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_ONE_PAGE_PER_SHEET
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.page.scale | ||||
|
Property used to adjust the page content to a given percent of the normal size in the print preview pane.
Its value is used as default for the getPageScale() Excel export configuration setting. Allowed values are positive integers from 10 to 400, representing percents of the normal size. When the property is set at Element level, it can be used to set the page scale per sheet Global settings are overridden by report level settings; report level settings are overridden by element (sheet) level settings. The property overrides the PROPERTY_FIT_WIDTH and PROPERTY_FIT_HEIGHT values. This property is by default not set (null). |
||||
|
|
||||
| API: | PROPERTY_PAGE_SCALE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.password | ||||
|
Property that contains a String value representing the password in case of password protected sheets in documents.
Its value is used as default for the getPassword() Excel export configuration setting. This property is by default not set (null). |
||||
|
|
||||
| API: | PROPERTY_PASSWORD
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.pattern | ||||
| Property whose value is an Excel compatible pattern, to be used as replacement for the text field pattern when exporting to XLS formats. | ||||
|
|
||||
| API: | PROPERTY_CELL_PATTERN
|
|||
| Default: | N/A | |||
| Scope: | Text Element | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.pattern.{arbitrary_pattern} | ||||
| Properties having net.sf.jasperreports.export.xls.pattern. prefix are used to store specific Excel format patterns that correspond to their related Java format pattern. The {arbitrary_pattern} suffix represents the Java pattern and the property value is the related Excel pattern. When these properties are defined in a JRXML report design, special characters should be XML-escaped. When they are defined in a properties file, one should also escape special characters. If some properties are defined in the report, they will override the context properties. | ||||
|
|
||||
| API: | FORMAT_PATTERN_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.footer.margin | ||||
|
Custom property storing the footer margin for an Excel sheet, expressed in pixels.
Its value is used as default for the related
getPrintFooterMargin() Excel export configuration setting:
When this property is set globally or per report, all sheets in the generated document will come with the same footer margins.
If these margins should differ from a sheet to another, we can set the above property at element level, so that footer margins in a
sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide footer margin properties, the
maximum value for the footer margin will be considered.
Properties set at element level take priority over properties set globally or per report level. Default value for this property is 0. |
||||
|
|
||||
| API: | PROPERTY_PRINT_FOOTER_MARGIN
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.header.margin | ||||
|
Custom property storing the header margin for an Excel sheet, expressed in pixels.
Its value is used as default for the related
getPrintHeaderMargin() Excel export configuration setting.
When this property is set globally or per report, all sheets in the generated document will come with the same header margins.
If these margins should differ from a sheet to another, we can set the above property at element level, so that header margins in a
sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide header margin properties, the
maximum value for the header margin will be considered.
Properties set at element level take priority over properties set globally or per report level. Default value for this property is 0. |
||||
|
|
||||
| API: | PROPERTY_PRINT_HEADER_MARGIN
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.page.bottom.margin | ||||
|
Custom property storing the bottom page margin for an Excel sheet, expressed in pixels.
Its value is used as default for the related
getPrintPageBottomMargin()
Excel export configuration setting.
When this property is set globally or per report level, all sheets in the generated document will have the same bottom page margins. If these margins should differ from a sheet to another, we can set the above property at element level, so that the bottom page margin in a sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide bottom page margin properties, the maximum value for the related margin will be considered. Default value for this property is 0. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PAGE_BOTTOM_MARGIN
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.page.height | ||||
|
Custom property specifying the page height in print preview pane, measured in pixels.
Its value is used as default for the related
getPrintPageHeight() Excel export configuration setting.
When this property is set globally or per report, all sheets in the generated document will come with the same page height.
If this page height should differ from a sheet to another, we can set the above property at element level, so that the page height in a
sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide the page height property, the
maximum value for the page height will be considered.
Properties set at element level take priority over properties set globally or per report level. The property is not set by default. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PAGE_HEIGHT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.page.left.margin | ||||
|
Custom property storing the left page margin for an Excel sheet, expressed in pixels.
Its value is used as default for the related
getPrintPageLeftMargin()
Excel export configuration setting.
When this property is set globally or per report level, all sheets in the generated document will have the same left page margins. If these margins should differ from a sheet to another, we can set the above property at element level, so that the left page margin in a sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide left page margin properties, the maximum value for the related margin will be considered. Default value for this property is 0. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PAGE_LEFT_MARGIN
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.page.right.margin | ||||
|
Custom property storing the right page margin for an Excel sheet, expressed in pixels.
Its value is used as default for the related
getPrintPageRightMargin()
Excel export configuration setting.
When this property is set globally or per report level, all sheets in the generated document will have the same right page margins. If these margins should differ from a sheet to another, we can set the above property at element level, so that the right page margin in a sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide right page margin properties, the maximum value for the related margin will be considered. Default value for this property is 0. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PAGE_RIGHT_MARGIN
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.page.top.margin | ||||
|
Custom property storing the top page margin for an Excel sheet, expressed in pixels.
Its value is used as default for the related
getPrintPageTopMargin()
Excel export configuration setting.
When this property is set globally or per report level, all sheets in the generated document will have the same top page margins. If these margins should differ from a sheet to another, we can set the above property at element level, so that the top page margin in a sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide top page margin properties, the maximum value for the related margin will be considered. Default value for this property is 0. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PAGE_TOP_MARGIN
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.print.page.width | ||||
|
Custom property specifying the page width in print preview pane, measured in pixels.
Its value is used as default for the related
getPrintPageWidth() Excel export configuration setting.
When this property is set globally or per report, all sheets in the generated document will come with the same page width.
If this page width should differ from a sheet to another, we can set the above property at element level, so that the page width in a
sheet will be read from the element in the sheet that contains this property. When several elements in a sheet provide the page width property, the
maximum value for the page height will be considered.
Properties set at element level take priority over properties set globally or per report level. The property is not set by default. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PAGE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.remove.empty.space.between.columns | ||||
|
Property that specifies whether the empty spacer columns should be removed or not.
Its value is used as default for the isRemoveEmptySpaceBetweenColumns() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.remove.empty.space.between.rows | ||||
|
Property that specifies whether the empty spacer rows should be removed or not.
Its value is used as default for the isRemoveEmptySpaceBetweenRows() Excel export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.repeat.value | ||||
| Property that specifies whether the value associated with PROPERTY_COLUMN_NAME should be repeated or not when it is missing. This property is available for the metadata-based Excel export. | ||||
|
|
||||
| API: | PROPERTY_REPEAT_VALUE
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 4.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.row.outline.level.{arbitrary_level} | ||||
|
Property prefix used to indicate the current outline row level, and when necessary, the ending row of the current outline row
group with the given level. The suffix of these properties is associated with the outline level, while the property value indicates
if the current row group should continue or should end. The most recommended practice is to use the outline level itself as property
suffix, although this is not mandatory. The suffix may take any other string value, but one has to keep in mind that suffixes are
used as sorted row levels descriptors. For instance, because "aaa" < "bbb", the outline level associated with the "aaa" suffix
will be smaller than the level associated with the "bbb" suffix. A completely intuitive representation of the row levels uses the row
level as property suffix.
In such a case, the net.sf.jasperreports.export.xls.outline.level.2 property means that its value is correlated with the outline level 2, so the current row belongs to a level 2 row group. Based on Office Open XML specs, allowed values for outline levels are positive integers from 1 to 7. The value of this property could be any expression (including null). When such a property occurrence is met, the suffix indicates the outline level for that row. If multiple properties with the same prefix are defined for the same row, the deepest outline level is considered for that row. To end an outline row group one has to set the related outline level property with the End value. This is a special property value instructing the JR engine that the current row group of that level ends on the current row. |
||||
|
|
||||
| API: | PROPERTY_ROW_OUTLINE_LEVEL_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.1.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.direction | ||||
This property indicates if the sheet is left-to-right or right-to-left oriented. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_SHEET_DIRECTION
|
|||
| Default: | LTR | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.footer.center | ||||
Custom property storing the text content of the Excel sheet center footers.
Its value is used as default for the related
getSheetFooterCenter()
Excel export configuration setting.
The text content in Excel center footer is limited to 255 characters. It may be normal plain text, or may contain some special
character sequences that are usually interpreted by Excel app as dynamic settings for headers/footers:
For instance, a center footer property that contains the 'Page <i> of <n>' structure should be set as follows: <property name="net.sf.jasperreports.export.xls.sheet.footer.center" value="Page &P of &N"/> Starting with v.6.4.3 this property can be set also at element level, in order to control headers/footers in each sheet separately. If several elements in a sheet contain the same center footer property, the value for the last element in the sheet will be considered. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_SHEET_FOOTER_CENTER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.footer.left | ||||
Custom property storing the text content of the Excel sheet left footers.
Its value is used as default for the related
getSheetFooterLeft()
Excel export configuration setting.
The text content in Excel left footer is limited to 255 characters. It may be normal plain text, or may contain some special
character sequences that are usually interpreted by Excel app as dynamic settings for headers/footers:
For instance, a left footer property that contains the 'Page <i> of <n>' structure should be set as follows: <property name="net.sf.jasperreports.export.xls.sheet.footer.left" value="Page &P of &N"/> Starting with v.6.4.3 this property can be set also at element level, in order to control headers/footers in each sheet separately. If several elements in a sheet contain the same left footer property, the value for the last element in the sheet will be considered. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_SHEET_FOOTER_LEFT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.footer.right | ||||
Custom property storing the text content of the Excel sheet right footers.
Its value is used as default for the related
getSheetFooterRight()
Excel export configuration setting.
The text content in Excel right footer is limited to 255 characters. It may be normal plain text, or may contain some special
character sequences that are usually interpreted by Excel app as dynamic settings for headers/footers:
For instance, a right footer property that contains the 'Page <i> of <n>' structure should be set as follows: <property name="net.sf.jasperreports.export.xls.sheet.footer.right" value="Page &P of &N"/> Starting with v.6.4.3 this property can be set also at element level, in order to control headers/footers in each sheet separately. If several elements in a sheet contain the same right footer property, the value for the last element in the sheet will be considered. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_SHEET_FOOTER_RIGHT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.header.center | ||||
Custom property storing the text content of the Excel sheet center headers.
Its value is used as default for the related
getSheetHeaderCenter()
Excel export configuration setting.
The text content in Excel center header is limited to 255 characters. It may be normal plain text, or may contain some special
character sequences that are usually interpreted by Excel app as dynamic settings for headers/footers:
For instance, a center header property that contains the 'Page <i> of <n>' structure should be set as follows: <property name="net.sf.jasperreports.export.xls.sheet.header.center" value="Page &P of &N"/> Starting with v.6.4.3 this property can be set also at element level, in order to control headers/footers in each sheet separately. If several elements in a sheet contain the same center header property, the value for the last element in the sheet will be considered. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_SHEET_HEADER_CENTER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.header.left | ||||
Custom property storing the text content of the Excel sheet left headers.
Its value is used as default for the related
getSheetHeaderLeft()
Excel export configuration setting.
The text content in Excel left header is limited to 255 characters. It may be normal plain text, or may contain some special
character sequences that are usually interpreted by Excel app as dynamic settings for headers/footers:
For instance, a left header property that contains the 'Page <i> of <n>' structure should be set as follows: <property name="net.sf.jasperreports.export.xls.sheet.header.left" value="Page &P of &N"/> Starting with v.6.4.3 this property can be set also at element level, in order to control headers/footers in each sheet separately. If several elements in a sheet contain the same left header property, the value for the last element in the sheet will be considered. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_SHEET_HEADER_LEFT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.header.right | ||||
Custom property storing the text content of the Excel sheet right headers.
Its value is used as default for the related
getSheetHeaderRight()
Excel export configuration setting.
The text content in Excel right header is limited to 255 characters. It may be normal plain text, or may contain some special
character sequences that are usually interpreted by Excel app as dynamic settings for headers/footers:
For instance, a right header property that contains the 'Page <i> of <n>' structure should be set as follows: <property name="net.sf.jasperreports.export.xls.sheet.header.right" value="Page &P of &N"/> Starting with v.6.4.3 this property can be set also at element level, in order to control headers/footers in each sheet separately. If several elements in a sheet contain the same right header property, the value for the last element in the sheet will be considered. Properties set at element level take priority over properties set globally or per report level. |
||||
|
|
||||
| API: | PROPERTY_SHEET_HEADER_RIGHT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.name | ||||
|
Property used to set the name of the sheet containing a given element. Its value overrides the report-level settings for the sheet name.
If several elements in the sheet contain this property, the engine will consider the value of the last exported element's property. |
||||
|
|
||||
| API: | PROPERTY_SHEET_NAME
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.1.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name} | ||||
|
Report properties (exporter hints) that configure sheet names to be used when exporting to Excel.
The properties are useful when defining sheet names in the JRXML template is required.
Sheet names set via these properties are used as defaults for the getSheetNames() Excel export configuration setting. The properties should start with the net.sf.jasperreports.export.xls.sheet.names. prefix, followed by an arbitrary suffix. Each property can hold a single sheet name or several names separated by the slash ("/") character. Values are collected in the order in which the properties appear in the JRXML template, so one has to be careful with the order when editing a JRXML. The property suffixes are not important, but the order of the properties matters. For instance, if a given report has 3 resulting sheets, there are multiple possibilities to define the sheet names as "First sheet", "Second sheet" and "Third sheet" within the JRXML template:
By default no sheet name properties are set. |
||||
|
|
||||
| API: | PROPERTY_SHEET_NAMES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Report | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.sheet.tab.color | ||||
|
Property whose value is used to set the tab color of a given sheet in XLSX and ODS output formats.
When set at report level, all sheets in the document will have their tabs colored the same way.
When set at report element level and multiple elements in a sheet provide this property,
the last read value will be considered.
Its value usually can be expressed as #-prefixed CSS color. Report-level settings are overridden by element-level settings for this property. If several elements in a sheet contain this property, the engine will consider the value of the last exported element's property. Note: This property is not supported by the XLS output format. |
||||
|
|
||||
| API: | PROPERTY_SHEET_TAB_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.show.gridlines | ||||
|
Flag property that specifies if the gridlines in a given sheet are shown.
Its value is used as default for the isShowGridLines() Excel export configuration setting. If multiple elements in a sheet provide this property, the last read value will be considered. Global settings are overridden by report level settings; report level settings are overridden by element (sheet) level settings. |
||||
|
|
||||
| API: | PROPERTY_SHOW_GRIDLINES
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.shrink.to.fit | ||||
|
Flag property that indicates whether the text font size should be decreased in order to
keep the entire text visible in the cell. If set to true, this will automatically disable the
wrap text setting for the cell (see net.sf.jasperreports.export.xls.wrap.text).
Usually this property works in conjunction with net.sf.jasperreports.print.keep.full.text, in order to preserve the entire text content at export time. The value of this property is used as default for the isShrinkToFit() Excel export configuration setting. Settings at global level are overridden by report level settings; report level settings are overridden by element level settings. |
||||
|
|
||||
| API: | PROPERTY_SHRINK_TO_FIT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.use.timezone | ||||
|
Property that determines whether date values are to be translated to the timezone that was used to fill the report.
Its value is used as default for the isUseTimeZone() Excel export configuration setting. By default, date values are exported to Excel using the default timezone of the system. Setting this property to true instructs the exporter to use he report fill timezone to export date values. The property only has effect when net.sf.jasperreports.export.xls.detect.cell.type is set. |
||||
|
|
||||
| API: | PROPERTY_USE_TIMEZONE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 4.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.white.page.background | ||||
|
Property that specifies whether the page background should be white or the default XLS background color.
Its value is used as default for the isWhitePageBackground() Excel export configuration setting. If the property is set at element level, its value will be applied only to the sheet containing that element. Other sheets in the document will not be affected. Note: Since v.6.2.0 this property can be set also per report element |
||||
|
|
||||
| API: | PROPERTY_WHITE_PAGE_BACKGROUND
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.workbook.template | ||||
|
Property used to store the location of an existing workbook template.
Its value is used as default for the getWorkbookTemplate() Excel export configuration setting. The content of an existing workbook document or template can be embedded into exported document if the template location is known. In this case the content of the template will be exported first and the content of the exported report will be appended to this one. Macros and other settings in the existing template will be also preserved in the generated document. Templates can be loaded from Excel template files (*.xlt) as well as from valid Excel documents (*.xls). This property is used in the Excel exporter based on Apache POI APIs (JRXlsExporter). There's no similar property for the JRXlsxExporter. |
||||
|
|
||||
| API: | PROPERTY_WORKBOOK_TEMPLATE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.5.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.workbook.template.keep.sheets | ||||
|
Flag property that specifies whether to keep the sheets of the existing template into generated document.
Its value is used as default for the isKeepWorkbookTemplateSheets() Excel export configuration setting. Sometimes is important to embed in a generated document only macros and/or other global settings from an existing template, but without keeping the own sheets of the template document. If set to false, this property prevent the template sheets to be exported. This property is used in conjunction with PROPERTY_WORKBOOK_TEMPLATE. Allowed values are:
|
||||
|
|
||||
| API: | PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.5.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.wrap.text | ||||
|
Custom element property specifying if text wrapping is allowed in a given cell.
Its value is used as default for the isWrapText() Excel export configuration setting. If set to false, text wrapping is forbidden, otherwise it is allowed. |
||||
|
|
||||
| API: | PROPERTY_WRAP_TEXT
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.7.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.write.header | ||||
|
Property that specifies whether the export header (the column names) should be written or not, in the metadata-based Excel export.
Its value is used as default for the isWriteHeader() Excel metadata export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_WRITE_HEADER
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xlsx.macro.template | ||||
|
Property used to store the location of an existing Excel 2007 workbook template containing a macro object.
When exporting into Excel 2007 format, the macro object will be copied into the generated document if the template location is valid.
Macros can be loaded from Excel 2007 macro-enabled template files (*.xltm) as well as from valid
Excel macro-enabled documents (*.xlsm).
The value of this property is used as default for the getMacroTemplate() Excel 2007 export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_MACRO_TEMPLATE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.5.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xml.end.page.index | ||||
| Property used to store the end page index for the XML export. | ||||
|
|
||||
| API: | PROPERTY_END_PAGE_INDEX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xml.page.count | ||||
| Property used to store the page count for the XML export. | ||||
|
|
||||
| API: | PROPERTY_PAGE_COUNT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xml.parser.factory | ||||
|
Property that gives a parser factory class which should be used
for parsing XML exports.
By default, this property is set to use PrintSaxParserFactory as report parser factory. |
||||
|
|
||||
| API: | PROPERTY_PRINT_PARSER_FACTORY
|
|||
| Default: | net.sf.jasperreports.engine.xml.PrintSaxParserFactory | |||
| Scope: | Global | Context | |||
| Since: | 4.1.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xml.replace.invalid.chars | ||||
|
Stores the text sequence used to replace invalid XML characters.
By default, this property is set to replace invalid chars with question marks. Depending on particular needs, the following settings are available:
|
||||
|
|
||||
| API: | PROPERTY_REPLACE_INVALID_CHARS
|
|||
| Default: | ? | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.7.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xml.start.page.index | ||||
| Property used to store the start page index for the XML export. | ||||
|
|
||||
| API: | PROPERTY_START_PAGE_INDEX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xml.validation | ||||
| Property that forces the XML validation, when a document exported to XML format is loaded. | ||||
|
|
||||
| API: | EXPORT_XML_VALIDATION
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 1.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.extension.{registry_id}.{property_suffix} | ||||
|
Property that can be used to provide a registry-specific property, by appending the registry ID and then a fixed property suffix to the fixed property prefix net.sf.jasperreports.extension..
For example: the net.sf.jasperreports.extension.chart.theme.spring.beans.resource contains the spring beans resource bundle location for the spring-based extensions registry class with the "chart.theme" registry ID. |
||||
|
|
||||
| API: | PROPERTY_REGISTRY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Extension | |||
| Since: | 3.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.extension.file.repository.resolve.absolute.path | ||||
| Flag property that indicates whether the absolute path to be used instead, when resources are not found in the file repository. | ||||
|
|
||||
| API: | PROPERTY_FILE_REPOSITORY_RESOLVE_ABSOLUTE_PATH
|
|||
| Default: | false | |||
| Scope: | Global | Extension | |||
| Since: | 4.1.1 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.extension.file.repository.root | ||||
| Specifies the file repository root location. | ||||
|
|
||||
| API: | PROPERTY_FILE_REPOSITORY_ROOT
|
|||
| Default: | N/A | |||
| Scope: | Global | Extension | |||
| Since: | 4.1.1 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.extension.registry.factory.{arbitrary_name} | ||||
|
Properties used to indicate extensions registry factories.
Such factories are used by the default components registry class to instantiate sub extensions registries. Each such property contains the fixed property prefix net.sf.jasperreports.extension.registry.factory. and an arbitrary name suffix which is used as registry ID when instantiating. The property should have as value the name of a ExtensionsRegistryFactory implementation. |
||||
|
|
||||
| API: | PROPERTY_REGISTRY_FACTORY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Extension | |||
| Since: | 3.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.extensions.registry.class | ||||
|
A property that provides the default ExtensionsRegistry
implementation class.
This property is only read at initialization time, therefore changing the property value at a later time will have no effect. |
||||
|
|
||||
| API: | PROPERTY_EXTENSIONS_REGISTRY_CLASS
|
|||
| Default: | net.sf.jasperreports.extensions.DefaultExtensionsRegistry | |||
| Scope: | Global | |||
| Since: | 3.1.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.file.buffer.os.memory.threshold | ||||
|
Property specifying the maximum in-memory buffer length that triggers the creation of a temporary file on disk to store further content sent to a
FileBufferedOutputStream instance.
Note: While the Global level setting is available for all document exporters, the Report level setting is processed for the XLSX output format only. To avoid memory leaks when exporting reports with a large number of sheets to XLSX format, just set this property to 0 at report level. |
||||
|
|
||||
| API: | PROPERTY_MEMORY_THRESHOLD
|
|||
| Default: | 262144 | |||
| Scope: | Global | |||
| Since: | 1.3.4 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.frame.border.split.type | ||||
|
Provides the default border split type for frames.
The property can be set at report and global/JasperReports context levels. The property value can be NoBorders, in which case frames that span two pages do not have the bottom border of the first fragment and the top border of the second fragment drawn, and DrawBorders, in which case both fragments have borders drawn on all sides. |
||||
|
|
||||
| API: | PROPERTY_BORDER_SPLIT_TYPE
|
|||
| Default: | NoBorders | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.governor.max.pages | ||||
| If the governor that checks if a report exceeds a specified limit of pages is turned on, this property will indicate the maximum number of pages allowed to be ran, in order to prevent a memory overflow error. If the number of pages in the report becomes greater than this value, the report execution will be stopped. | ||||
|
|
||||
| API: | PROPERTY_MAX_PAGES
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.governor.max.pages.enabled | ||||
| A flag indicating whether the governor that checks if a report exceeds a specified limit of pages is turned on. With this property enabled, the JR engine will stop the report execution if the number of pages becomes greater than a custom given value. | ||||
|
|
||||
| API: | PROPERTY_MAX_PAGES_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.governor.timeout | ||||
| If the governor that checks if the elapsed time during report execution exceeds a specified amount of time is turned on, this property will indicate the maximum allowed amount of time, in order to prevent a memory overflow error. If this value becomes exceeded, the report execution will be stopped. | ||||
|
|
||||
| API: | PROPERTY_TIMEOUT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.governor.timeout.enabled | ||||
|
A flag indicating whether the governor that checks if the elapsed time during report execution
exceeds a specified amount of time is turned on.
With this property enabled, the JR engine will stop the report execution if the elapsed time becomes greater than the limit value. By default it should be turned off. |
||||
|
|
||||
| API: | PROPERTY_TIMEOUT_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.hql.clear.cache | ||||
|
Property specifying whether Hibernate session cache should be cleared between two consecutive fetches when using pagination.
By default, the cache cleanup is not performed. |
||||
|
|
||||
| API: | PROPERTY_HIBERNATE_CLEAR_CACHE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 1.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.hql.field.mapping.descriptions | ||||
|
Property specifying whether field descriptions should be used to determine the mapping between the fields and the query return values.
By default, field description are used. |
||||
|
|
||||
| API: | PROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 1.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.hql.query.list.page.size | ||||
| Property specifying the number of result rows to be retrieved at once when the execution type is list. Result pagination is implemented by org.hibernate.Query.setFirstResult() and org.hibernate.Query.setMaxResults(). By default, all the rows are retrieved (no result pagination is performed). | ||||
|
|
||||
| API: | PROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 1.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.hql.query.run.type | ||||
Property specifying the Hibernate query execution type. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_HIBERNATE_QUERY_RUN_TYPE
|
|||
| Default: | list | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 1.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.body | ||||
| Property that specifies the body entity of the POST/PUT request used by the HTTP data adapters. If present in the dataset or at report parameter level, it overrides the request body specified in the data adapter definition. When specified at parameter level, it does not need to provide a value. Instead, it is used to mark the report parameter that would provide the POST/PUT request body entity value. If multiple parameters have this property set, the last one will be used to provide the request body value. Also, when the POST/PUT request body is specified, all other POST parameter values are ignored. | ||||
|
|
||||
| API: | PROPERTY_BODY
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.header | ||||
| Property which specifies that the current parameter will contribute a request header value when HTTP data adapters are used. The value of this property indicates the name of the request header to be contributed. In case the property is used, but no value is provided, the name of the request header will be the same as the current report parameter name. Request headers introduced this way override the request headers having the same name which were declared at data adapter level. If multiple parameters try to provide a value for the same request header, the request header will be added multiple times to the request. | ||||
|
|
||||
| API: | PROPERTY_HEADER
|
|||
| Default: | N/A | |||
| Scope: | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.method | ||||
|
Property that specifies the request method used by the HTTP data adapters.
If present in the dataset or at report parameter level, it overrides the request method specified in the data adapter definition.
When specified at parameter level, it does not need to provide a value. Instead, it is used to mark the report parameter that would
provide the request method.
If multiple parameters have this property set, the last one will be considered as request method value.
This property takes priority over request BODY or POST parameters. If the property is missing, its default value depends on the presence/absence of the request BODY or POST parameters: if BODY or POST. parameters are present, the default value is POST, otherwise it is GET. |
||||
|
|
||||
| API: | PROPERTY_METHOD
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | Parameter | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.password | ||||
| Property that specifies the password to be used by the HTTP data adapters with basic authentication. If present in the dataset or at report parameter level, it overrides the password specified in the data adapter definition, or the value provided by the report parameter having the now deprecated HTTP_DATA_PASSWORD name. When specified at parameter level, it does not need to provide a value. Instead, it is used to mark the report parameter that would provide the password value. If multiple parameters have this property set, the last one will be used to provide the password value. | ||||
|
|
||||
| API: | PROPERTY_PASSWORD
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.post.parameter | ||||
| Property which specifies that the current parameter will contribute a POST request parameter value when HTTP data adapters are used. The value of this property indicates the name of the request parameter to be contributed. In case the property is used, but no value is provided, the name of the request parameter will be the same as the current report parameter name. Request parameters introduced this way override the request parameters having the same name which were declared at data adapter level or were provided by the report parameters having the now deprecated HTTP_DATA_POST_PARAMETER_ prefix. If multiple parameters try to provide a value for the same request parameter, the request parameter will be sent multiple times, becoming a request parameter of type array. All POST parameter values are ignored if a POST/PUT request body is specified. | ||||
|
|
||||
| API: | PROPERTY_POST_PARAMETER
|
|||
| Default: | N/A | |||
| Scope: | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.url | ||||
| Property that specifies the base URL to be used by the HTTP data adapters. If present in the dataset or at report parameter level, it overrides the URL specified in the data adapter definition, or the value provided by the report parameter having the now deprecated HTTP_DATA_URL name. When specified at parameter level, it does not need to provide a value. Instead, it is used to mark the report parameter that would provide the URL value. If multiple parameters have this property set, the last one will be used to provide the URL value. | ||||
|
|
||||
| API: | PROPERTY_URL
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.url.parameter | ||||
| Property which specifies that the current parameter will append a request parameter value to the base URL when HTTP data adapters are used. The value of this property indicates the name of the request parameter to be appended. In case the property is used, but no value is provided, the name of the request parameter will be the same as the current report parameter name. Request parameters introduced this way override the request parameters having the same name which were declared at data adapter level or were provided by the report parameters having the now deprecated HTTP_DATA_URL_PARAMETER_ prefix. If multiple parameters try to provide a value for the same request parameter, the request parameter will be sent multiple times, becoming a request parameter of type array. | ||||
|
|
||||
| API: | PROPERTY_URL_PARAMETER
|
|||
| Default: | N/A | |||
| Scope: | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.http.data.username | ||||
| Property that specifies the user name to be used by the HTTP data adapters with basic authentication. If present in the dataset or at report parameter level, it overrides the user name specified in the data adapter definition, or the value provided by the report parameter having the now deprecated HTTP_DATA_USERNAME name. When specified at parameter level, it does not need to provide a value. Instead, it is used to mark the report parameter that would provide the user name value. If multiple parameters have this property set, the last one will be used to provide the user name value. | ||||
|
|
||||
| API: | PROPERTY_USERNAME
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | Parameter | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.image.dpi | ||||
| Specifies the image resolution in dots-per-inch, for the images created by the engine when rasterizing SVGs or when clipping other renderers. | ||||
|
|
||||
| API: | PROPERTY_IMAGE_DPI
|
|||
| Default: | 72 | |||
| Scope: | Global | Context | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.image.encoder | ||||
| Property specifying the name of the class implementing the JRImageEncoder interface to be used by the engine. If not set, the engine will try to an image encoder implementation that corresponds to the JVM version. | ||||
|
|
||||
| API: | PROPERTY_IMAGE_ENCODER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 2.0.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.image.reader | ||||
| Property specifying the name of the class implementing the JRImageReader interface to be used by the engine. If not set, the engine will try to an image reader implementation that corresponds to the JVM version. | ||||
|
|
||||
| API: | PROPERTY_IMAGE_READER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 2.0.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.javabean.field.property | ||||
| Property specifying the JavaBean property name for the dataset field in case an JavaBean data source is used. This mapping was previously specified using the fieldDescription attribute, but using this custom property is now recommended. | ||||
|
|
||||
| API: | PROPERTY_JAVABEAN_FIELD_PROPERTY
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.javascript.class.compiler.expressions.per.script | ||||
| Property that determines the maximum number of report expressions that will be included in a single generated Java class. | ||||
|
|
||||
| API: | PROPERTY_EXPRESSIONS_PER_SCRIPT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 4.7.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.javascript.class.compiler.optimization.level | ||||
|
Property that determines the optimization level to use when compiling expressions into Java bytecode.
See |
||||
|
|
||||
| API: | PROPERTY_OPTIMIZATION_LEVEL
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 4.7.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.javascript.class.compiler.script.max.size | ||||
| Property that determines the maximum size of a script that will be compiled into a single Java class. | ||||
|
|
||||
| API: | PROPERTY_SCRIPT_MAX_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 4.7.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.javascript.evaluator.optimization.level | ||||
|
Property that determines the optimization level to use when compiling expressions into Java bytecode.
See |
||||
|
|
||||
| API: | PROPERTY_OPTIMIZATION_LEVEL
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 4.7.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.cached.rowset | ||||
| Flag property specifying if data will be stored in a cached rowset. | ||||
|
|
||||
| API: | PROPERTY_CACHED_ROWSET
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.concurrency | ||||
Property specifying the concurrency rule for the java.sql.ResultSet created by the
JRJdbcQueryExecuter. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_JDBC_CONCURRENCY
|
|||
| Default: | readOnly | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 3.5.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.data.adapter.auto.commit | ||||
|
Flag that sets a default value for the autoCommit attribute of JDBC data adapters.
By default no value is set, which means that setAutoCommit is not called on JDBC connections created by data adapter. |
||||
|
|
||||
| API: | PROPERTY_DEFAULT_AUTO_COMMIT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.data.adapter.read.only | ||||
|
Flag that sets a default value for the readOnly attribute of JDBC data adapters.
By default no value is set, which means that setReadOnly is not called on JDBC connections created by data adapter. |
||||
|
|
||||
| API: | PROPERTY_DEFAULT_READ_ONLY
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.data.adapter.transaction.isolation | ||||
|
Property that sets a default value for the transactionIsolation attribute of JDBC data adapters.
By default no value is set, which means that setTransactionIsolation is not called on JDBC connections created by data adapter. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_DEFAULT_TRANSACTION_ISOLATION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.fetch.size | ||||
| Property specifying the fetch size for the java.sql.ResultSet created by the JRJdbcQueryExecuter and the JRHibernateQueryExecuter. | ||||
|
|
||||
| API: | PROPERTY_JDBC_FETCH_SIZE
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 1.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.fields.time.zone | ||||
|
Property specifying the default time zone to be used for all date/time fields when sending and retrieving date/time values to and from the database.
The property can be set globally or at dataset level. The property value can be a time zone ID or REPORT_TIME_ZONE. In the latter case the report time zone (as in JRParameter.REPORT_TIME_ZONE) will be used. |
||||
|
|
||||
| API: | PROPERTY_FIELDS_TIME_ZONE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.holdability | ||||
Property specifying the cursor holdability after commit for the java.sql.ResultSet created by the
JRJdbcQueryExecuter. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_JDBC_HOLDABILITY
|
|||
| Default: | hold | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 3.5.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.max.field.size | ||||
| Property specifying the limit for the maximum number of bytes in a ResultSet column storing character or binary values created by the JRJdbcQueryExecuter. | ||||
|
|
||||
| API: | PROPERTY_JDBC_MAX_FIELD_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 3.5.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.parameters.time.zone | ||||
|
Property specifying the default time zone to be used for all date/time parameters when sending and retrieving date/time values to and from the database.
The property can be set globally or at dataset level. The property value can be a time zone ID or REPORT_TIME_ZONE. In the latter case the report time zone (as in JRParameter.REPORT_TIME_ZONE) will be used. |
||||
|
|
||||
| API: | PROPERTY_PARAMETERS_TIME_ZONE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.query.timeout | ||||
|
Property specifying the number of seconds to wait for the Statement created by the
JRJdbcQueryExecuter to execute.
The value must be greater than or equal to 0. Setting this property to 0 means that there is no limit. |
||||
|
|
||||
| API: | PROPERTY_JDBC_QUERY_TIMEOUT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.result.set.type | ||||
Property specifying the type for the java.sql.ResultSet created by the
JRJdbcQueryExecuter. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_JDBC_RESULT_SET_TYPE
|
|||
| Default: | forwardOnly | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 3.5.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jdbc.time.zone | ||||
|
Property specifying the default time zone to be used for sending and retrieving date/time values to and from the database.
The property can be set globally, at dataset level, at parameter and field levels, and as a report/dataset parameter. Note that sending a value as parameter will override all properties, and the time zone will be used for all date/time parameters and fields in the report. The property value can be a time zone ID or REPORT_TIME_ZONE. In the latter case the report time zone (as in JRParameter.REPORT_TIME_ZONE) will be used. |
||||
|
|
||||
| API: | PROPERTY_TIME_ZONE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | Parameter | Field | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jrxml.writer.exclude.properties.{suffix} | ||||
|
Properties having this prefix specify which properties will be excluded when a JRXML representation is extracted from an in-memory
JRReport object. The value of such a report context property is
a regular expression that matches property names in the JRReport object. Properties with matching names will be
excluded from the generated JRXML representation.
This feature does not apply to property expressions. |
||||
|
|
||||
| API: | PREFIX_EXCLUDE_PROPERTIES
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 6.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jrxml.writer.exclude.uuids | ||||
| Property to control the writing of UUIDs for report elements and other report entities in the generated JRXML representation of the report template. When the UUDIs are missing in the JRXML report template definition, they will be regenerated automatically on report template loading. Excluding UUIDs from generated JRXML is useful for triggering their regeneration and thus ensuring they are unique again in case the report template source was edited manually and UUIDs were duplicated by copy/paste. | ||||
|
|
||||
| API: | PROPERTY_EXCLUDE_UUIDS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 6.5.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.json.date.pattern | ||||
| Parameter/property holding the format pattern used to instantiate java.util.Date instances. | ||||
|
|
||||
| API: | JSON_DATE_PATTERN
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.json.field.expression | ||||
| Property specifying the JSON expression for the dataset field in case a JSON data source is used. This mapping was previously specified using the fieldDescription attribute, but using this custom property is now recommended. | ||||
|
|
||||
| API: | PROPERTY_FIELD_EXPRESSION
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.json.locale.code | ||||
|
Built-in parameter/property holding the java.lang.String code of the locale to be used when parsing the JSON data.
The allowed format is: language[_country[_variant]] |
||||
|
|
||||
| API: | JSON_LOCALE_CODE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.json.number.pattern | ||||
| Parameter/property holding the format pattern used to instantiate java.lang.Number instances. | ||||
|
|
||||
| API: | JSON_NUMBER_PATTERN
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.json.source | ||||
|
Built-in parameter/property holding the value of the source for the JSON file.
It can be:
|
||||
|
|
||||
| API: | JSON_SOURCE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.json.timezone.id | ||||
| Built-in parameter/property holding the java.lang.String value of the time zone id to be used when parsing the JSON data. | ||||
|
|
||||
| API: | JSON_TIMEZONE_ID
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.jsonql.field.expression | ||||
| Property specifying the JSONQL expression for the dataset field. | ||||
|
|
||||
| API: | PROPERTY_FIELD_EXPRESSION
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.band.evaluation.enabled | ||||
| Property that indicates whether the legacy band evaluation is enabled. | ||||
|
|
||||
| API: | PROPERTY_LEGACY_BAND_EVALUATION_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 6.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.compiler.source.included.fields | ||||
|
Property to specify fields that are to be included in classes generated for reports.
Starting with JasperReports 6.13.0, classes generated for reports only include fields that are used in expressions. This property can be used to specify fields to include in classes, even when not used in expressions. The property value can either be *, which means that all fields are to be included in classes, or a list of comma separated field names. |
||||
|
|
||||
| API: | PROPERTY_LEGACY_SOURCE_INCLUDED_FIELDS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.compiler.source.included.parameters | ||||
|
Property to specify parameters that are to be included in classes generated for reports.
Starting with JasperReports 6.13.0, classes generated for reports only include parameters that are used in expressions. This property can be used to specify parameters to include in classes, even when not used in expressions. The property value can either be *, which means that all parameters are to be included in classes, or a list of comma separated parameter names. |
||||
|
|
||||
| API: | PROPERTY_LEGACY_SOURCE_INCLUDED_PARAMETERS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.compiler.source.included.variables | ||||
|
Property to specify variables that are to be included in classes generated for reports.
Starting with JasperReports 6.13.0, classes generated for reports only include variables that are used in expressions. This property can be used to specify variables to include in classes, even when not used in expressions. The property value can either be *, which means that all variables are to be included in classes, or a list of comma separated variable names. |
||||
|
|
||||
| API: | PROPERTY_LEGACY_SOURCE_INCLUDED_VARIABLES
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.element.stretch.enabled | ||||
| Property that indicates whether a legacy stretch type for the element is enabled. | ||||
|
|
||||
| API: | PROPERTY_LEGACY_ELEMENT_STRETCH_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 6.2.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.expression.parser | ||||
| Property that specifies whether a legacy parser method should be used to parse this expression. Default value is false. | ||||
|
|
||||
| API: | PROPERTY_LEGACY_PARSER
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.frame.width.stretch.disabled | ||||
|
Flag to disable stretching the width of frames to accomodate containing elements
that become wider than their design time width at fill time (such as crosstabs
and subreports).
Before version 6.13.0, frame width was not increased in such cases, resulting in frames whose contents exceeded the frame width. Some exporters are not able to properly handle such frames, therefore starting from version 6.13.0 frames are automatically stretched horizontally. The property can be set to true to revert to the pre 6.13.0 behaviour. |
||||
|
|
||||
| API: | PROPERTY_FRAME_WIDTH_STRETCH_DISABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Frame Element | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.legacy.relative.path.enabled | ||||
|
Property that determines whether resource paths in subreports, style templates and data adapters
should be interpreted as relative to the master report location.
Starting with version 6.6.0, relative paths in subreports, style templates and data adapters are resolved as relative to the resource that contains them. Prior to version 6.6.0, relative paths in subreports, style templates and data adapters were resolved as relative to the master report resource. This property can be set to true to restore the pre 6.6.0 functionality. The default value of the property is false. The property should only be set when upgrading from a version older than 6.6.0 with a repository that relied on the fact that paths were relative to the master report. The property might be removed at some point in the future. |
||||
|
|
||||
| API: | PROPERTY_LEGACY_RELATIVE_PATH_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.markup.processor.factory.{markup} | ||||
|
Prefix for properties that map markup text processors.
Properties having this prefix indicate the MarkupProcessor implementation to be used when parsing a given styled text having the markup type specified in the property suffix. |
||||
|
|
||||
| API: | PROPERTY_MARKUP_PROCESSOR_FACTORY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 2.0.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.measure.simple.text | ||||
| Flag property that specifies whether a faster text measurer should be used for simple texts (text without markup or complex scripts). Default value is true. | ||||
|
|
||||
| API: | PROPERTY_MEASURE_SIMPLE_TEXTS
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.measure.simple.text.element.cache.size | ||||
| Property that specifies the size of the element font infos cache. Default value is 2000. | ||||
|
|
||||
| API: | PROPERTY_ELEMENT_CACHE_SIZE
|
|||
| Default: | 2000 | |||
| Scope: | Global | Context | |||
| Since: | 4.7.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.measure.simple.text.exact | ||||
Property that specifies the exact text measuring type. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_MEASURE_EXACT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 4.7.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.olap.field.mapping | ||||
| Property specifying the mapping for the dataset field in case an OLAP data source is used. This mapping was previously specified using the fieldDescription attribute, but using this custom property is now recommended. | ||||
|
|
||||
| API: | PROPERTY_FIELD_MAPPING
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.page.break.no.pagination | ||||
|
Determines how page breaks are to be handled in reports that are not paginated.
Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_PAGE_BREAK_NO_PAGINATION
|
|||
| Default: | ignore | |||
| Scope: | Global | Context | Report | Break Element | |||
| Since: | 5.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.parameter.evaluation.time | ||||
|
Specifies the default value for the getEvaluationTime() property of a dataset parameter.
Possible values are defined by the ParameterEvaluationTimeType enumeration.
|
||||
|
|
||||
| API: | PROPERTY_EVALUATION_TIME
|
|||
| Default: | Late | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.pattern.timezone | ||||
| Property that specifies the timezone ID for this element. | ||||
|
|
||||
| API: | PROPERTY_FORMAT_TIMEZONE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 5.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.executable.path | ||||
| Property specifying the path to the PhantomJS binary/executable file. | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_EXECUTABLE_PATH
|
|||
| Default: | N/A | |||
| Scope: | Global | |||
| Since: | 6.3.1 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.expiration.count | ||||
| Property specifying the number of jobs after PhantomJS will expire. Default value is 1000. | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_EXPIRATION_COUNT
|
|||
| Default: | 1000 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.expiration.time | ||||
| Property specifying the PhantomJS expiration time (in milliseconds). Default value is 1200000 (20 minutes). | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_EXPIRATION_TIME
|
|||
| Default: | 1200000 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.idle.ping.interval | ||||
| Property specifying the PhantomJS process idle ping interval (in milliseconds). Default value is 40000 (40 seconds). | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_IDLE_PING_INTERVAL
|
|||
| Default: | 40000 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.idle.timeout | ||||
| Property specifying the PhantomJS process idle timeout (in milliseconds). Default value is 300000 (5 minutes). | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_IDLE_TIMEOUT
|
|||
| Default: | 300000 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.max.process.count | ||||
| Property specifying the maximum number of processes in the PhantomJS pool. Default value is 8. | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_MAX_PROCESS_COUNT
|
|||
| Default: | 8 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.options.{arbitrary_suffix} | ||||
Property prefix used to identify a set of properties that store command options for the PhantomJS start command. For instance:
|
||||
|
|
||||
| API: | PROPERTY_OPTIONS_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | |||
| Since: | 6.8.1 | |||
|
|
||||
| NOTE: Properties with this prefix are not read from the configuration context. This FAQ shows the additional steps to follow in order to set them dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.pool.borrow.timeout | ||||
| Property specifying the PhantomJS pool process borrow timeout (in milliseconds). Default value is 120000 (2 minutes). If no process is available after this time an exception will be thrown. | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_POOL_BORROW_TIMEOUT
|
|||
| Default: | 120000 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.request.timeout | ||||
| Property specifying the PhantomJS request timeout (in milliseconds). Default value is 60000 (1 minute). | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_REQUEST_TIMEOUT
|
|||
| Default: | 60000 | |||
| Scope: | Global | |||
| Since: | 6.4.0 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.start.timeout | ||||
| Property specifying the PhantomJS process start timeout (in milliseconds). Default value is 10000 (10 seconds). | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_START_TIMEOUT
|
|||
| Default: | 10000 | |||
| Scope: | Global | |||
| Since: | 6.3.1 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.phantomjs.tempdir.path | ||||
| Property specifying the path to the directory of temporary files. | ||||
|
|
||||
| API: | PROPERTY_PHANTOMJS_TEMPDIR_PATH
|
|||
| Default: | N/A | |||
| Scope: | Global | |||
| Since: | 6.3.1 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.print.collapse.missing.bookmark.levels | ||||
| This property is used to determine whether missing bookmarks levels should be colapsed when the propety net.sf.jasperreports.print.create.bookmarks is set | ||||
|
|
||||
| API: | PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.print.create.bookmarks | ||||
| Property used to determine whether bookmarks should be collected at report generation time. | ||||
|
|
||||
| API: | PROPERTY_CREATE_BOOKMARKS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.print.keep.full.text | ||||
| Property used to determine whether the fill process must preserve the original text for text elements that are not able to fit their entire contents. When this property is set, the engine saves the original text in the JRPrintText print text object, along with the index at which the text is to be truncated by the print object. | ||||
|
|
||||
| API: | PROPERTY_PRINT_KEEP_FULL_TEXT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 2.0.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.print.transfer.{arbitrary_suffix} | ||||
| Properties having this prefix specify the properties to be transfered from report templates to print objects during the report filling. | ||||
|
|
||||
| API: | PROPERTIES_PRINT_TRANSFER_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.properties | ||||
| The name of the system property that specifies the properties file name. If the system property net.sf.jasperreports.properties has been set then the specified properties file is loaded. Otherwise the jasperreports.properties file is loaded, if found in the classpath. | ||||
|
|
||||
| API: | PROPERTIES_FILE
|
|||
| Default: | jasperreports.properties | |||
| Scope: | System | |||
| Since: | 1.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.property.evaluation.time | ||||
|
Specifies the default value for the getEvaluationTime() setting of a dataset property expression.
Possible values are defined by the PropertyEvaluationTimeType enumeration.
|
||||
|
|
||||
| API: | PROPERTY_EVALUATION_TIME
|
|||
| Default: | Early | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.query.chunk.token.separators | ||||
| Property that specifies the list of token separators characters for TYPE_CLAUSE_TOKENS tokenized query clauses. | ||||
|
|
||||
| API: | PROPERTY_CHUNK_TOKEN_SEPARATOR
|
|||
| Default: | , ; | | |||
| Scope: | Global | |||
| Since: | 2.0.5 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.query.executer.factory.{language} | ||||
| Properties with this prefix associate a query executer factory implementation with a query language. To obtain query executer factories, a property having the query language appended to this prefix is used to get the query executer factory name. | ||||
|
|
||||
| API: | QUERY_EXECUTER_FACTORY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 1.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.report.class.filter.enabled | ||||
|
Flag to enable filtering of classes that can be used in report expressions.
The list of allowed classes is configured via net.sf.jasperreports.report.class.whitelist.{arbitrary_name} properties. |
||||
|
|
||||
| API: | PROPERTY_PREFIX_CLASS_FILTER_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.report.class.whitelist.{arbitrary_name} | ||||
|
Defines a list of classes that are allowed in report expressions.
The property value should be a comma separated list of class names. Wildcards are supported in class names:
The net.sf.jasperreports.report.class.filter.enabled flag needs to be set in order for the whitelist to apply. |
||||
|
|
||||
| API: | PROPERTY_PREFIX_CLASS_WHITELIST
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 6.13.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.report.version | ||||
| Property that specifies the JasperReports version associated with this report. Report elements/attributes newer than this version will be skipped by the JRXML writers (see the JRXmlWriter class for example) during the report template generation. If not set, the version is considered to be the currenly deployed version. | ||||
|
|
||||
| API: | PROPERTY_REPORT_VERSION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.scale.font.step.limit | ||||
| Property used to specify the minimum amount when scaling down font size to adjust the content in text elements. This works in conjunction with the textAdjust property of text elements which needs to be set to ScaleFont value. | ||||
|
|
||||
| API: | PROPERTY_SCALE_FONT_STEP_LIMIT
|
|||
| Default: | 0.5 | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.sql.date.pattern.timezone | ||||
| Property that specifies the timezone ID for elements of type java.sql.Date in the report. | ||||
|
|
||||
| API: | PROPERTY_SQL_DATE_FORMAT_TIMEZONE
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | |||
| Since: | 6.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.sql.field.column.index | ||||
| Property specifying the 1-based index of the column in the JDBC result set to which the dataset field is mapped to, in case an SQL query is used. | ||||
|
|
||||
| API: | PROPERTY_FIELD_COLUMN_INDEX
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.sql.field.column.label | ||||
| Property specifying the label of the column in the JDBC result set to which the dataset field is mapped to, in case an SQL query is used. | ||||
|
|
||||
| API: | PROPERTY_FIELD_COLUMN_LABEL
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.sql.field.column.name | ||||
| Property specifying the name of the column in the JDBC result set to which the dataset field is mapped to, in case an SQL query is used. | ||||
|
|
||||
| API: | PROPERTY_FIELD_COLUMN_NAME
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.sql.time.pattern.timezone | ||||
| Property that specifies the timezone ID for elements of type java.sql.Time in the report. | ||||
|
|
||||
| API: | PROPERTY_SQL_TIME_FORMAT_TIMEZONE
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | |||
| Since: | 6.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.sql.timestamp.pattern.timezone | ||||
| Property that specifies the timezone ID for elements of type java.sql.Timestamp in the report. | ||||
|
|
||||
| API: | PROPERTY_SQL_TIMESTAMP_FORMAT_TIMEZONE
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | |||
| Since: | 6.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.backcolor | ||||
|
Property used to configure dynamic style background color for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related style background color of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BACKCOLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.bottom.pen.lineColor | ||||
|
Property used to configure dynamic pen line color for report element's bottom border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related bottom border pen line color in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_BOTTOM_PEN_LINE_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.bottom.pen.lineStyle | ||||
|
Property used to configure dynamic pen line style for report element's bottom border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related bottom border pen line style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_BOTTOM_PEN_LINE_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.bottom.pen.lineWidth | ||||
|
Property used to configure dynamic pen line width for report element's bottom border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related bottom border pen line width in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_BOTTOM_PEN_LINE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.bottomPadding | ||||
|
Property used to configure dynamic bottom padding style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related bottom padding style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_BOTTOM_PADDING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.left.pen.lineColor | ||||
|
Property used to configure dynamic pen line color for report element's left border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related left border pen line color in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_LEFT_PEN_LINE_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.left.pen.lineStyle | ||||
|
Property used to configure dynamic pen line style for report element's left border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related left border pen line style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_LEFT_PEN_LINE_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.left.pen.lineWidth | ||||
|
Property used to configure dynamic pen line width for report element's left border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related left border pen line width in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_LEFT_PEN_LINE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.leftPadding | ||||
|
Property used to configure dynamic left padding style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related left padding style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_LEFT_PADDING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.padding | ||||
|
Property used to configure dynamic padding style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related padding style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_PADDING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.pen.lineColor | ||||
|
Property used to configure dynamic pen line color for report element's border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related border pen line color in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_PEN_LINE_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.pen.lineStyle | ||||
|
Property used to configure dynamic pen line style for report element's border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related border pen line style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_PEN_LINE_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.pen.lineWidth | ||||
|
Property used to configure dynamic pen line width for report element's border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related border pen line width in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_PEN_LINE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.right.pen.lineColor | ||||
|
Property used to configure dynamic pen line color for report element's right border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related right border pen line color in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_RIGHT_PEN_LINE_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.right.pen.lineStyle | ||||
|
Property used to configure dynamic pen line style for report element's right border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related right border pen line style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_RIGHT_PEN_LINE_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.right.pen.lineWidth | ||||
|
Property used to configure dynamic pen line width for report element's right border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related right border pen line width in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_RIGHT_PEN_LINE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.rightPadding | ||||
|
Property used to configure dynamic right padding style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related right padding style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_RIGHT_PADDING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.top.pen.lineColor | ||||
|
Property used to configure dynamic pen line color for report element's top border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related top border pen line color in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_TOP_PEN_LINE_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.top.pen.lineStyle | ||||
|
Property used to configure dynamic pen line style for report element's top border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related top border pen line style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_TOP_PEN_LINE_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.top.pen.lineWidth | ||||
|
Property used to configure dynamic pen line width for report element's top border. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related top border pen line width in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_TOP_PEN_LINE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.box.topPadding | ||||
|
Property used to configure dynamic top padding style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related top padding style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BOX_TOP_PADDING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.evaluation.time.enabled | ||||
|
A flag the determines whether the style of an element is evaluated at
the element evaluation time, or at the time the band on which the element
is placed is rendered.
This applies to report elements that can have delayed evaluations times (such as text fields and images). When this flag is set to true, conditional style expressions of the style that is associated with the element are evaluated at the moment the element is set to evaluate, and the resulting style to the generated print element. |
||||
|
|
||||
| API: | PROPERTY_EVALUATION_TIME_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.fill | ||||
|
Property used to configure dynamic fill pattern style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related fill pattern style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_FILL
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.fontName | ||||
|
Property used to configure dynamic font name for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related font name in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FONT_NAME
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.fontSize | ||||
|
Property used to configure dynamic font size for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related font size in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FONT_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.forecolor | ||||
|
Property used to configure dynamic style forecolor for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related style forecolor of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FORECOLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.hAlign | ||||
|
Deprecated since v.6.0.2 - replaced with net.sf.jasperreports.style.hTextAlign
or net.sf.jasperreports.style.hImageAlign.
See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_HALIGN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.hImageAlign | ||||
|
Property used to configure dynamic horizontal image alignment for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related horizontal image alignment of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_H_IMAGE_ALIGN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.hTextAlign | ||||
|
Property used to configure dynamic horizontal text alignment for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related horizontal text alignment of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_H_TEXT_ALIGN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.isBlankWhenNull | ||||
|
Property used to specify whether null content of a report element should be rendered as blank space. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the value of isBlankWhenNull feature of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_BLANK_WHEN_NULL
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.isBold | ||||
|
Boolean property used to configure dynamic font bold style for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related font bold style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FONT_BOLD
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.isItalic | ||||
|
Boolean property used to configure dynamic font italic style for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related font italic style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FONT_ITALIC
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.isPdfEmbedded | ||||
|
Boolean property used to specify whether the font should be embedded in the PDF output. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related isPdfEmbedded style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_PDF_EMBEDDED
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.isStrikeThrough | ||||
|
Boolean property used to configure dynamic font strike through style for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related font strike through style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FONT_STRIKETHROUGH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.isUnderline | ||||
|
Boolean property used to configure dynamic font underline style for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related font underline style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FONT_UNDERLINE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.markup | ||||
|
Property used to configure dynamic text markup style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related text markup style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_MARKUP
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.mode | ||||
|
Property used to configure dynamic style mode for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related style mode of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_MODE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.firstLineIndent | ||||
|
Property used to configure dynamic paragraph first line indent (in pixels) for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related paragraph first line indent of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_FIRST_LINE_INDENT
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.leftIndent | ||||
|
Property used to configure dynamic paragraph left indent (in pixels) for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related paragraph left indent of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_LEFT_INDENT
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.lineSpacing | ||||
|
Property used to configure dynamic paragraph line spacing style for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related line spacing style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_LINE_SPACING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.lineSpacingSize | ||||
|
Property used to configure dynamic paragraph line spacing size for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related paragraph line spacing size of the element. This value is used in combination with the size-dependent line spacings:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_LINE_SPACING_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.rightIndent | ||||
|
Property used to configure dynamic paragraph right indent (in pixels) for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related paragraph right indent of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_RIGHT_INDENT
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.spacingAfter | ||||
|
Property used to configure dynamic spacing after paragraph (in pixels) for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related spacing after paragraph style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_SPACING_AFTER
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.spacingBefore | ||||
|
Property used to configure dynamic spacing before paragraph (in pixels) for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related spacing before paragraph style of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_SPACING_BEFORE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.paragraph.tabStopWidth | ||||
|
Property used to configure dynamic paragraph tab stop width (in pixels) for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related paragraph tab stop width of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_TABSTOP_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.pattern | ||||
|
Property used to configure dynamic format pattern for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related format pattern of the text element. Also, the value of this property is overridden by the <patternExpression/>, if present. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_PATTERN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.pdfEncoding | ||||
|
Property used to configure dynamic PDF encoding character set for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related PDF encoding character set in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_PDF_ENCODING
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.pdfFontName | ||||
|
Property used to configure dynamic PDF font name for text elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related PDF font name in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_PDF_FONT_NAME
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.pen.lineColor | ||||
|
Property used to configure dynamic pen line color for shape elements (line, rectangle, ellipse). It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related pen line color in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_PEN_LINE_COLOR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.pen.lineStyle | ||||
|
Property used to configure dynamic pen line style for shape elements (line, rectangle, ellipse). It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related pen line style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_PEN_LINE_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.pen.lineWidth | ||||
|
Property used to configure dynamic pen line width for shape elements (line, rectangle, ellipse). It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related pen line width in the element style. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_PEN_LINE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.radius | ||||
|
Property used to configure dynamic corner radius for rectangle elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related corner radius of the element. See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_RADIUS
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.rotation | ||||
|
Property used to configure dynamic text or image rotation for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related text rotation of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_ROTATION
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.scaleImage | ||||
|
Property used to configure dynamic scale image style for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related scale image style of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_SCALE_IMAGE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.vAlign | ||||
|
Deprecated since v.6.0.2 - replaced with net.sf.jasperreports.style.vTextAlign
or net.sf.jasperreports.style.vImageAlign.
See also this page. |
||||
|
|
||||
| API: | STYLE_PROPERTY_VALIGN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.vImageAlign | ||||
|
Property used to configure dynamic vertical image alignment for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related vertical image alignment of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_V_IMAGE_ALIGN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.style.vTextAlign | ||||
|
Property used to configure dynamic vertical text alignment for report elements. It is declared in the
PropertyStyleProvider class
(which is the default JR implementation of the StyleProvider interface).
If such a property is found at element level, its value will override the related vertical text alignment of the element. Possible values are:
|
||||
|
|
||||
| API: | STYLE_PROPERTY_V_TEXT_ALIGN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.styles.inherit.from.default | ||||
| Specifies whether report styles that do not have a parent specified would rely on the default style as parent for property inheritance. Before version 6.2.1, styles without parent were not inheriting from default style. | ||||
|
|
||||
| API: | PROPERTY_STYLES_INHERIT_FROM_DEFAULT
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 6.2.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.subreport.generate.rectangle | ||||
| Property used to specify when rectangle elements should be generated for subreports during the report filling. If the property value is always, rectangle elements will be always generated, otherwise they will be created only if the subreport element is not transparent or it has properties. | ||||
|
|
||||
| API: | PROPERTY_SUBREPORT_GENERATE_RECTANGLE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | Element | |||
| Since: | 6.0.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.subreport.runner.factory | ||||
| Property specifying the JRSubreportRunnerFactory implementation to use for creating subreport runners. | ||||
|
|
||||
| API: | SUBREPORT_RUNNER_FACTORY
|
|||
| Default: | net.sf.jasperreports.engine.fill.JRThreadSubreportRunnerFactory | |||
| Scope: | Global | Context | |||
| Since: | 1.2.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.template.xml.parser.factory | ||||
|
Property that gives a parser factory class which should be used for parsing style templates.
By default, this property is set to use TemplateSaxParserFactory as style templates parser factory. |
||||
|
|
||||
| API: | PROPERTY_TEMPLATE_PARSER_FACTORY
|
|||
| Default: | net.sf.jasperreports.engine.xml.TemplateSaxParserFactory | |||
| Scope: | Global | Context | |||
| Since: | 6.3.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.text.measurer.factory | ||||
| This property can either hold the name of a text measurer factory class, or hold an alias of a text measurer factory class property. One can write an implementation of the JRTextMeasurerFactory interface. This will usually imply writing a custom implementation of the JRTextMeasurer interface, either from scratch or by extending the default implementation (TextMeasurer). A text measurer is responsible with computing text layout attributes (in the form of JRMeasuredText instances) for report text elements. The measurer is only used at report fill time, the exporters will use the computed text layout attributes. Then one can define an alias of the text measurer factory implementation by declaring a property named net.sf.jasperreports.text.measurer.factory.{alias} which has the name of the factory class as value. The net.sf.jasperreports.text.measurer.factory property is set to a defined alias or a full factory class name. The factory class is used to instantiate text measurers for report text elements, which are then used to compute the text layout attributes. | ||||
|
|
||||
| API: | PROPERTY_TEXT_MEASURER_FACTORY
|
|||
| Default: | net.sf.jasperreports.engine.fill.TextMeasurerFactory | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 2.0.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.text.pattern.date | ||||
|
Provides a default pattern to be used for java.sql.Date values.
Locale specific values can be configured by appending _<locale code> to the property name. The property can be set at global/JasperReports context level. |
||||
|
|
||||
| API: | PROPERTY_PATTERN_DATE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.text.pattern.datetime | ||||
|