Package org.zkoss.zkex.zul

Class Jasperreport

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public class Jasperreport
extends org.zkoss.zul.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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected class  Jasperreport.ExtraCtrl
      A utility class to implement HtmlBasedComponent.getExtraCtrl().
      class  Jasperreport.JasperreporteExporterImpl  

      • Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

        org.zkoss.zk.ui.AbstractComponent.Children, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

    • Field Summary

      • Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        _zclass

      • Fields inherited from interface org.zkoss.zk.ui.Component

        APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

      • Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

        AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_CLONED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.sql.Connection getDataConnection()
      Returns the JasperReports Data Connection.
      net.sf.jasperreports.engine.JRDataSource getDatasource()
      Returns the JasperReports DataSource.
      protected java.lang.String getEncodedSrc()  
      java.lang.String getExportName()
      Returns the export file name for the download if any, the full name will be exportName + "." + format.
      java.lang.Object getExtraCtrl()  
      JasperreportExporterFactory getJasperreporteExporterFactory()  
      java.util.Locale getLocale()
      Returns the output file locale.
      java.util.Map<java.lang.String,​java.lang.Object> getParameters()
      Returns the JasperReports Parameters.
      org.zkoss.util.media.Media getReport()
      Returns a AMedia contains report's byte stream.
      java.lang.String getSrc()
      Returns the source (jasper file).
      java.lang.String getType()
      Returns the output file type.
      boolean isHibernate()
      Returns whether enable the hibernate data source.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void setContent​(org.zkoss.util.media.Media media)
      Sets the content directly.
      void setDataConnection​(java.sql.Connection connection)
      Sets the JasperReports Data Connection.
      void setDatasource​(net.sf.jasperreports.engine.JRDataSource dataSource)
      Sets the JasperReports DataSource.
      void setExportName​(java.lang.String exportName)
      Sets the export file name for the download if any, the full name will be exportName + "." + format.
      void setHibernate​(boolean hibernate)
      Sets whether enable the hibernate data source.
      void setJasperreporteExporterFactory​(java.lang.String clsnm)  
      void setJasperreporteExporterFactory​(JasperreportExporterFactory factory)
      Set the factory to use your own exporter, reference to JasperreportExporterFactory
      void setLocale​(java.util.Locale locale)
      Sets the output file locale.
      void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Sets the JasperReports Parameters.
      void setSrc​(java.lang.String src)
      Sets the source (jasper file).
      void setType​(java.lang.String type)
      Sets the output file type.

      • Methods inherited from class org.zkoss.zul.Iframe

        getContent, getName, getScrolling, isAutohide, isChildable, service, setAutohide, setName, setScrolling

      • Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        addSclass, clone, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getPropertyAccess, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

      • Methods inherited from class org.zkoss.zk.ui.AbstractComponent

        addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onParentChanged, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Jasperreport

        public Jasperreport()

      • Jasperreport

        public Jasperreport​(java.lang.String src)

    • Method Detail

      • getSrc

        public java.lang.String getSrc()
        Returns the source (jasper file).
        Overrides:
        getSrc in class org.zkoss.zul.Iframe
        Returns:
        src The compiled file (jasper file).

      • setSrc

        public void setSrc​(java.lang.String src)
        Sets the source (jasper file).

        If src is changed, the whole component is redrawn.

        Overrides:
        setSrc in class org.zkoss.zul.Iframe
        Parameters:
        src - The compiled file (jasper file). If null or empty, nothing is included.

      • setContent

        public void setContent​(org.zkoss.util.media.Media media)
        Sets the content directly.

        Default: null.

        Calling this method implies setSrc(null). In other words, the last invocation of setContent(org.zkoss.util.media.Media) overrides the previous setSrc(java.lang.String), if any.

        Overrides:
        setContent in class org.zkoss.zul.Iframe
        Parameters:
        media - the media to display.
        Since:
        5.0.0
        See Also:
        setSrc(java.lang.String)

      • getParameters

        public java.util.Map<java.lang.String,​java.lang.Object> getParameters()
        Returns the JasperReports Parameters.

        Default: null.

      • setParameters

        public void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Sets the JasperReports Parameters. To provide exporter parameters, include an entry with key "exportParameter" and value as another parameter Map. For example: 
        
        String key = JRXlsAbstractExporterParameter.PROPERTY_ONE_PAGE_PER_SHEET.toString();
        Map parameters = new HashMap();
        Map exportParams = new HashMap();
        exportParams.put(key, false);
        parameters.put("exportParameter", exportParams);
        report.setParameters(parameters);
        Parameters:
        parameters - use to fill the report

      • setHibernate

        public void setHibernate​(boolean hibernate)
        Sets whether enable the hibernate data source.
        Since:
        5.0.1

      • isHibernate

        public boolean isHibernate()
        Returns whether enable the hibernate data source.

        Default: false

        Since:
        5.0.1

      • getDatasource

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

        Default: null.

      • setDatasource

        public void setDatasource​(net.sf.jasperreports.engine.JRDataSource dataSource)
        Sets the JasperReports DataSource.
        Parameters:
        dataSource - use to fill the report

      • setDataConnection

        public void setDataConnection​(java.sql.Connection connection)
        Sets the JasperReports Data Connection.
        Parameters:
        connection - use to fill the report
        Since:
        5.0.1

      • getDataConnection

        public java.sql.Connection getDataConnection()
        Returns the JasperReports Data Connection.

        Default: null

        Since:
        5.0.1

      • getType

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

        Default: pdf.

        Since:
        3.0.3

      • setType

        public 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

        public 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
        XignoredX
        nullYY
        nullnullLocales.getCurrent()
        Since:
        3.0.4

      • setLocale

        public 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()

      • getExportName

        public java.lang.String getExportName()
        Returns the export file name for the download if any, the full name will be exportName + "." + format. Note: exportName can not be empty or null. Default: "report".
        Returns:
        export file name
        Since:
        8.6.1

      • setExportName

        public void setExportName​(java.lang.String exportName)
        Sets the export file name for the download if any, the full name will be exportName + "." + format. Note: exportName can not be empty or null.
        Parameters:
        exportName - the export file name
        Throws:
        java.lang.IllegalArgumentException - if exportName is empty or null.
        Since:
        8.6.1

      • setJasperreporteExporterFactory

        public void setJasperreporteExporterFactory​(java.lang.String clsnm)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.InstantiationException,
                                            java.lang.reflect.InvocationTargetException,
                                            java.lang.ClassNotFoundException,
                                            java.lang.IllegalAccessException
        Parameters:
        clsnm -
        Throws:
        java.lang.NoSuchMethodException
        java.lang.InstantiationException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        Since:
        5.0.8
        See Also:
        setJasperreporteExporterFactory(JasperreportExporterFactory)

      • getEncodedSrc

        protected java.lang.String getEncodedSrc()
        Overrides:
        getEncodedSrc in class org.zkoss.zul.Iframe

      • getExtraCtrl

        public java.lang.Object getExtraCtrl()
        Specified by:
        getExtraCtrl in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        getExtraCtrl in class org.zkoss.zul.Iframe

      • getReport

        public org.zkoss.util.media.Media getReport()
        Returns a AMedia contains report's byte stream.
        Since:
        6.0.0

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
        Overrides:
        renderProperties in class org.zkoss.zul.Iframe
        Throws:
        java.io.IOException