Skip to main content

JasperReports - Configuration Reference

Data Source / Query Executer
net.sf.jasperreports.csv.column.names.{arbitrary_name}
net.sf.jasperreports.csv.date.pattern
net.sf.jasperreports.csv.encoding
net.sf.jasperreports.csv.field.delimiter
net.sf.jasperreports.csv.locale.code
net.sf.jasperreports.csv.number.pattern
net.sf.jasperreports.csv.record.delimiter
net.sf.jasperreports.csv.source
net.sf.jasperreports.csv.timezone.id
net.sf.jasperreports.ejbql.query.hint.{hint}
net.sf.jasperreports.ejbql.query.page.size
net.sf.jasperreports.hql.clear.cache
net.sf.jasperreports.hql.field.mapping.descriptions
net.sf.jasperreports.hql.query.list.page.size
net.sf.jasperreports.hql.query.run.type
net.sf.jasperreports.jdbc.concurrency
net.sf.jasperreports.jdbc.fetch.size
net.sf.jasperreports.jdbc.holdability
net.sf.jasperreports.jdbc.max.field.size
net.sf.jasperreports.jdbc.result.set.type
net.sf.jasperreports.query.chunk.token.separators
net.sf.jasperreports.query.executer.factory.{language}
net.sf.jasperreports.xpath.executer.factory

Report Compilation
net.sf.jasperreports.compiler.{language}
net.sf.jasperreports.compiler.classpath
net.sf.jasperreports.compiler.keep.java.file
net.sf.jasperreports.compiler.temp.dir
net.sf.jasperreports.compiler.xml.validation
net.sf.jasperreports.compiler.xml.parser.cache.schemas
net.sf.jasperreports.compiler.xml.parser.factory

Report Design
net.sf.jasperreports.allow.element.negative.width
net.sf.jasperreports.allow.element.negative.y
net.sf.jasperreports.allow.element.overlap

Report Filling
net.sf.jasperreports.band.split.type
net.sf.jasperreports.chart.render.type
net.sf.jasperreports.chart.renderer.factory.{render_type}
net.sf.jasperreports.chart.theme
net.sf.jasperreports.default.font.name
net.sf.jasperreports.default.font.size
net.sf.jasperreports.evaluator.class.reference.fix.enabled
net.sf.jasperreports.image.encoder
net.sf.jasperreports.image.reader
net.sf.jasperreports.markup.processor.factory.{markup}
net.sf.jasperreports.print.keep.full.text
net.sf.jasperreports.text.truncate.at.char
net.sf.jasperreports.text.truncate.suffix
net.sf.jasperreports.text.measurer.factory
net.sf.jasperreports.text.save.line.breaks
net.sf.jasperreports.style.evaluation.time.enabled
net.sf.jasperreports.subreport.runner.factory
net.sf.jasperreports.virtualizer.files.delete.on.exit

Governors
net.sf.jasperreports.governor.max.pages.enabled
net.sf.jasperreports.governor.max.pages
net.sf.jasperreports.governor.timeout.enabled
net.sf.jasperreports.governor.timeout

Crosstabs
net.sf.jasperreports.crosstab.bucket.measure.limit
net.sf.jasperreports.crosstab.cell.type
net.sf.jasperreports.crosstab.cell.row.span
net.sf.jasperreports.crosstab.cell.column.span
net.sf.jasperreports.crosstab.ignore.width

Chart Themes
net.sf.jasperreports.chart.dial.value.display.visible
net.sf.jasperreports.chart.dial.label
net.sf.jasperreports.chart.domain.axis.tick.count
net.sf.jasperreports.chart.domain.axis.tick.interval
net.sf.jasperreports.chart.range.axis.tick.count
net.sf.jasperreports.chart.range.axis.tick.interval

Report Export
net.sf.jasperreports.default.pdf.font.name
net.sf.jasperreports.default.pdf.encoding
net.sf.jasperreports.default.pdf.embedded
net.sf.jasperreports.export.{format}.exclude.origin.{suffix}.{arbitrary_name}
net.sf.jasperreports.export.{format}.exclude.origin.keep.first.{suffix}.{arbitrary_name}
net.sf.jasperreports.export.filter.factory.{filter_element}
net.sf.jasperreports.export.default.filter.factory
net.sf.jasperreports.export.{arbitrary_name}.default.filter.factory
net.sf.jasperreports.export.character.encoding
net.sf.jasperreports.export.legacy.border.offset
net.sf.jasperreports.export.csv.column.name
net.sf.jasperreports.export.csv.column.names
net.sf.jasperreports.export.csv.data
net.sf.jasperreports.export.csv.field.delimiter
net.sf.jasperreports.export.csv.record.delimiter
net.sf.jasperreports.export.csv.repeat.value
net.sf.jasperreports.export.csv.write.header
net.sf.jasperreports.export.docx.flexible.row.height
net.sf.jasperreports.export.docx.frames.as.nested.tables
net.sf.jasperreports.export.docx.hidden.text
net.sf.jasperreports.export.graphics2d.min.job.size
net.sf.jasperreports.export.ignore.page.margins
net.sf.jasperreports.export.html.accessible
net.sf.jasperreports.export.html.frames.as.nested.tables
net.sf.jasperreports.export.html.id
net.sf.jasperreports.export.html.remove.emtpy.space.between.rows
net.sf.jasperreports.export.html.size.unit
net.sf.jasperreports.export.html.using.images.to.align
net.sf.jasperreports.export.html.white.page.background
net.sf.jasperreports.export.html.wrap.break.word
net.sf.jasperreports.export.html.flush.output
net.sf.jasperreports.export.jxl.use.temp.file
net.sf.jasperreports.export.jxl.cell.complex.format
net.sf.jasperreports.export.parameters.override.report.hints
net.sf.jasperreports.export.pdf.128.bit.key
net.sf.jasperreports.export.pdf.compressed
net.sf.jasperreports.export.pdf.create.batch.mode.bookmarks
net.sf.jasperreports.export.pdf.encrypted
net.sf.jasperreports.export.pdf.font.{arbitrary_name}
net.sf.jasperreports.export.pdf.fontdir.{arbitrary_name}
net.sf.jasperreports.export.pdf.force.linebreak.policy
net.sf.jasperreports.export.pdf.force.svg.shapes
net.sf.jasperreports.export.pdf.javascript
net.sf.jasperreports.export.pdf.owner.password
net.sf.jasperreports.export.pdf.print.scaling
net.sf.jasperreports.export.pdf.user.password
net.sf.jasperreports.export.pdf.version
net.sf.jasperreports.export.pdf.collapse.missing.bookmark.levels
net.sf.jasperreports.export.pdf.tagged
net.sf.jasperreports.export.pdf.tag.table
net.sf.jasperreports.export.pdf.tag.tr
net.sf.jasperreports.export.pdf.tag.th
net.sf.jasperreports.export.pdf.tag.td
net.sf.jasperreports.export.pdf.tag.h1
net.sf.jasperreports.export.pdf.tag.h2
net.sf.jasperreports.export.pdf.tag.h3
net.sf.jasperreports.export.pdf.tag.colspan
net.sf.jasperreports.export.pdf.tag.rowspan
net.sf.jasperreports.export.pdf.tag.language
net.sf.jasperreports.export.text.character.height
net.sf.jasperreports.export.text.character.width
net.sf.jasperreports.export.text.page.height
net.sf.jasperreports.export.text.page.width
net.sf.jasperreports.export.xls.break.after.row
net.sf.jasperreports.export.xls.break.before.row
net.sf.jasperreports.export.xls.cell.hidden
net.sf.jasperreports.export.xls.cell.locked
net.sf.jasperreports.export.xls.collapse.row.span
net.sf.jasperreports.export.xls.create.custom.palette
net.sf.jasperreports.export.xls.detect.cell.type
net.sf.jasperreports.export.xls.fit.height
net.sf.jasperreports.export.xls.fit.width
net.sf.jasperreports.export.xls.font.size.fix.enabled
net.sf.jasperreports.export.xls.formula
net.sf.jasperreports.export.xls.ignore.cell.background
net.sf.jasperreports.export.xls.ignore.cell.border
net.sf.jasperreports.export.xls.ignore.graphics
net.sf.jasperreports.export.xls.image.border.fix.enabled
net.sf.jasperreports.export.xls.max.rows.per.sheet
net.sf.jasperreports.export.xls.one.page.per.sheet
net.sf.jasperreports.export.xls.password
net.sf.jasperreports.export.xls.remove.empty.space.between.columns
net.sf.jasperreports.export.xls.remove.empty.space.between.rows
net.sf.jasperreports.export.xls.sheet.direction
net.sf.jasperreports.export.xls.sheet.footer.center
net.sf.jasperreports.export.xls.sheet.footer.left
net.sf.jasperreports.export.xls.sheet.footer.right
net.sf.jasperreports.export.xls.sheet.header.center
net.sf.jasperreports.export.xls.sheet.header.left
net.sf.jasperreports.export.xls.sheet.header.right
net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name}
net.sf.jasperreports.export.xls.white.page.background
net.sf.jasperreports.export.xls.wrap.text
net.sf.jasperreports.export.xml.end.page.index
net.sf.jasperreports.export.xml.page.count
net.sf.jasperreports.export.xml.start.page.index
net.sf.jasperreports.export.xml.validation

