Package org.adempiere.webui.apps

Class ProcessDialog

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.ProcessDialog
All Implemented Interfaces:
Serializable, Cloneable, IProcessUI, ISupportMask, IHelpContext, 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 ProcessDialog extends AbstractProcessDialog implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, IHelpContext, ITabOnCloseHandler
Embedded Dialog to Start process or report. 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
    Modifier and Type
    Field
    Description
    static final String
    ON_INITIAL_FOCUS_EVENT
     
    static final String
    SAVED_PREDEFINED_CONTEXT_VARIABLES
     

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

    bCancel, bOK, bottomParameterLayout, fPrintFormat, freportType, fSavedName, m_TabNo, 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.ISupportMask

    READY_SHOW_MASK_FLAG

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProcessDialog(int AD_Process_ID, boolean isSOTrx)
    Dialog to start a process/report
    ProcessDialog(int AD_Process_ID, boolean isSOTrx, String predefinedContextVariables)
    Dialog to start a process/report

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Dispose
    void
    hideBusyDialog()
    Close process in progress dialog.
    void
    onAfterProcess()
    Handle onAfterProcess event echo from swithToFinishScreen()
    void
    onClose(Tabpanel tabPanel)
    NOTE onClose method must implement the actual closing of the tab
    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)
     
    void
    onPrintInvoices()
    Handle onPrintInvoices event echo by printInvoices()
    void
    onPrintShipments()
    Handle onPrintShipments event echo by printShipments()
    protected void
    replaceComponent(org.zkoss.zk.ui.HtmlBasedComponent newComponent, org.zkoss.zk.ui.HtmlBasedComponent oldComponent)
    replace oldComponent with newComponent
    boolean
    setVisible(boolean visible)
    Set Visible (set focus to OK if visible)
    void
    showBusyDialog()
    Show process in progress dialog.
    protected void
    swithToFinishScreen()
    Switch to process execution result panel.
    void
    updateUI()
    Update UI with the result of process execution.

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

    ask, askForInput, askForInput, askForSecretInput, autoStart, 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

  • Field Details

  • Constructor Details

    • ProcessDialog

      public ProcessDialog(int AD_Process_ID, boolean isSOTrx)
      Dialog to start a process/report
      Parameters:
      AD_Process_ID -
      isSOTrx -

    • ProcessDialog

      public ProcessDialog(int AD_Process_ID, boolean isSOTrx, String predefinedContextVariables)
      Dialog to start a process/report
      Parameters:
      AD_Process_ID -
      isSOTrx -
      predefinedContextVariables -

  • 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

    • 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

    • onEvent

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

    • showBusyDialog

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

    • hideBusyDialog

      public void hideBusyDialog()
      Description copied from class: AbstractProcessDialog
      Close process in progress dialog.
      Specified by:
      hideBusyDialog 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

    • swithToFinishScreen

      protected void swithToFinishScreen()
      Switch to process execution result panel.

    • replaceComponent

      protected void replaceComponent(org.zkoss.zk.ui.HtmlBasedComponent newComponent, org.zkoss.zk.ui.HtmlBasedComponent oldComponent)
      replace oldComponent with newComponent
      Parameters:
      newComponent -
      oldComponent -

    • onAfterProcess

      public void onAfterProcess()
      Handle onAfterProcess event echo from swithToFinishScreen()

    • onPrintShipments

      public void onPrintShipments()
      Handle onPrintShipments event echo by printShipments()

    • onPrintInvoices

      public void onPrintInvoices()
      Handle onPrintInvoices event echo by printInvoices()

    • 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