ZK Component Reference/Diagrams and Reports/Jasperreport

Jasperreport

• Demonstration: Jasperreport
• Java API: Jasperreport
• JavaScript API: Jasperreport
• Style Guide: N/A
• Available in ZK PE and EE only

Employment/Purpose

The JasperReport component. It is used to generate a Jasper report into an inline frame

Example

	<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("/userguide/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

Supported Events

Name	Event Type
None	None

• Inherited Supported Events: Iframe

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

Use Cases

Version	Description	Example Location
5.0.2	How to use Dynamic Jasper Reports	http://www.zkoss.org/forum/listComment/10873

Troubleshooting

Linux

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

Version History

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