JasperReports Extensions
net.sf.jasperreports.extension.{registry_id}.{property_suffix}
net.sf.jasperreports.extension.registry.factory.{arbitrary_name}
net.sf.jasperreports.extensions.registry.class

Other
net.sf.jasperreports.awt.check.available.printers
net.sf.jasperreports.awt.ignore.missing.font
net.sf.jasperreports.awt.superscript.fix.enabled
net.sf.jasperreports.big.decimal.minimum.precision
net.sf.jasperreports.file.buffer.os.memory.threshold
net.sf.jasperreports.jdk.glyph.fix.text.measurer.attempts
net.sf.jasperreports.jdk.glyph.fix.text.measurer.sleep
net.sf.jasperreports.jdk.glyph.fix.text.measurer.catch.empty.stacktrace
net.sf.jasperreports.properties
net.sf.jasperreports.viewer.render.buffer.max.size







top

net.sf.jasperreports.allow.element.negative.width
A property that determines whether elements having negative width values are allowed. 
If this value is set to false, the report is verified not to contain elements with negative width values. This is useful when the report is meant to be exported to grid-based formats such as HTML, XLS or CSV, which might enter an infinite loop. Having elements with negative widths does not make sense, but allowing this is a workaround in case older report templates still need to pass validation at report compile time.

APIPROPERTY_ALLOW_ELEMENT_NEGATIVE_WIDTH
Defaultfalse
ScopeGlobal | Report
Since3.7.1

top

net.sf.jasperreports.allow.element.negative.y
Property that determines whether elements positioned at negative Y offsets on bands, frames and other element containers are allowed in a report. 
Elements placed at negative Y offsets can cause unexpected problems in grid-based exporters where they can overlap elements from previous bands/element containers. 
If the property is set to false, elements in the report are verified to have positive Y offsets. Otherwise, no check is performed on element Y offsets.

APIPROPERTY_ALLOW_ELEMENT_NEGATIVE_Y
Defaulttrue
ScopeGlobal | Report | Element
Since3.7.3

top

net.sf.jasperreports.allow.element.overlap
A property that determines whether elements are allowed to overlap. 
If this value is set to false, the report is verified not to contain elements that overlap. This is useful when the report is meant to be exported to grid-based formats such as HTML, XLS or CSV. Setting this property to false ensures that element overlap issues are caught at report compile time. 
Additionally, when this property is set to false false, the report is verified not to have any content in the background section as this content would likely be overlapped by other sections and would not show in grid-based exporters. 
By default, the property is set to true which means that no element overlap checks are performed. 
The property can be set at the following levels:
  • At global level (in jasperreports.properties) to provide a default value.
  • At report level, to indicate whether element overlap checks are to be performed for the report. If not set, the global property value is used.
  • At report element level to specify that the particular element is allowed to overlap or be overlapped by other elements, when the report or global property determines report element overlap verification. The element level property is only effective when set to true; setting the property to false does not make the verifier check for overlaps when the report is not set to be checked for element overlaps.

Note that print when expressions or export filters cannot be taken into consideration while checking for overlapping elements as this check is performed at report compilation time. If a report contains two elements that overlap but have print when expressions that guarantee that only one of them will be printed, or if export filters are in place to exclude one of the elements, one of them should be explicitly marked to allow element overlap when the report is configured to check for overlaps.

APIPROPERTY_ALLOW_ELEMENT_OVERLAP
Defaulttrue
ScopeGlobal | Report
Since3.5.0

top

net.sf.jasperreports.awt.check.available.printers
Property whose value is used to check the availability of printers accepting jobs.

APIPROPERTY_CHECK_AVAILABLE_PRINTERS
Defaulttrue
ScopeGlobal | Report
Since3.7.3

top

net.sf.jasperreports.awt.ignore.missing.font
When set to false, it forces the engine to check if the font used as value for the fontName attribute inside the report template is available either through the JasperReports font extension mechanism or as a JVM accesible font, and raise a JRFontNotFoundException exception, if this font is not available.

APIPROPERTY_AWT_IGNORE_MISSING_FONT
Defaultfalse
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.awt.superscript.fix.enabled

APIPROPERTY_AWT_SUPERSCRIPT_FIX_ENABLED
DefaultN/A
ScopeGlobal
Since3.1.3

top

net.sf.jasperreports.band.split.type
Specifies the default split type for bands. See the splitType attribute of the report band.

APIPROPERTY_SPLIT_TYPE
Defaultfalse
ScopeGlobal | Report
Since3.5.2

