Jasperreport"

From Documentation
m ((via JWB))
(16 intermediate revisions by 4 users not shown)
Line 10: Line 10:
  
 
= Employment/Purpose =
 
= Employment/Purpose =
The JasperReport component. It is used to generate a Jasper report into an inline frame
 
 
  
 +
The JasperReport component is based on JasperReports Library, a report generator (e.g. XML generator, PDF generator etc.). This component is used to generate a Jasper report into an inline frame.
  
 
= Example =
 
= Example =
Line 39: Line 38:
  
 
== Provide Export Parameters ==
 
== Provide Export Parameters ==
The Jasperreport component API provides a way to specify export parameters. To do so, you should put a Map containing export parameters within the parameters Map, with key <tt>"exportParameter"</tt>. For example:
+
The Jasperreport component API provides a way to specify export parameters. To do so, you should put a Map containing export parameters within the parameters Map, with key <code>"exportParameter"</code>. For example:
  
 
<source lang="java">
 
<source lang="java">
Line 58: Line 57:
 
parameters.put("exportParameter", exportParams);
 
parameters.put("exportParameter", exportParams);
 
report.setParameters(parameters); // report is the Jasperreport component
 
report.setParameters(parameters); // report is the Jasperreport component
 +
</source>
 +
 +
= exportName =
 +
{{versionSince| 8.6.1}}
 +
 +
You can specify the export file name for the download if any, the full file name will be exportName + "." + format.
 +
 +
Note: exportName can not be empty or null.
 +
 +
Default: "report"
 +
 +
<source lang="xml">
 +
<jasperreport exportName="test"/>
 
</source>
 
</source>
  
 
=Supported Events=
 
=Supported Events=
  
