Package org.adempiere.webui.apps

Class ProcessParameterPanel

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Div
org.adempiere.webui.component.Panel
org.adempiere.webui.apps.ProcessParameterPanel
All Implemented Interfaces:
Serializable, Cloneable, ValueChangeListener, IProcessParameter, Evaluatee, 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.sys.ComponentCtrl
public class ProcessParameterPanel extends Panel implements ValueChangeListener, IProcessParameter, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, Evaluatee
Process Parameter Panel.
Embedded in ProcessDialog and ProcessModalDialog.
Capture parameters input, validate and save to DB.
Version:
2006-12-01
Author:
Low Heng Sin
See Also:

  • Nested Class Summary

    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, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

  • Field Summary

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

    HORIZONTAL, VERTICAL

    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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProcessParameterPanel(int WindowNo, int tabNo, ProcessInfo pi)
    Dynamic generated Parameter panel.
    ProcessParameterPanel(int WindowNo, ProcessInfo pi)
    Dynamic generated Parameter panel.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Dispose
    boolean
    focusToFirstEditor()
    Focus to first visible field editor.
    String
    get_ValueAsString(String variableName)
    Get Variable Value
    WEditor
    getEditor(String columnName)
    Get parameter field editor by column name
    WEditor
    getEditorTo(String columnName)
    Get parameter field to editor by column name
    MPInstancePara[]
    getParameters()
    Get parameter values from editors without saving to DB.
    ProcessInfo
    getProcessInfo()
    Get process info
    int
    getWindowNo()
     
    boolean
    init()
    Render all visible fields
    boolean
    isWaitingForDialog()
    Is WSearchEditor showing dialog that is awaiting user action
    boolean
    loadParameters(MPInstance instance)
    Load parameters from saved instance
    boolean
    loadParametersFromProcessInfo(ProcessInfo pi)
    Load parameters from Process Info
    void
    onEvent(org.zkoss.zk.ui.event.Event event)
     
    protected void
    restoreContext()
    Restore window context.
    boolean
    saveParameters()
    Save parameter values to MPInstancePara.
    void
    setProcessInfo(ProcessInfo processInfo)
     
    static String
    validate(Object value, String valueMin, String valueMax, boolean isMandatory, int fieldType)
    Validate mandatory and min/max value
    boolean
    validateParameters()
    Validate Parameter values
    void
    valueChange(ValueChangeEvent evt)
    Editor value change listener.

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

    clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, renderProperties, 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, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, service, 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, isChildable, 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 Details

    • ProcessParameterPanel

      public ProcessParameterPanel(int WindowNo, ProcessInfo pi)
      Dynamic generated Parameter panel.
      Parameters:
      WindowNo - register window number
      pi - process info

    • ProcessParameterPanel

      public ProcessParameterPanel(int WindowNo, int tabNo, ProcessInfo pi)
      Dynamic generated Parameter panel.
      Parameters:
      WindowNo - register window number
      tabNo - tabNo
      pi - process info

  • Method Details

    • dispose

      public void dispose()
      Dispose

    • init

      public boolean init()
      Render all visible fields
      Returns:
      true if loaded OK

    • validateParameters

      public boolean validateParameters()
      Validate Parameter values
      Returns:
      true if parameters are valid

    • validate

      public static String validate(Object value, String valueMin, String valueMax, boolean isMandatory, int fieldType)
      Validate mandatory and min/max value
      Parameters:
      value -
      valueMin -
      valueMax -
      isMandatory -
      fieldType -
      Returns:
      null if OK, any message if not OK

    • loadParameters

      public boolean loadParameters(MPInstance instance)
      Load parameters from saved instance
      Parameters:
      instance -

    • loadParametersFromProcessInfo

      public boolean loadParametersFromProcessInfo(ProcessInfo pi)
      Load parameters from Process Info
      Parameters:
      pi -

    • saveParameters

      public boolean saveParameters()
      Save parameter values to MPInstancePara.
      Specified by:
      saveParameters in interface IProcessParameter
      Returns:
      true if parameters saved

    • getParameters

      public MPInstancePara[] getParameters()
      Get parameter values from editors without saving to DB.
      Returns:
      MPInstancePara[], list of parameter values.

    • valueChange

      public void valueChange(ValueChangeEvent evt)
      Editor value change listener.
      Specified by:
      valueChange in interface ValueChangeListener
      Parameters:
      evt - ValueChangeEvent

    • 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

    • restoreContext

      protected void restoreContext()
      Restore window context. author teo_sarca [ 1699826 ]
      See Also:

    • setProcessInfo

      public void setProcessInfo(ProcessInfo processInfo)
      Parameters:
      processInfo -

    • getProcessInfo

      public ProcessInfo getProcessInfo()
      Get process info
      Returns:
      process info

    • focusToFirstEditor

      public boolean focusToFirstEditor()
      Focus to first visible field editor.
      Returns:
      true if there is at least one visible field editor.

    • getEditor

      public WEditor getEditor(String columnName)
      Get parameter field editor by column name
      Parameters:
      columnName -
      Returns:
      editor

    • getEditorTo

      public WEditor getEditorTo(String columnName)
      Get parameter field to editor by column name
      Parameters:
      columnName -
      Returns:
      editor

    • isWaitingForDialog

      public boolean isWaitingForDialog()
      Is WSearchEditor showing dialog that is awaiting user action
      Returns:
      true if WSearchEditor is showing dialog that is awaiting user action (usually info window).

    • getWindowNo

      public int getWindowNo()
      Returns:
      register window number.

    • get_ValueAsString

      public String get_ValueAsString(String variableName)
      Description copied from interface: Evaluatee
      Get Variable Value
      Specified by:
      get_ValueAsString in interface Evaluatee
      Parameters:
      variableName - name
      Returns:
      value