top

net.sf.jasperreports.big.decimal.minimum.precision
An integer property that provides the minimum precision to be used for java.math.BigDecimal division operations. Important note: this property is only effective when Java 1.5 or newer is used. See BigDecimalUtils for details.

APIPROPERTY_MINIMUM_PRECISION
Default16
ScopeGlobal
Since3.5.4

top

net.sf.jasperreports.chart.dial.label
Property containing the label text attached to the measured value in a meter or thermometer chart.

APIPROPERTY_DIAL_LABEL
DefaultN/A
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.dial.value.display.visible
Property specifying whether the measured value should be rendered visible on a meter or thermometer chart's display zone.

APIPROPERTY_DIAL_VALUE_DISPLAY_VISIBLE
Defaultfalse
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.domain.axis.tick.count
Property specifying the number of ticks on a domain value axis. If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis.

APIPROPERTY_DOMAIN_AXIS_TICK_COUNT
DefaultN/A
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.domain.axis.tick.interval
Property specifying the interval between 2 consecutive ticks on a domain value axis. If the net.sf.jasperreports.chart.domain.axis.tick.count property is set, this interval will be neglected. 
If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis. 
By default it is not set.

APIPROPERTY_DOMAIN_AXIS_TICK_INTERVAL
DefaultN/A
ScopeElement
Since3.1.4

top

net.sf.jasperreports.chart.range.axis.tick.count
Property specifying the number of ticks on a range value axis. If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis. 
By default it is not set.

APIPROPERTY_RANGE_AXIS_TICK_COUNT
DefaultN/A
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.range.axis.tick.interval
Property specifying the interval between 2 consecutive ticks on a range value axis. If the net.sf.jasperreports.chart.range.axis.tick.count property is set, this interval will be neglected. 
If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis. 
By default it is not set.

APIPROPERTY_RANGE_AXIS_TICK_INTERVAL
DefaultN/A
ScopeElement
Since3.1.4

top

net.sf.jasperreports.chart.render.type
Specifies the default render type for charts. See the renderType attribute of the chart elements.

APIPROPERTY_CHART_RENDER_TYPE
Defaultdraw
ScopeGlobal | Report
Since2.0.5

top

net.sf.jasperreports.chart.renderer.factory.{render_type}
Prefix for properties that map chart renderers. 
Properties having this prefix indicate the JRRenderable implementation to be used when rendering a chart element having a rendering type specified in the property suffix.

APIPROPERTY_CHART_RENDER_TYPE
DefaultN/A
ScopeGlobal
Since2.0.5

top

net.sf.jasperreports.chart.theme
Property used to specify the chart theme name.

APIPROPERTY_CHART_THEME
Defaultdefault
ScopeGlobal | Report
Since3.1.0

top

net.sf.jasperreports.compiler.{language}
Prefix for properties that map report compilers to expression languages. 
Properties having this prefix indicate the JRCompiler implementation to be used when compiling report designs that rely on the expression language specified as property suffix.

APICOMPILER_PREFIX
Defaultnet.sf.jasperreports.engine.design.JRJdtCompiler, if available; net.sf.jasperreports.engine.design.JRJdk13Compiler otherwise. Java is considered the default expression language.
ScopeGlobal
Since2.0.1

top

net.sf.jasperreports.compiler.classpath
Property specifying the classpath used by the report compiler during the compilation process.

APICOMPILER_CLASSPATH
DefaultSystem.getProperty("java.class.path")
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.compiler.keep.java.file
Property specifying whether the temporary source file created by the report compiler should be kept or deleted after the report compilation process ended.

APICOMPILER_KEEP_JAVA_FILE
Defaultfalse
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.compiler.temp.dir
Property specifying the temporary working directory to be used by the report compiler.

APICOMPILER_TEMP_DIR
DefaultSystem.getProperty("user.dir")
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.compiler.xml.parser.cache.schemas
Property that determines whether XML schemas/grammars are to be cached so that they are not read/initialized each time a report is compiled. 
Currently, setting this property is only effective when a Xerces XML parser is used (either a stock one from Apache or one embedded into a SUN JDK).

APIPROPERTY_CACHE_SCHEMAS
Defaulttrue
ScopeGlobal
Since3.1.0

top

net.sf.jasperreports.compiler.xml.parser.factory
Property that gives a parser factory class which should be used for parsing JRXMLs. 
By default, this property is set to use JRReportSaxParserFactory as report parser factory.

APIPROPERTY_REPORT_PARSER_FACTORY
Defaultnet.sf.jasperreports.engine.xml.JRReportSaxParserFactory
ScopeGlobal
Since3.1.0

top

net.sf.jasperreports.compiler.xml.validation
Property that forces the XML validation of the report template file before compiling.

APICOMPILER_XML_VALIDATION
Defaulttrue
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.crosstab.bucket.measure.limit
Property that limits the number of buckets in a crosstab, to avoid out of memory errors.

APIPROPERTY_BUCKET_MEASURE_LIMIT
Default0
ScopeGlobal
Since1.3.4

top

net.sf.jasperreports.crosstab.cell.column.span
Property that provides the crosstab column span of a print frame. (FIXME not a user defined property)

APIPROPERTY_COLUMN_SPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.crosstab.cell.row.span
Property that provides the crosstab row span of a print frame. (FIXME not a user defined property)

APIPROPERTY_ROW_SPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.crosstab.cell.type
Property that provides the type of the cell that generated a print frame. (FIXME not a user defined property) 
The property value is one of

APIPROPERTY_TYPE
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.crosstab.ignore.width
Property that provides the default value for the crosstab ignoreWidth attribute.

APIPROPERTY_IGNORE_WIDTH
Defaultfalse
ScopeGlobal | Report
Since3.5.3

top

net.sf.jasperreports.csv.column.names.{arbitrary_name}
Property having this prefix hold the comma separated names of the columns to be extracted from the CSV source.

APICSV_COLUMN_NAMES
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.date.pattern
Property holding the value of the date format pattern to be used when parsing the CSV data.

APICSV_DATE_PATTERN
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.encoding

APICSV_ENCODING
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.field.delimiter

APICSV_FIELD_DELIMITER
Default,
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.locale.code

APICSV_LOCALE_CODE
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.number.pattern
Property holding the value of the number format pattern to be used when parsing the CSV data.

APICSV_NUMBER_PATTERN
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.record.delimiter

APICSV_RECORD_DELIMITER
Default\n
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.source

APICSV_SOURCE
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.timezone.id

APICSV_TIMEZONE_ID
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.default.font.name
Specifies the default font name when no default font is explicitly given in a report.

APIDEFAULT_FONT_NAME
DefaultSansSerif
ScopeGlobal
Since1.3.0

top

net.sf.jasperreports.default.font.size
Specifies the default font size when no default font size is explicitly given in a report.

APIDEFAULT_FONT_SIZE
Default10
ScopeGlobal
Since1.3.0

top