{| border="1" | width="100%"
+
{| class='wikitable' | width="100%"
 
! <center>Name</center>
 
! <center>Name</center>
 
! <center>Event Type</center>
 
! <center>Event Type</center>
Line 92: Line 104:
  
 
== Type List ==
 
== Type List ==
{| border='1px' | width="20%" |
+
{| class='wikitable' | width="100%"
 
! Type !! Version  
 
! Type !! Version  
 
|-
 
|-
Line 120: Line 132:
 
|-
 
|-
 
| xlsx
 
| xlsx
| since 5.0.8
+
| {{versionSince| 5.0.8}}
 
|-
 
|-
 
| docx
 
| docx
Line 139: Line 151:
 
| xhtml
 
| xhtml
 
| since 5.0.8
 
| since 5.0.8
 +
|}
 +
 +
= Supported JasperReport Version =
 +
{| class='wikitable' | width="100%"
 +
! ZK !! JasperReport !! Transitive Dependency
 +
|-
 +
| 9.6.0
 +
| 6.14.0
 +
| optional ([https://mvnrepository.com/artifact/net.sf.jasperreports/jasperreports net.sf.jasperreports:jasperreports] needs to be added manually on demand)
 +
|-
 +
| 9.5.0
 +
| 6.14.0
 +
| added by default
 +
|-
 +
| 9.0.0
 +
| 6.6.0
 +
| added by default
 +
|-
 +
| 8.6.0
 +
| 6.5.1
 +
| added by default
 +
|-
 +
| 7.0.0
 +
| 4.5.1
 +
| added by default
 +
|-
 +
| 6.0.0
 +
| 4.0.1
 +
| added by default
 
|}
 
|}
  
 
=Use Cases=
 
=Use Cases=
  
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
! Version !! Description !! Example Location
+
! Version !! Description  
 
|-
 
|-
 
| 5.0.2
 
| 5.0.2
| How to use Dynamic Jasper Reports
+
| [http://www.zkoss.org/forum/listComment/10873 How to use Dynamic Jasper Reports]
| http://www.zkoss.org/forum/listComment/10873
 
 
|-
 
|-
 
| 6/5.0.8
 
| 6/5.0.8
| Create a Report with ZK using iReport and JasperReports
+
| [http://books.zkoss.org/wiki/Small_Talks/2012/April/Create_a_Report_with_ZK_using_iReport_and_JasperReports Create a Report with ZK using iReport and JasperReports]
| http://books.zkoss.org/wiki/Small_Talks/2012/April/Create_a_Report_with_ZK_using_iReport_and_JasperReports
 
 
|}
 
|}
  
Line 162: Line 201:
 
=Version History=
 
=Version History=
 
{{LastUpdated}}
 
{{LastUpdated}}
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Date !! Content
 
! Version !! Date !! Content
 
|-
 
|-

Revision as of 08:28, 8 July 2022

Jasperreport

Employment/Purpose

The JasperReport component is based on JasperReports Library, a report generator (e.g. XML generator, PDF generator etc.). This component is used to generate a Jasper report into an inline frame.

Example

ZKComRef Jasperreport Examples.PNG

	<jasperreport id="report" height="360px" />
	
	<zscript>
		import org.zkoss.zkdemo.userguide.CustomDataSource;
		
			//Preparing parameters
			Map parameters = new HashMap();
			parameters.put("ReportTitle", "Address Report");
			parameters.put("DataFile", "CustomDataSource from java");
			
			report.setSrc("/data/jasperreport.jasper");
			report.setParameters(parameters);
			report.setDatasource(new CustomDataSource());
			report.setType("pdf");
	</zscript>


Provide Export Parameters

The Jasperreport component API provides a way to specify export parameters. To do so, you should put a Map containing export parameters within the parameters Map, with key "exportParameter". For example:

	Map parameters = new HashMap();
	Map exportParams = new HashMap();
	exportParams.put("net.sf.jasperreports.export.mypropertyname", true);
	parameters.put("exportParameter", exportParams);
	report.setParameters(parameters); // report is the Jasperreport component

One-Page-Per-Sheet Property

In Jasperreport engine, this property is default to be false. However, the default behavior is turned on in the Jasperreport component, in which case when the report is exported as Excel format there will be one sheet generated for each page. To override this setting, set it as an export parameter as the following:

	Map parameters = new HashMap();
	Map exportParams = new HashMap();
	exportParams.put(JRXlsAbstractExporterParameter.PROPERTY_ONE_PAGE_PER_SHEET.toString(), false);
	parameters.put("exportParameter", exportParams);
	report.setParameters(parameters); // report is the Jasperreport component

exportName

Since 8.6.1

You can specify the export file name for the download if any, the full file name will be exportName + "." + format.

Note: exportName can not be empty or null.

Default: "report"

<jasperreport exportName="test"/>

Supported Events

Name
Event Type
None None

Supported Children

*NONE

Supported Type

Usage

Java Code

//Jasperreport report;
report.setType("pdf"); // report is the Jasperreport component

Zul Code

<jasperreport id="report" type="pdf" />

Type List

Type Version
pdf
xml
html
rtf
xls
jxl
csv
odt
xlsx Since 5.0.8
docx since 5.0.8
graphic2d since 5.0.8
ods since 5.0.8
pptx since 5.0.8
txt since 5.0.8
xhtml since 5.0.8

Supported JasperReport Version

ZK JasperReport Transitive Dependency
9.6.0 6.14.0 optional (net.sf.jasperreports:jasperreports needs to be added manually on demand)
9.5.0 6.14.0 added by default
9.0.0 6.6.0 added by default
8.6.0 6.5.1 added by default
7.0.0 4.5.1 added by default
6.0.0 4.0.1 added by default

Use Cases

Version Description
5.0.2 How to use Dynamic Jasper Reports
6/5.0.8 Create a Report with ZK using iReport and JasperReports

Troubleshooting

Linux

Jasperreport depends on the fonts you use in the report. For more information, please refer to ZK Installation Guide: Linux.

Version History

Last Update : 2022/07/08


Version Date Content
5.0.1 March 2010 Support Hibernate and SQL connections
5.0.8 Upgrade JaserReport version to 4.0 and support new JasperReport exporter



Last Update : 2022/07/08

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.