Package org.adempiere.webui.panel

Class ADForm

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.panel.ADForm
All Implemented Interfaces:
Serializable, Cloneable, ISupportMask, IHelpContext, 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
Direct Known Subclasses:
AddAuthorizationForm, CompareCtxHelpSuggestion, CompareFieldSuggestion, CustomForm, MFARegisterForm, WAttributeGrid, WBOMDrop, WCreateFromForm, WCustomizeUserDefTabGridView, WFEditor, WFileImport, WGenForm, WPluginManager, WProcessParameterForm, WSQLProcess, WSQLQuery, WTabEditorForm, WViewPI, WWFActivity
public abstract class ADForm extends Window implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, IHelpContext
Abstract base class for iDempiere Web UI custom form (AD_Form).
Author:
Andrew Kimball
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, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final CLogger
    logger
    The class' logging enabler
    protected int
    m_WindowNo
    window number of desktop tab

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

    DECORATE_INFO, 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.ISupportMask

    READY_SHOW_MASK_FLAG

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ADForm()
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    protected int
    getAdFormId()
    Get AD_Form_ID
    String
    getFormName()
    Get form name
    GridTab
    getGridTab()
     
    IFormController
    getICustomForm()
    Get form controller
    ProcessInfo
    getProcessInfo()
     
    org.zkoss.zul.Window.Mode
    getWindowMode()
    Default to embedded mode, subclass may override this to open form in different mode
    int
    getWindowNo()
    Get registered window number
    protected void
    init(int adFormId, String name)
    Initialise the form
    protected abstract void
    initForm()
    Initialize form layout
    void
    onEvent(org.zkoss.zk.ui.event.Event event)
     
    static ADForm
    openForm(int adFormID)
    Create a new form corresponding to the specified identifier
    static ADForm
    openForm(int formId, String predefinedContextVariables)
    Open a form based on it's ID with the predefined context variables from menu
    static ADForm
    openForm(int adFormID, GridTab gridTab)
    Open a form base on it's ID
    static ADForm
    openForm(int adFormID, GridTab gridTab, ProcessInfo pi)
    Open a form base on it's ID and a Process Info parameters
    static ADForm
    openForm(int adFormID, GridTab gridTab, ProcessInfo pi, String predefinedContextVariables, boolean isSOTrx)
    Open a form base on it's ID and a Process Info parameters with the predefined context variables from menu
    void
    setICustomForm(IFormController customForm)
    Set form controller
    void
    setProcessInfo(ProcessInfo pi)
     

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

    dispose, getMaskComponent, getMaskObj, getModeAttribute, hideMask, isFireWindowCloseEventOnDetach, onPageDetached, 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, onClose, 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, getExtraCtrl, 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, onPageAttached, 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

    • logger

      protected static final CLogger logger
      The class' logging enabler

    • m_WindowNo

      protected int m_WindowNo
      window number of desktop tab

  • Constructor Details

    • ADForm

      protected ADForm()
      Constructor

  • Method Details

    • getWindowNo

      public int getWindowNo()
      Get registered window number
      Returns:
      window number

    • getAdFormId

      protected int getAdFormId()
      Get AD_Form_ID
      Returns:
      AD_Form_ID

    • init

      protected void init(int adFormId, String name)
      Initialise the form
      Parameters:
      adFormId - AD_Form_ID
      name - Name of form

    • initForm

      protected abstract void initForm()
      Initialize form layout

    • getFormName

      public String getFormName()
      Get form name
      Returns:
      form name

    • openForm

      public static ADForm openForm(int adFormID)
      Create a new form corresponding to the specified identifier
      Parameters:
      adFormID - AD_Form_ID
      Returns:
      The created form

    • openForm

      public static ADForm openForm(int formId, String predefinedContextVariables)
      Open a form based on it's ID with the predefined context variables from menu
      Parameters:
      formId -
      predefinedContextVariables - optional predefined context variables from menu
      Returns:
      The created form

    • openForm

      public static ADForm openForm(int adFormID, GridTab gridTab)
      Open a form base on it's ID
      Parameters:
      adFormID -
      gridTab -
      Returns:
      The created form

    • openForm

      public static ADForm openForm(int adFormID, GridTab gridTab, ProcessInfo pi)
      Open a form base on it's ID and a Process Info parameters
      Parameters:
      adFormID -
      gridTab -
      pi -
      Returns:
      The created form

    • openForm

      public static ADForm openForm(int adFormID, GridTab gridTab, ProcessInfo pi, String predefinedContextVariables, boolean isSOTrx)
      Open a form base on it's ID and a Process Info parameters with the predefined context variables from menu
      Parameters:
      adFormID -
      gridTab -
      pi -
      predefinedContextVariables - optional predefined context variables from menu
      isSOTrx -
      Returns:
      The created form

    • 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

    • setProcessInfo

      public void setProcessInfo(ProcessInfo pi)
      Parameters:
      pi -

    • getProcessInfo

      public ProcessInfo getProcessInfo()
      Returns:
      ProcessInfo

    • setICustomForm

      public void setICustomForm(IFormController customForm)
      Set form controller
      Parameters:
      customForm -

    • getICustomForm

      public IFormController getICustomForm()
      Get form controller
      Returns:
      IFormController

    • getWindowMode

      public org.zkoss.zul.Window.Mode getWindowMode()
      Default to embedded mode, subclass may override this to open form in different mode
      Returns:
      Window mode

    • getGridTab

      public GridTab getGridTab()
      Returns:
      GridTab