net.sf.jasperreports.default.pdf.embedded
Property indicating the default PDF font embedding behavior, if not specified in the report template or at export time.

APIDEFAULT_PDF_EMBEDDED
Defaultfalse
ScopeGlobal
Since1.3.0

top

net.sf.jasperreports.default.pdf.encoding
Property indicating the default PDF encoding, if not specified in the report template or at export time.

APIDEFAULT_PDF_ENCODING
DefaultCp1252
ScopeGlobal
Since1.3.0

top

net.sf.jasperreports.default.pdf.font.name
Property indicating the default PDF font, if not specified in the report template or at export time.

APIDEFAULT_PDF_FONT_NAME
DefaultHelvetica
ScopeGlobal
Since1.3.0

top

net.sf.jasperreports.ejbql.query.hint.{hint}
Properties with this prefix introduce JPA implementation specific EJBQL query hints to be used by the JRJpaQueryExecuter. The suffix is the name of the hint, as documented by the specific JPA implementation.

APIPROPERTY_JPA_QUERY_HINT_PREFIX
DefaultN/A
ScopeDataset
Since1.2.3

top

net.sf.jasperreports.ejbql.query.page.size
Property specifying the number of result rows to be retrieved at once. Result pagination is implemented by javax.persistence.Query.setFirstResult() andjavax.persistence.Query.setMaxResults()
By default, all the rows are retrieved (no result pagination is performed).

APIPROPERTY_JPA_QUERY_PAGE_SIZE
Default0
ScopeGlobal | Dataset
Since1.2.3

top

net.sf.jasperreports.evaluator.class.reference.fix.enabled
Property that indicates whether a legacy fix for a JVM issue related to evaluator classes generated by JasperReports is enabled. The fix is enabled by default. 
Due to the fix, the garbage collector might not be able to collect a classloader that loaded JasperReports classes. This would be inconvenient in scenarios in which JasperReports classes are repeatedly loaded by different classloaders, e.g. when JasperReports is part of the classpath of a web application which is often reloaded. In such scenarios, set this property to false.

APIPROPERTY_EVALUATOR_CLASS_REFERENCE_FIX_ENABLED
Defaulttrue
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.export.{arbitrary_name}.default.filter.factory
Property that gives the default filter factory for a specific exporter. Contains the property prefix net.sf.jasperreports.export. concatenated with an arbitrary name indicating the exporter type and the property suffix default.filter.factory
For instance, the default filter factory for XLS exporters is net.sf.jasperreports.export.xls.default.filter.factory. If this property is not defined for a specific exporter, the generic exporter factory given by PROPERTY_DEFAULT_FILTER_FACTORY is used.

APIPROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY
DefaultPROPERTY_DEFAULT_FILTER_FACTORY 's default value.
ScopeGlobal
Since3.0.1

top

net.sf.jasperreports.export.{format}.exclude.origin.{suffix}.{arbitrary_name}
Properties with this syntax are used by the exporters to create default exporter filter instances that filter out content based on element origin information. Possible values for the {format} token are pdfhtmlxlsrtfodtcsv and txt. The {suffix} token can be bandgroup or report
See this FAQ for more details about filtering out content while exporting.

APIN/A
DefaultN/A
ScopeGlobal | Report
Since

top

net.sf.jasperreports.export.{format}.exclude.origin.keep.first.{suffix}.{arbitrary_name}
Properties with this syntax are used by the exporters to create default exporter filter instances that filter out content based on element origin information. Possible values for the {format} token are pdfhtmlxlsrtfodtcsv and txt. The {suffix} token can be bandgroup or report
See this FAQ for more details about filtering out content while exporting.

APIN/A
DefaultN/A
ScopeGlobal | Report
Since

top

net.sf.jasperreports.export.character.encoding
Property whose value is used as default for the CHARACTER_ENCODING export parameter, meaning the character encoding used for export.

APIPROPERTY_CHARACTER_ENCODING
DefaultUTF-8
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.csv.column.name

APIPROPERTY_COLUMN_NAME
DefaultN/A
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.csv.column.names

APIPROPERTY_COLUMN_NAMES
DefaultN/A
ScopeReport
Since4.0.0

top

net.sf.jasperreports.export.csv.data

APIPROPERTY_DATA
DefaultN/A
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.csv.field.delimiter
Property whose value is used as default for the FIELD_DELIMITER CSV export parameter. Contains the character or sequence of characters used to delimit two fields on the same record.

APIPROPERTY_FIELD_DELIMITER
Default,
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.csv.record.delimiter
Property whose value is used as default for the RECORD_DELIMITER CSV export parameter. Contains the character or sequence of characters used to delimit two records.

APIPROPERTY_RECORD_DELIMITER
Default\n
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.csv.repeat.value

APIPROPERTY_REPEAT_VALUE
Defaultfalse
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.csv.write.header

APIPROPERTY_WRITE_HEADER
Default
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.default.filter.factory
A property that gives the generic default filter factory class name.

APIPROPERTY_DEFAULT_FILTER_FACTORY
Defaultnet.sf.jasperreports.engine.export.DefaultExporterFilterFactory
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.docx.flexible.row.height
This property serves as default value for the FLEXIBLE_ROW_HEIGHT export parameter. If set to false, the table rows do not increase in height automatically and the user has to enlarge them manually.

APIPROPERTY_FRAMES_AS_NESTED_TABLES
Defaultfalse
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.docx.frames.as.nested.tables
This property serves as default value for the FRAMES_AS_NESTED_TABLES export parameter. If set to false, the frame content will be integrated into the master/page table.

APIPROPERTY_FRAMES_AS_NESTED_TABLES
Defaulttrue
ScopeGlobal | Report | Element
Since3.5.3

top

net.sf.jasperreports.export.docx.hidden.text
This property is used to mark text elements as being hidden either for printing or on-screen display.

APIPROPERTY_HIDDEN_TEXT
Defaultfalse
ScopeElement
Since3.7.6

top

net.sf.jasperreports.export.filter.factory.{filter_element}
A set of properties that are used to register filter factories. They all contain the fixed prefix net.sf.jasperreports.export.filter.factory. and a suffix indicating the considered filter element. 
For example: net.sf.jasperreports.export.filter.factory.origin indicates an element origin filter factory.

APIPROPERTY_EXPORTER_FILTER_FACTORY_PREFIX
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.graphics2d.min.job.size
Property that provides a default value for the MINIMIZE_PRINTER_JOB_SIZE Graphics2D exporter parameter. This flag controls the use of an AWT rendering fix which causes the printer job size to be reduced when the exporter draws onto a printer graphic context.

APIMINIMIZE_PRINTER_JOB_SIZE
Defaulttrue
ScopeGlobal | Report
Since1.2.8

top

net.sf.jasperreports.export.html.accessible
Configuration property that determines the exporter to produce accessible HTML.

