Package org.adempiere.webui.window

Class ZkReportViewer

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Window
org.adempiere.webui.component.Window
org.adempiere.webui.window.ZkReportViewer
All Implemented Interfaces:
Serializable, Cloneable, ISupportMask, IReportViewerExportSource, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.ext.Framable
public class ZkReportViewer extends Window implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, IReportViewerExportSource
Report Viewer.
Author:
Jorg Janke globalqss: integrate phib contribution from https://sourceforge.net/p/adempiere/patches/4/ globalqss: integrate Teo Sarca bug fixing Colin Rooney 2007/03/20 RFE#1670185 and BUG#1684142 Extend security to Info queries, Teo Sarca, SC ARHIPAC SERVICE SRL
  • FR [ 1762466 ] Add "Window" menu to report viewer.
  • FR [ 1894640 ] Report Engine: Excel Export support, Low Heng Sin
    • See Also:

    • Nested Class Summary

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

      Nested classes/interfaces inherited from class org.zkoss.zul.Window

      org.zkoss.zul.Window.Mode

      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

      Nested classes/interfaces inherited from interface org.adempiere.webui.window.IReportViewerExportSource

      IReportViewerExportSource.ExportFormat

    • Field Summary

      Fields
      Modifier and Type
      Field
      Description
      protected static final String
      CSV_OUTPUT_TYPE
       
      protected static final String
      HTML_OUTPUT_TYPE
       
      protected ReportEngine
      m_reportEngine
      Report Engine
      protected int
      m_WindowNo
      Window No
      protected org.zkoss.util.media.AMedia
      media
       
      protected static final String
      PDF_OUTPUT_TYPE
       
      protected Listbox
      previewType
      List box for preview type (pdf, html, etc)
      protected Map<MAuthorizationAccount,IUploadService>
      uploadServicesMap
       
      protected static final String
      XLS_OUTPUT_TYPE
       
      protected static final String
      XLSX_OUTPUT_TYPE
       

      Fields inherited from class org.adempiere.webui.component.Window

      INSERT_END, INSERT_NEXT, INSERT_POSITION_KEY, MODE_EMBEDDED, MODE_HIGHLIGHTED, MODE_KEY, MODE_MODAL, MODE_OVERLAPPED, MODE_POPUP, REPLACE, showMaskWrapper

      Fields inherited from class org.zkoss.zul.Window

      EMBEDDED, HIGHLIGHTED, MODAL, OVERLAPPED, POPUP

      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_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

      Fields inherited from interface org.adempiere.webui.window.IReportViewerExportSource

      CSV_FILE_EXT, CSV_MIME_TYPE, EXCEL_FILE_EXT, EXCEL_MIME_TYPE, EXCEL_XML_FILE_EXT, EXCEL_XML_MIME_TYPE, HTML_FILE_EXT, HTML_MIME_TYPE, PDF_FILE_EXT, PDF_MIME_TYPE, POSTSCRIPT_FILE_EXT, POSTSCRIPT_MIME_TYPE, SSV_FILE_EXT, TEXT_FILE_EXT, TEXT_MIME_TYPE, XML_FILE_EXT, XML_MIME_TYPE

      Fields inherited from interface org.adempiere.webui.ISupportMask

      READY_SHOW_MASK_FLAG

    • Constructor Summary

      Constructors
      Constructor
      Description
      ZkReportViewer(ReportEngine re, String title)
       

    • Method Summary

      Modifier and Type
      Method
      Description
      void
      actionPerformed(org.zkoss.zk.ui.event.Event e)
      Handle event
      String
      getContentType()
       
      IReportViewerExportSource.ExportFormat[]
      getExportFormats()
       
      Object
      getExtraCtrl()
       
      String
      getFileExtension()
       
      org.zkoss.util.media.AMedia
      getMedia(String rendererId)
       
      org.zkoss.util.media.AMedia
      getMedia(String contentType, String fileExtension)
      Get media/content by content type and file extension
      ReportEngine
      getReportEngine()
      Get report engine
      String
      getReportName()
       
      Map<MAuthorizationAccount,IUploadService>
      getUploadServiceMap()
       
      void
      hideBusyMask()
       
      void
      onClose()
      Close viewer
      void
      onEvent(org.zkoss.zk.ui.event.Event event)
       
      void
      onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
       
      void
      onPageDetached(org.zkoss.zk.ui.Page page)
       
      protected void
      setLanguage()
      Set language to m_reportEngine
      protected void
      setPreviewType()
      Set preview type to m_reportEngine
      void
      updateToolbarAccess(int AD_Window_ID, int AD_Process_ID)
      Hide not accessible toolbar

      Methods inherited from class org.adempiere.webui.component.Window

      dispose, getMaskComponent, getMaskObj, getModeAttribute, hideMask, isFireWindowCloseEventOnDetach, setFireWindowCloseEventOnDetach, showMask

      Methods inherited from class org.zkoss.zul.Window

      beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getContentSclass, getContentStyle, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onModal, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible

      Methods inherited from class org.zkoss.zul.impl.XulElement

      getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

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

      addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, 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, 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, invalidate, isChildable, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, 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, 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

      Methods inherited from interface org.zkoss.zk.ui.IdSpace

      getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

      Methods inherited from interface org.zkoss.zk.ui.ext.Scope

      addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

    • Field Details

    • Constructor Details

      • ZkReportViewer

        public ZkReportViewer(ReportEngine re, String title)
        Parameters:
        re -
        title -

    • Method Details

      • onPageAttached

        public void onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
        Specified by:
        onPageAttached in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        onPageAttached in class org.zkoss.zk.ui.AbstractComponent

      • onPageDetached

        public void onPageDetached(org.zkoss.zk.ui.Page page)
        Specified by:
        onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        onPageDetached in class Window

      • onClose

        public void onClose()
        Close viewer
        Overrides:
        onClose in class org.zkoss.zul.Window

      • onEvent

        public void onEvent(org.zkoss.zk.ui.event.Event event) throws Exception
        Specified by:
        onEvent in interface org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>
        Throws:
        Exception

      • actionPerformed

        public void actionPerformed(org.zkoss.zk.ui.event.Event e)
        Handle event
        Parameters:
        e - event

      • setLanguage

        protected void setLanguage()
        Set language to m_reportEngine

      • setPreviewType

        protected void setPreviewType()
        Set preview type to m_reportEngine

      • getExtraCtrl

        public Object getExtraCtrl()
        Specified by:
        getExtraCtrl in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        getExtraCtrl in class org.zkoss.zk.ui.HtmlBasedComponent

      • updateToolbarAccess

        public void updateToolbarAccess(int AD_Window_ID, int AD_Process_ID)
        Hide not accessible toolbar
        Parameters:
        AD_Window_ID -
        AD_Process_ID -

      • hideBusyMask

        public void hideBusyMask()

      • getMedia

        public org.zkoss.util.media.AMedia getMedia(String contentType, String fileExtension)
        Description copied from interface: IReportViewerExportSource
        Get media/content by content type and file extension
        Specified by:
        getMedia in interface IReportViewerExportSource
        Returns:
        AMedia

      • getMedia

        public org.zkoss.util.media.AMedia getMedia(String rendererId)

      • getExportFormats

        public IReportViewerExportSource.ExportFormat[] getExportFormats()
        Specified by:
        getExportFormats in interface IReportViewerExportSource
        Returns:
        list of supported export formats

      • getContentType

        public String getContentType()
        Specified by:
        getContentType in interface IReportViewerExportSource
        Returns:
        current mime/content type

      • getFileExtension

        public String getFileExtension()
        Specified by:
        getFileExtension in interface IReportViewerExportSource
        Returns:
        current file extension/format

      • getUploadServiceMap

        public Map<MAuthorizationAccount,IUploadService> getUploadServiceMap()
        Specified by:
        getUploadServiceMap in interface IReportViewerExportSource
        Returns:
        list of available authorized upload services

      • getReportName

        public String getReportName()
        Specified by:
        getReportName in interface IReportViewerExportSource
        Returns:
        name of report

      • getReportEngine

        public ReportEngine getReportEngine()
        Get report engine
        Returns:
        report engine