Report is the root object that represents the report template. During the report execution, the report template is combined with data to obtain the final document.
Report Properties
Report Name
The name of the report. This field is used internally by JasperReports. It is a good practice to use here the name of the file under which the report is saved.
Units
Report units. Possible values are Pixels
,
Millimeters
, Centimeters
and
Inches
.
Language
The language used for report expressions. Currently Java
and Groovy
are the languages supported by
JasperAssistant
's report compiler.
Orientation
The page orientation. Possible values are Portrait
and
Landscape
.
Page Width
The page width specified in report units.
Page Height
The page height specified in report units.
Page Size
The page size. This property is an alternative to Page
Width
and Page Height
properties and allows to
specify the size using a predefined paper format.
Left Margin
The left margin specified in report units.
Right Margin
The right margin specified in report units.
Top Margin
The top margin specified in report units.
Bottom Margin
The bottom margin specified in report units.
Column Count
The number of columns on the report.
Column Spacing
The space between column specified in report units.
Column Width
The width of a column specified in report units.
Print Order
Columns filling order.
Vertical
- Columns of the report are filled
vertically.
Horizontal
- Columns of the report are filled
horizontally.
Float Column Footer
Flag that indicates whether the column footer is printed at the bottom of the column or follows the last detail or group footer.
Default Font
The default report font that is used as base font for all the font definitions that do not explicitly reference a report font definition. For more details on fonts see Section 6.5, “Fonts”.
Default Style
The style to be used as the default style for all report objects. For more details on styles see Section 6.4, “Styles”.
Scriptlet Class
A fully qualified name of the class implementing the scriptlets functionality for this report. The specified class must be a subclass of JRAbstractScriptlet class. If omitted, an instance of JRDefaultScriptlet will be created.
Summary New Page
Flag used to specify whether the summary section should be printed on a separate end page.
Title New Page
Flag used to specify whether the title section should be printed on a separate start page.
When No Data Print
Allows users to customize the behavior of the reporting engine when there are no rows in the data source.
No Pages
- The generated document contains zero
pages.
Blank Page
- The generated document contains one
blank page.
All Sections No Detail
- All the report sections
except the detail section will get printed.
No Data Section
- The no data section is printed.
Query
The query that will be used to retrieve the data needed to fill the report. The query is executed against a data source that must support the language the query is written in. For more on data sources see Section 3.2, “Data Sources”
Query Language
The language the query is written in. Accepted values are:
SQL
- SQL query language that can be used with
JDBC data sources.
HBM
- Hibernate query language that can be used
with Hibernate data sources.
XPath
- XPath query language that can be used
with XML data sources.
EJBQL
- EJBQL query language that can be used
with data sources that support Java Persistence API.
MDX
- MDX query language that can be used
with Mondrian data sources.
Filter Expression
Specifies a boolean expression that controls which rows are included or excluded from the data source.
Imports
A list of Java import declarations such as java.util.*
and
java.text.SimpleDateFormat
. Imports are used to simplify
report expressions by eliminating the need for fully qualified Java class
names.
Resource Bundle
The base name of the resource bundle that provides localized strings for the report. Localized strings can be referred to in report expressions using the $R{key} syntax. For more information on resource bundles see:
http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html
When Resource Missing Print
Allows to customize the way the engine deals with missing resources in the resource bundle. For more information on resource bundles see:
Null
- Null is printed for the missing
resource.
Empty
- Nothing is printed for the missing
resource.
Key
- The key as specified using the $R{key}
syntax is printed.
Error
- The report execution is interrupted with
an error.
http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html
Default Locale
The locale that is used to select an appropriate resource bundle for the report preview and export. For more information on locales see:
http://java.sun.com/j2se/1.4.2/docs/api/java/util/Locale.html
Ignore Pagination
Flag used to specify whether the pagination should be ignored by the engine and the entire report should be generated on one long page.
Format Factory Class
A fully qualified name of the class implementing the
net.sf.jasperreports.engine.util.FormatFactory
interface.
Sort Fields
A list of fields that determine the ordering of the data source.