APIPROPERTY_ACCESSIBLE
Defaultfalse
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.html.flush.output
A boolean property that determines whether the HTML exporter should flush the output stream after writing the HTML content to it. It serves as default value for the FLUSH_OUTPUT export parameter.

APIPROPERTY_FLUSH_OUTPUT
Defaulttrue
ScopeGlobal | Report
Since3.7.1

top

net.sf.jasperreports.export.html.frames.as.nested.tables
This property serves as default value for the FRAMES_AS_NESTED_TABLES export parameter. If set to false, the frame content will be integrated into the master/page HTML table.

APIPROPERTY_FRAMES_AS_NESTED_TABLES
Defaulttrue
ScopeGlobal | Report | Element
Since2.0.1

top

net.sf.jasperreports.export.html.id
Property used to specify the value of the ID attribute of elements when exported to HTML and XHTML formats. The value of this property will be used as the value for the id attribute of the  tag for the element when exported to HTML and/or the id attribute of the  or 
 tag for the element, when exported to XHTML/CSS.

APIPROPERTY_HTML_ID
DefaultN/A
ScopeElement
Since3.7.0

top

net.sf.jasperreports.export.html.remove.emtpy.space.between.rows
Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS export flag. If set to true, blank lines that sometimes appear between rows as spacers, should be collapsed.

APIPROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.size.unit
Property whose value is used as default for the SIZE_UNIT export parameter. A String value specifying the unit to use when measuring lengths or font size.

APIPROPERTY_SIZE_UNIT
Defaultpx
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.using.images.to.align
Property whose value is used as default state of the IS_USING_IMAGES_TO_ALIGN export flag. It specifies whether the export engine should use small transparent spacer images for aligning content.

APIPROPERTY_USING_IMAGES_TO_ALIGN
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.white.page.background
Property whose value is used as default state of the IS_WHITE_PAGE_BACKGROUND export parameter. It specifies whether the report page background should be forced to white.

APIPROPERTY_WHITE_PAGE_BACKGROUND
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.wrap.break.word
Property whose value is used as default state of the IS_WRAP_BREAK_WORD export parameter. It specifies whether the export engine should force text wrapping by breaking words (CSS word-wrap: break-word).

APIPROPERTY_WRAP_BREAK_WORD
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.ignore.page.margins
This property serves as default value for the IGNORE_PAGE_MARGINS export flag. Specifies whether page margins should be ignored when the report is exported using a grid-based exporter If the property is true, any page in the document will be exported without taking into account its margins.

APIPROPERTY_IGNORE_PAGE_MARGINS
Defaultfalse
ScopeGlobal | Report
Since2.0.5

top

net.sf.jasperreports.export.jxl.cell.complex.format
Boolean property specifying whether the cell format pattern is user-defined. When set to true, the exporter will assume that the specified pattern is well defined. If the pattern is invalid, it won't be taken into account by the Excel file viewer.

APIPROPERTY_COMPLEX_FORMAT
Defaultfalse
ScopeGlobal | Report | Element
Since3.7.6

top

net.sf.jasperreports.export.jxl.use.temp.file
Boolean property enabling the JExcelApiExporter to use temporary files when creating large documents.

APIPROPERTY_USE_TEMP_FILE
Defaultfalse
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.legacy.border.offset
Property which allows rendering element borders in older reports using the legacy border offset technique that that was used in versions prior to the 2.0.3 release.

APIPROPERTY_LEGACY_BORDER_OFFSET
Defaultnet.sf.jasperreports.export.legacy.BorderOffset.DEFAULT
ScopeGlobal | Report
Since3.0.0

top

net.sf.jasperreports.export.parameters.override.report.hints
Property that establishes the priority of export parameters against report hints. If the property is true, export parameters override report hints; this is the default behavior.

APIPROPERTY_EXPORT_PARAMETERS_OVERRIDE_REPORT_HINTS
Defaulttrue
ScopeGlobal
Since

top

net.sf.jasperreports.export.pdf.128.bit.key
Property whose value is used as default state of the IS_128_BIT_KEY export parameter. It specifies whether the encryption key is 128 bits.

APIPROPERTY_128_BIT_KEY
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.collapse.missing.bookmark.levels
Property that determines if missing bookmark levels are collapsed, or if empty bookmarks are created for the missing levels.The property dictates what happens when a filled report contains an anchor having a bookmark level that is not the immediate successor of its parent (e.g. an anchor with bookmark level 3 follows immediately after a bookmark of level 1). If the property is not set, an empty bookmark is created for the missing level(s) in order to preserve the original level of the bookmark. When the property is set, the level of the bookmark will be collapsed and the bookmark will be created as a direct descendant of its nearest parent.

APIPROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS
Defaultfalse
ScopeGlobal | Report
Since3.7.3

top

net.sf.jasperreports.export.pdf.compressed
Property whose value is used as default state of the IS_COMPRESSED export flag. It specifies whether the PDF document should be compressed.

APIPROPERTY_COMPRESSED
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.create.batch.mode.bookmarks
Property whose value is used as default state of the IS_CREATING_BATCH_MODE_BOOKMARKS export flag. It specifies whether the PDF document should contain an outline section.

APIPROPERTY_CREATE_BATCH_MODE_BOOKMARKS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.encrypted
Property whose value is used as default state of the IS_ENCRYPTED export flag. It specifies whether the final PDF document should be encrypted.

APIPROPERTY_ENCRYPTED
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.font.{arbitrary_name}
Prefix of properties that specify font files for the PDF exporter.

APIPDF_FONT_FILES_PREFIX
DefaultN/A
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.export.pdf.fontdir.{arbitrary_name}
Prefix of properties that specify font directories for the PDF exporter.

APIPDF_FONT_DIRS_PREFIX
DefaultN/A
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.export.pdf.force.linebreak.policy
Property whose value is used as default state of the FORCE_LINEBREAK_POLICY export flag. It specifies whether the PDF exporter should use aSplitCharacter implementation to ensure that PDF text wrap behavior is the same as in AWT.

APIPROPERTY_FORCE_LINEBREAK_POLICY
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.force.svg.shapes
Property whose value is used as default state of the FORCE_SVG_SHAPES export flag. It specifies whether the rendering of SVG images using shapes on the PDF Graphics2D context should be forced.

APIPROPERTY_FORCE_SVG_SHAPES
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.javascript
Property whose value is used as default state of the PDF_JAVASCRIPT export parameter. Contains the user defined JavaScript piece of code to be inserted into the generated PDF document.

APIPROPERTY_PDF_JAVASCRIPT
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.owner.password
Property whose value is used as default state of the OWNER_PASSWORD export parameter. Contains the password belonging to the owner of the document, if it is encrypted. If the owner password is not specified, but the PDF is encrypted, then the password will be a random string.

APIPROPERTY_OWNER_PASSWORD
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.print.scaling
Property whose value is used as default state of the PRINT_SCALING export parameter. Possible values are default and none.

APIPRINT_SCALING
Defaultdefault
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.pdf.tag.colspan

