org.zkoss.zkex.zul.api
Interface Jasperreport

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Iframe, Scope, java.io.Serializable
All Known Implementing Classes:
Jasperreport

public interface Jasperreport
extends Iframe

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

Available in ZK PE and ZK EE.

Note: this component is serializable only if the data source ( getDatasource()) is serializable.

Since:
3.0.2
Author:
gracelin

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 net.sf.jasperreports.engine.JRDataSource getDatasource()
          Returns the JasperReports DataSource.
 java.util.Locale getLocale()
          Returns the output file locale.
 java.util.Map getParameters()
          Returns the JasperReports Parameters.
 java.lang.String getType()
          Returns the output file type.
 void setDatasource(net.sf.jasperreports.engine.JRDataSource dataSource)
          Sets the JasperReports DataSource.
 void setLocale(java.util.Locale locale)
          Sets the output file locale.
 void setParameters(java.util.Map parameters)
          Sets the JasperReports Parameters.
 void setType(java.lang.String type)
          Sets the output file type.
 
Methods inherited from interface org.zkoss.zul.api.Iframe
getAlign, getContent, getName, getScrolling, getSrc, isAutohide, setAlign, setAutohide, setContent, setName, setScrolling, setSrc
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getParameters

java.util.Map getParameters()
Returns the JasperReports Parameters.

Default: null.


setParameters

void setParameters(java.util.Map parameters)
Sets the JasperReports Parameters.

Parameters:
parameters - use to fill the report

getDatasource

net.sf.jasperreports.engine.JRDataSource getDatasource()
Returns the JasperReports DataSource.

Default: null.


setDatasource

void setDatasource(net.sf.jasperreports.engine.JRDataSource dataSource)
Sets the JasperReports DataSource.

Parameters:
dataSource - use to fill the report

getType

java.lang.String getType()
Returns the output file type.

Default: pdf.

Since:
3.0.3

setType

void setType(java.lang.String type)
Sets the output file type. Allowed type: pdf, xml, html, rtf, xls, jxl, csv and odt.
pdf
The PDF format.
rtf
The RTF format (Rich Text Format).
xls
The Microsoft Excel format generated with Apache POI.
jxl
The Microsoft Excel format generated with JExcelApi.
csv
The CSV format (Comma-Separated Values)
odt
The OpenOffice Writer format

Parameters:
type - type of output file. If type is null, assign it a default value "pdf".
Since:
3.0.3

getLocale

java.util.Locale getLocale()
Returns the output file locale.

Default: null (means the ZK default, Locales.getCurrent())).

getLocale() getParameters() with a value
associated with JRParameter.REPORT_LOCALE
What is used
X ignored X
null Y Y
null null Locales.getCurrent()

Since:
3.0.4

setLocale

void setLocale(java.util.Locale locale)
Sets the output file locale.

Parameters:
locale - the locale. If null, the ZK default is used ( Locales.getCurrent()).
Since:
3.0.4
See Also:
getLocale()


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo