Package org.adempiere.webui.apps

Class ProcessModalDialog

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.apps.AbstractProcessDialog
org.adempiere.webui.apps.ProcessModalDialog
All Implemented Interfaces:
Serializable, Cloneable, IProcessUI, DialogEvents, ISupportMask, ITabOnCloseHandler, 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 ProcessModalDialog extends AbstractProcessDialog implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, DialogEvents, ITabOnCloseHandler
Modal Dialog to Start process. Displays information about the process and lets the user decide to start it and displays results (optionally print them). Calls ProcessCtl to execute.
Author:
Low Heng Sin, arboleda - globalqss - Implement ShowHelp option on processes and reports
See Also:

  • Nested Class Summary

    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.HtmlBasedComponent

    org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

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

    org.zkoss.zk.ui.AbstractComponent.Children

  • Field Summary

    Fields inherited from class org.adempiere.webui.apps.AbstractProcessDialog

    bCancel, bOK, bottomParameterLayout, fPrintFormat, freportType, fSavedName, m_TabNo, m_WindowNo, mainParameterLayout, topParameterLayout

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

    Fields inherited from interface org.adempiere.webui.event.DialogEvents

    ON_BEFORE_RUN_PROCESS, ON_WINDOW_CLOSE

    Fields inherited from interface org.adempiere.webui.ISupportMask

    READY_SHOW_MASK_FLAG

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProcessModalDialog(int WindowNo, int AD_Process_ID, int tableId, int recordId, boolean autoStart)
     
    ProcessModalDialog(int WindowNo, ProcessInfo pi, boolean autoStart)
     
    ProcessModalDialog(Window parent, String title, int WindowNo, int AD_Process_ID, int tableId, int recordId, boolean autoStart)
    Deprecated. 
    ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, boolean isReRun, ProcessInfo pi)
     
    ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, int AD_Process_ID, int tableId, int recordId, boolean autoStart)
    Dialog to start a process/report
    ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, int AD_Process_ID, int tableId, int recordId, String recordUU, boolean autoStart)
    Dialog to start a process/report
    ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, int TabNo, ProcessInfo pi, boolean autoStart)
     
    ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, ProcessInfo pi)
     
    ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, ProcessInfo pi, boolean autoStart)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    autoStart()
    Auto start process upon instantiation of process dialog.
    void
    dispose()
    Dispose
    void
    hideBusyDialog()
    Close process in progress dialog.
    protected void
    onClientInfo()
    Handle client info event from browser
    void
    onClose(Tabpanel tabPanel)
    NOTE onClose method must implement the actual closing of the tab
    void
    onEvent(org.zkoss.zk.ui.event.Event event)
    handle events
    void
    onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
     
    void
    onPageDetached(org.zkoss.zk.ui.Page page)
     
    boolean
    setVisible(boolean visible)
    Set Visible (set focus to OK if visible)
    void
    showBusyDialog()
    Show process in progress dialog.
    void
    updateUI()
    Update UI with the result of process execution.

    Methods inherited from class org.adempiere.webui.apps.AbstractProcessDialog

    ask, askForInput, askForInput, askForSecretInput, bottomLayout, buttonLayout, cancelProcess, chooseSaveParameter, closeBusyDialog, createBusyDialog, deleteSaveParameter, download, focus, getAD_Process_ID, getComboItem, getCtx, getDownloadFiles, getInitialMessage, getLastRun, getName, getNotificationType, getParameterPanel, getProcessInfo, getShowHelp, getWindowNo, init, init, inputParameterLayout, isBackgroundJob, isCancel, isJasperReport, isReport, isUILocked, isValid, layout, loadSavedParams, lockUI, overalLayout, querySaved, reportOptionLayout, runBackgroundJob, runProcess, savePrameterLayout, saveReportOption, saveReportOptionToInstance, setHeadMessage, setProcessInfo, showInfoWindow, showReports, startProcess, statusUpdate, topLayout, unlockUI, updateSaveParameter

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

    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, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost

    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, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, 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, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, 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, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, 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, setWidgetAttribute, 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.sys.ComponentCtrl

    invalidatePartial

    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

  • Constructor Details

    • ProcessModalDialog

      public ProcessModalDialog(int WindowNo, ProcessInfo pi, boolean autoStart)
      Parameters:
      WindowNo -
      pi -
      autoStart -

    • ProcessModalDialog

      public ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, ProcessInfo pi)
      Parameters:
      listener -
      WindowNo -
      pi -

    • ProcessModalDialog

      public ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, boolean isReRun, ProcessInfo pi)
      Parameters:
      listener -
      WindowNo -
      isReRun -
      pi -

    • ProcessModalDialog

      public ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, ProcessInfo pi, boolean autoStart)
      Parameters:
      listener -
      WindowNo -
      pi -
      autoStart -

    • ProcessModalDialog

      public ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, int TabNo, ProcessInfo pi, boolean autoStart)
      Parameters:
      listener -
      WindowNo -
      TabNo -
      pi -
      autoStart -

    • ProcessModalDialog

      public ProcessModalDialog(int WindowNo, int AD_Process_ID, int tableId, int recordId, boolean autoStart)
      Parameters:
      WindowNo -
      AD_Process_ID -
      tableId -
      recordId -
      autoStart -

    • ProcessModalDialog

      public ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, int AD_Process_ID, int tableId, int recordId, boolean autoStart)
      Dialog to start a process/report
      Parameters:
      WindowNo -
      AD_Process_ID -
      tableId -
      recordId -
      autoStart -

    • ProcessModalDialog

      public ProcessModalDialog(org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener, int WindowNo, int AD_Process_ID, int tableId, int recordId, String recordUU, boolean autoStart)
      Dialog to start a process/report
      Parameters:
      WindowNo -
      AD_Process_ID -
      tableId -
      recordId -
      recordUU -
      autoStart -

    • ProcessModalDialog

      public ProcessModalDialog(Window parent, String title, int WindowNo, int AD_Process_ID, int tableId, int recordId, boolean autoStart)
      Deprecated.
      Dialog to start a process/report
      Parameters:
      parent - not used
      title - not used
      WindowNo -
      AD_Process_ID -
      tableId -
      recordId -
      autoStart -

  • Method Details

    • setVisible

      public boolean setVisible(boolean visible)
      Set Visible (set focus to OK if visible)
      Specified by:
      setVisible in interface org.zkoss.zk.ui.Component
      Overrides:
      setVisible in class org.zkoss.zul.Window
      Parameters:
      visible - true if visible

    • dispose

      public void dispose()
      Dispose
      Overrides:
      dispose in class AbstractProcessDialog

    • autoStart

      public void autoStart()
      Description copied from class: AbstractProcessDialog
      Auto start process upon instantiation of process dialog. Delegate to AbstractProcessDialog.startProcess0().
      Overrides:
      autoStart in class AbstractProcessDialog

    • showBusyDialog

      public void showBusyDialog()
      Description copied from class: AbstractProcessDialog
      Show process in progress dialog.
      Specified by:
      showBusyDialog in class AbstractProcessDialog

    • updateUI

      public void updateUI()
      Description copied from class: AbstractProcessDialog
      Update UI with the result of process execution.
      Specified by:
      updateUI in class AbstractProcessDialog

    • hideBusyDialog

      public void hideBusyDialog()
      Description copied from class: AbstractProcessDialog
      Close process in progress dialog.
      Specified by:
      hideBusyDialog in class AbstractProcessDialog

    • 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

    • onEvent

      public void onEvent(org.zkoss.zk.ui.event.Event event)
      handle events
      Specified by:
      onEvent in interface org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>
      Overrides:
      onEvent in class AbstractProcessDialog

    • onClientInfo

      protected void onClientInfo()
      Handle client info event from browser

    • onClose

      public void onClose(Tabpanel tabPanel)
      Description copied from interface: ITabOnCloseHandler
      NOTE onClose method must implement the actual closing of the tab
      Specified by:
      onClose in interface ITabOnCloseHandler