APIPROPERTY_TAG_COLSPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.h1

APIPROPERTY_TAG_H1
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.h2

APIPROPERTY_TAG_H2
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.h3

APIPROPERTY_TAG_H3
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.language
Property whose value is used as default state of the TAG_LANGUAGE export parameter. Specifies the language that the exporter should put in the language tag of the generated PDF.

APIPROPERTY_TAG_LANGUAGE
DefaultN/A
ScopeGlobal | Report
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.rowspan

APIPROPERTY_TAG_ROWSPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.table

APIPROPERTY_TAG_TABLE
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.td

APIPROPERTY_TAG_TD
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.th

APIPROPERTY_TAG_TH
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.tr

APIPROPERTY_TAG_TR
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tagged
Property whose value is used as default state of the IS_TAGGED export flag. Specifies whether the exporter should put structure tags in the generated PDF.

APIPROPERTY_PDF_TAGGED
Defaultfalse
ScopeGlobal | Report
Since3.1.2

top

net.sf.jasperreports.export.pdf.user.password
Property whose value is used as default state of the USER_PASSWORD export parameter. Contains the user password needed to open the document, if it is encrypted.

APIPROPERTY_USER_PASSWORD
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.version
Property whose value is used as default state of the PDF_VERSION export parameter. Contains a Character instance representing the version of the generated PDF.

APIPROPERTY_PDF_VERSION
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.text.character.height
Property whose value is used as default state of the CHARACTER_HEIGHT export parameter.

APIPROPERTY_CHARACTER_HEIGHT
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.text.character.width
Property whose value is used as default state of the CHARACTER_WIDTH export parameter.

APIPROPERTY_CHARACTER_WIDTH
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.text.page.height
Property whose value is used as default state of the PAGE_HEIGHT export parameter.

APIPROPERTY_PAGE_HEIGHT
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.text.page.width
Property whose value is used as default state of the PAGE_WIDTH export parameter.

APIPROPERTY_PAGE_WIDTH
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.xls.break.after.row
Custom element property specifying if a sheet will break after the row displaying that element. It is very useful especially when displaying each report's group on a separate sheet is intended.

APIPROPERTY_BREAK_AFTER_ROW
Defaultfalse
ScopeElement
Since3.0.0

top

net.sf.jasperreports.export.xls.break.before.row
Custom element property specifying if a sheet will break before the row displaying that element. It is very useful especially when displaying each report's group on a separate sheet is intended.

APIPROPERTY_BREAK_BEFORE_ROW
Defaultfalse
ScopeElement
Since3.0.0

top

net.sf.jasperreports.export.xls.cell.hidden
Property that specifies if the cell content is hidden or exposed in the formula bar of a protected sheet. By default the property is not set (false), and the cell content is not hidden. This property has effect only if the enclosing sheet is protected.

APIPROPERTY_CELL_HIDDEN
Defaultfalse
ScopeGlobal | Report | Element
Since3.7.5

top

net.sf.jasperreports.export.xls.cell.locked
Property that specifies if the cell content is locked (read-only) within a protected sheet. By default the property is considered (true), but it only has effect if the enclosing sheet is protected.

APIPROPERTY_CELL_LOCKED
Defaulttrue
ScopeGlobal | Report | Element
Since3.7.5

top

net.sf.jasperreports.export.xls.collapse.row.span
Property whose value is used as default state of the IS_COLLAPSE_ROW_SPAN export flag. Specifies whether row spans should be collapsed and merging cells across rows should be inhibited.

APIPROPERTY_COLLAPSE_ROW_SPAN
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.create.custom.palette
Property whose value is used as default state of the CREATE_CUSTOM_PALETTE export flag. This property is by default not set (false).

APIPROPERTY_CREATE_CUSTOM_PALETTE
Defaultfalse
ScopeGlobal | Report
Since2.0.0

top

net.sf.jasperreports.export.xls.detect.cell.type
Property whose value is used as default state of the IS_DETECT_CELL_TYPE export flag. Specifies whether the exporter should take into consideration the type of the original text field expressions and set the cell types and values accordingly.

APIPROPERTY_DETECT_CELL_TYPE
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.fit.height
Property used at print time to indicate the number of pages height to fit the sheet in.

APIPROPERTY_FIT_HEIGHT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.fit.width
Property used at print time to indicate the number of pages width to fit the sheet in.

APIPROPERTY_FIT_WIDTH
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.font.size.fix.enabled
Property whose value is used as default state of the IS_FONT_SIZE_FIX_ENABLED export flag. Specifies whether the font size should be decreased so that texts fit into the specified cell height.

APIPROPERTY_FONT_SIZE_FIX_ENABLED
Defaultfalse
ScopeGlobal | Report
Since2.0.1

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.

APIPROPERTY_CELL_FORMULA
DefaultN/A
ScopeText Element
Since3.0.0

top

net.sf.jasperreports.export.xls.ignore.cell.background
Property whose value is used as default state of the IS_IGNORE_CELL_BACKGROUND export flag. Specifies whether cell background color should be ignored.

APIPROPERTY_IGNORE_CELL_BACKGROUND
Defaultfalse
ScopeGlobal | Report
Since3.6.2

top

net.sf.jasperreports.export.xls.ignore.cell.border
Property whose value is used as default state of the IS_IGNORE_CELL_BORDER export flag. Specifies whether cell borders should be ignored.

APIPROPERTY_IGNORE_CELL_BORDER
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.ignore.graphics
Property whose value is used as default state of the IS_IGNORE_GRAPHICS export flag. Specifies whether graphic elements should be ignored and only text elements be exported.

APIPROPERTY_IGNORE_GRAPHICS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.image.border.fix.enabled
Property whose value is used as default state of the IS_IMAGE_BORDER_FIX_ENABLED export parameter.

APIPROPERTY_IMAGE_BORDER_FIX_ENABLED
Defaultfalse
ScopeGlobal | Report
Since3.0.0

top

net.sf.jasperreports.export.xls.max.rows.per.sheet
Property whose value is used as default state of the MAXIMUM_ROWS_PER_SHEET export parameter. 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.

APIPROPERTY_MAXIMUM_ROWS_PER_SHEET
Default0
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.one.page.per.sheet
Property whose value is used as default state of the IS_ONE_PAGE_PER_SHEET export flag. Specifies whether each report page should be written in a different XLS sheet.

APIPROPERTY_ONE_PAGE_PER_SHEET
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.password
Property whose value is used as default state of the PASSWORD export parameter. 
Contains a String value representing the password in case of password protected sheets in documents. 
This property is by default not set (null).

APIPROPERTY_PASSWORD
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.xls.remove.empty.space.between.columns
Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS export flag. Specifies whether the empty spacer columns should be removed or not.

APIPROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.remove.empty.space.between.rows
Property whose value is used as default state of the IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS export flag. Specifies whether the empty spacer rows should be removed or not.

APIPROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

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:
  • LTR
  • RTL

APIPROPERTY_SHEET_DIRECTION
DefaultLTR
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.footer.center
Custom property storing the text content of the sheet footer's center.

APIPROPERTY_SHEET_FOOTER_CENTER
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.footer.left
Custom property storing the text content of the left side of the sheet footer.

APIPROPERTY_SHEET_FOOTER_LEFT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.footer.right
Custom property storing the text content of the right side of the sheet footer.

APIPROPERTY_SHEET_FOOTER_RIGHT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.header.center
Custom property storing the text content of the sheet header's center.

APIPROPERTY_SHEET_HEADER_CENTER
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.header.left
Custom property storing the text content of the left side of the sheet header.

APIPROPERTY_SHEET_HEADER_LEFT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.header.right
Custom property storing the text content of the right side of the sheet header.

APIPROPERTY_SHEET_HEADER_RIGHT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name}
A set of report custom properties (exporter hints) added in order to hold user defined sheet names. This is very useful when indicating sheet names in the jrxml template is required. 
These properties should start with the net.sf.jasperreports.export.xls.sheet.names. prefix, and should end with an arbitrary suffix. Any of them can hold one or many sheet names, separated by the slash ("/") separator. Values are collected in the same order as they are enumerated in the jrxml template, so one have to be careful with that order when editing a jrxml. The ending suffix is not important, but the order is very. 
For instance, if a given report has 3 resulting sheets, there are multiple possibilities to define the sheet names within the jrxml template: 

  1. To have a single property for each sheet name: 

     
     
     

    Then, the 3 resulting sheets will be named as follows: 

    First sheet 
    Second sheet 
    Third sheet 

  2. To have a single property containing all sheet names, separated by the "/" separator: 

     

    Then, the 3 resulting sheets will be named as follows: 

    First sheet 
    Second sheet 
    Third sheet 
    The order is very important, as shown above. 

  3. To have any combination of 1) and 2): 

     
     

    Then, the 3 resulting sheets will be named as follows: 

    First sheet 
    Second sheet 
    Third sheet

Finally, if the user sets less sheet names (let's say x) than the number of sheets, the exporter will use the custom user sheet names for the first x sheets in the document, and the remaining sheets will be named by default as "Page y", where y is the current page number. 
These properties are by default not set.

APIPROPERTY_SHEET_NAMES_PREFIX
DefaultN/A
ScopeReport
Since3.5.2

top

net.sf.jasperreports.export.xls.white.page.background
Property whose value is used as default state of the IS_WHITE_PAGE_BACKGROUND export flag. Specifies whether the page background should be white or the default XLS background color.

APIPROPERTY_WHITE_PAGE_BACKGROUND
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.wrap.text
Custom element property specifying if text wrapping is allowed in a given cell. If set to false, text wrapping is forbidden, otherwise it is allowed.

APIPROPERTY_WRAP_TEXT
Defaulttrue
ScopeGlobal | Report | Element
Since3.7.3

top

net.sf.jasperreports.export.xml.end.page.index

APIPROPERTY_END_PAGE_INDEX
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.xml.page.count

APIPROPERTY_PAGE_COUNT
DefaultN/A
ScopeGlobal | Report
Since3.0.0

top

net.sf.jasperreports.export.xml.start.page.index

APIPROPERTY_START_PAGE_INDEX
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.xml.validation
Property that forces the XML validation, when a document exported to XML format is loaded.

APIEXPORT_XML_VALIDATION
Defaulttrue
ScopeGlobal | Report
Since1.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 prefixnet.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.

APIPROPERTY_REGISTRY_PREFIX
DefaultN/A
ScopeGlobal
Since3.1.0

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.

APIPROPERTY_REGISTRY_FACTORY_PREFIX
DefaultN/A
ScopeGlobal
Since3.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.

APIPROPERTY_EXTENSIONS_REGISTRY_CLASS
Defaultnet.sf.jasperreports.extensions.DefaultExtensionsRegistry
ScopeGlobal
Since3.1.0

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 aFileBufferedOutputStream instance.

APIPROPERTY_MEMORY_THRESHOLD
Default262144
ScopeGlobal
Since1.3.4

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.

APIPROPERTY_MAX_PAGES
DefaultN/A
ScopeGlobal | Report
Since3.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.

APIPROPERTY_MAX_PAGES_ENABLED
Defaultfalse
ScopeGlobal | Report
Since3.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.

APIPROPERTY_TIMEOUT
DefaultN/A
ScopeGlobal | Report
Since3.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.

APIPROPERTY_TIMEOUT_ENABLED
Defaultfalse
ScopeGlobal | Report
Since3.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.

APIPROPERTY_HIBERNATE_CLEAR_CACHE
Defaultfalse
ScopeGlobal | Dataset
Since1.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.

APIPROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS
Defaulttrue
ScopeGlobal | Dataset
Since1.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 byorg.hibernate.Query.setFirstResult() and org.hibernate.Query.setMaxResults(). By default, all the rows are retrieved (no result pagination is performed).

APIPROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE
Default0
ScopeGlobal | Dataset
Since1.2.0

top

net.sf.jasperreports.hql.query.run.type
Property specifying the Hibernate query execution type. Possible values are:
  • list - the query will be run by calling org.hibernate.Query.list()
  • iterate - the query will be run by calling org.hibernate.Query.iterate()
  • scroll - the query will be run by calling org.hibernate.Query.scroll()

APIPROPERTY_HIBERNATE_QUERY_RUN_TYPE
Defaultlist
ScopeGlobal | Dataset
Since1.2.0

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.

APIPROPERTY_IMAGE_ENCODER
DefaultN/A
ScopeGlobal
Since2.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.

APIPROPERTY_IMAGE_READER
DefaultN/A
ScopeGlobal
Since2.0.5

top

net.sf.jasperreports.jdbc.concurrency
Property specifying the concurrency rule for the java.sql.ResultSet created by the JRJdbcQueryExecuter. Possible values are:
  • readOnly - the concurrency mode for a ResultSet object that may NOT be updated.
  • updatable - the concurrency mode for a ResultSet object that may be updated.

APIPROPERTY_JDBC_CONCURRENCY
DefaultreadOnly
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdbc.fetch.size
Property specifying the fetch size for the java.sql.ResultSet created by the JRJdbcQueryExecuter and the JRHibernateQueryExecuter.

APIPROPERTY_JDBC_FETCH_SIZE
Default0
ScopeGlobal | Dataset
Since1.2.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:
  • hold - indicates that ResultSet objects should not be closed when the method Connection.commit() is called.
  • close - indicates that ResultSet objects should be closed when the method Connection.commit() is called.

APIPROPERTY_JDBC_HOLDABILITY
Defaulthold
ScopeGlobal | Dataset
Since3.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 theJRJdbcQueryExecuter.

APIPROPERTY_JDBC_MAX_FIELD_SIZE
DefaultN/A
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdbc.result.set.type
Property specifying the type for the java.sql.ResultSet created by the JRJdbcQueryExecuter. Possible values are:
  • forwardOnly - the cursor may move only forward.
  • scrollInsensitive - the result set is scrollable but generally not sensitive to changes made by others.
  • scrollSensitive - the result set is scrollable and generally sensitive to changes made by others.

APIPROPERTY_JDBC_RESULT_SET_TYPE
DefaultforwardOnly
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdk.glyph.fix.text.measurer.attempts
A property that specifies the number of times the measurer should attempt to measure a single text element before giving up.

APIPROPERTY_ATTEMPTS
Default20
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.jdk.glyph.fix.text.measurer.catch.empty.stacktrace
A property that specifies whether java.lang.NullPointer exceptions with empty stacktraces should be caught. 
This is useful when running on a Sun server JVM (java -server), which might omit exception stacktraces in some cases.

APIPROPERTY_CATCH_EMPTY_STACKTRACE
Defaultfalse
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.jdk.glyph.fix.text.measurer.sleep
A property that specifies the number of milliseconds to sleep between measuring reattempts. 
The default value is 0, which means that the measurer will not pause between reattempts (see DEFAULT_ATTEMPT_SLEEP).

APIPROPERTY_ATTEMPT_SLEEP
Default0
ScopeGlobal
Since3.0.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.

APIPROPERTY_MARKUP_PROCESSOR_FACTORY_PREFIX
DefaultN/A
ScopeGlobal
Since2.0.5

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.

APIPROPERTY_PRINT_KEEP_FULL_TEXT
Defaultfalse
ScopeGlobal | Report | Text Element
Since2.0.3

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.

APIPROPERTIES_FILE
Defaultjasperreports.properties
ScopeSystem
Since1.0.0

top

net.sf.jasperreports.query.chunk.token.separators
Property that specifies the list of token separators characters for TYPE_CLAUSE_TOKENS tokenized query clauses.

APIPROPERTY_CHUNK_TOKEN_SEPARATOR
Default, ; |
ScopeGlobal
Since2.0.5

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.

APIQUERY_EXECUTER_FACTORY_PREFIX
DefaultN/A
ScopeGlobal
Since1.2.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.

APIPROPERTY_EVALUATION_TIME_ENABLED
Defaultfalse
ScopeGlobal | Report | Element
Since3.5.2

top

net.sf.jasperreports.subreport.runner.factory
Property specifying the JRSubreportRunnerFactory implementation to use for creating subreport runners.

APISUBREPORT_RUNNER_FACTORY
Defaultnet.sf.jasperreports.engine.fill.JRThreadSubreportRunnerFactory
ScopeGlobal
Since1.2.2

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 ofJRMeasuredText 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.

APIPROPERTY_TEXT_MEASURER_FACTORY
Defaultnet.sf.jasperreports.engine.fill.TextMeasurerFactory
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.text.save.line.breaks
Boolean property that determines whether the positions where text line break occurs are to be saved during report fill in oder to be used at export time. 
At report fill time, each text element is measured in order to determine how long it needs to stretch or where it needs to be truncated. During this measurement, the text wraps at certain positions in order to fit the text element defined width. 
Setting this property to true instructs the engine to save the positions at which line breaks occur in the generated print element. The positions can be used by report exporters that want to enforce line breaks to occur at exactly the same position as they did during text measurement at fill time. 
Currently, the HTML exporter will make use of the saved line break positions by introducing explicit line breaks.

APIPROPERTY_SAVE_LINE_BREAKS
Defaultfalse
ScopeGlobal | Report | Text Element
Since3.5.1

top

net.sf.jasperreports.text.truncate.at.char
Boolean property that determines whether text elements are to be truncated at the last character that fits. By default, when the entire text of a text element does not fit the element's area, the text is truncated at the last word that fits the area.

APIPROPERTY_TRUNCATE_AT_CHAR
Defaultfalse
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.text.truncate.suffix
Property whose value is used as a suffix for the truncated text. The suffix is appended to the text when truncation occurs. If the property is not defined or empty (which is the case by default), no suffix will be used when the text is truncated.

APIPROPERTY_TRUNCATE_SUFFIX
Defaultempty string
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.viewer.render.buffer.max.size
Maximum size (in pixels) of a buffered image that would be used by JRViewer to render a report page. If rendering a report page would require an image larger than this threshold (i.e. image width x image height > maximum size), the report page will be rendered directly on the viewer component. If this property is zero or negative, buffered images will never be used to render a report page.

APIVIEWER_RENDER_BUFFER_MAX_SIZE
Default0
ScopeGlobal
Since1.2.8

top

net.sf.jasperreports.virtualizer.files.delete.on.exit
Property used to decide whether java.io.File#deleteOnExit() should be requested for temporary files created by the virtualizer. Temporary files will be deleted by explicitly calling cleanup() or from the virtualizer finalize() method.

APIPROPERTY_TEMP_FILES_SET_DELETE_ON_EXIT
Defaulttrue
ScopeGlobal
Since1.2.3

top

net.sf.jasperreports.xpath.executer.factory
Property specifying the JRXPathExecuterFactory XPath executer factory implementation class name. JasperReports is shipped with two implementation of this factory interface: XalanXPathExecuterFactory and JaxenXPathExecuter.

APIPROPERTY_XPATH_EXECUTER_FACTORY
Defaultnet.sf.jasperreports.engine.util.xml.XalanXPathExecuterFactory
ScopeGlobal
Since2.0.0

Comments

Popular posts from this blog

Stretch a row if data overflows in jasper reports

It is very common that some columns of the report need to stretch to show all the content in that column. But  if you just specify the property " stretch with overflow' to that column(we called text field in jasper report world) , it will just stretch that column and won't change other columns, so the row could be ridiculous. Haven't find the solution from internet yet. So I just review the properties in iReport one by one and find two useful properties(the bold highlighted in example below) which resolve the problems.   example:
<band height="20" splitType="Stretch"> <textField isStretchWithOverflow="true" pattern="" isBlankWhenNull="true"> <reportElement stretchType="RelativeToTallestObject" mode="Opaque" x="192" y="0" width="183" height="20"/> <box leftPadding="2"> <pen lineWidth="0.25"/> …

Spring - Operations with jdbcTemplate

This class manages all the database communication and exception handling using a java.sql.Connection that is obtained from the provided DataSource. JdbcTemplate is a stateless and threadsafe class and you can safely instantiate a single instance to be used for each DAO.


Use of Callback Methods
JdbcTemplate is based on a template style of programming common to many other parts of Spring. Some method calls are handled entirely by the JdbcTemplate, while others require the calling class to provide callback methods that contain the implementation for parts of the JDBC workflow. This is another form of Inversion of Control. Your application code hands over the responsibility of managing the database access to the template class. The template class in turn calls back to your application code when it needs some detail processing filled in. These callback methods are allowed to throw a java.sql.SQLException, since the framework will be able to catch this exception and use its built-in excepti…