Package org.adempiere.webui

Class AdempiereWebUI

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.AdempiereWebUI
All Implemented Interfaces:
Serializable, Cloneable, IWebClient, 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 AdempiereWebUI extends org.zkoss.zul.Window implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, IWebClient
Entry point for iDempiere web client (index.zul)
Author:
Ashley G Ramdass, hengsin
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
    static String
    APP_NAME
    org.zkoss.zk.ui.WebApp.name preference from zk.xml
    static final String
    APPLICATION_DESKTOP_KEY
    Desktop attribute to hold IDesktop reference
    static final String
    CHECK_AD_USER_ID_ATTR
    Session attribute to hold current login user id value
    static final String
    DESKTOP_SESSION_INVALIDATED_ATTR
    Boolean attribute to indicate the HTTP session of a Desktop have been invalidated
    static final String
    EXECUTION_CARRYOVER_SESSION_KEY
    Deprecated, for removal: This API element is subject to removal in a future version.
    static final String
    ON_CREATE_LOGIN_WINDOW
     
    static final String
    UID
    Match to version at lang-addon.xml
    static final String
    WIDGET_INSTANCE_NAME
    Attribute for widget instance name, use for Selenium test

    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

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdempiereWebUI()
    default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changeRole(MUser user)
    handle change Role
    IDesktop
    getAppDeskop()
    Get IDesktop instance
    ClientInfo
    getClientInfo()
    Get current ClientInfo
    org.zkforge.keylistener.Keylistener
    getKeylistener()
    Get global key listener
    static String
    getUploadSetting()
     
    UserPreference
    getUserPreference()
    Get current user preference
    static boolean
    isEventThreadEnabled()
    Should always return false
    UserPreference
    loadUserPreference(int userId)
    load user preference by user id
    void
    loginCompleted()
    handle login completed
    void
    logout()
    handle logout
    protected org.zkoss.zk.ui.Session
    logout0()
    Logout current session
    void
    logoutAfterTabDestroyed()
    Auto logout after user close browser tab without first logging out
    void
    onCancel()
    Handle onCancel(escape key) event
    void
    onCreate()
    Handle onCreate event from index.zul, don't call this directly.
    void
    onEvent(org.zkoss.zk.ui.event.Event event)
     
    void
    onOk()
    Handle onOK (enter key) event

    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, onPageDetached, 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

    • CHECK_AD_USER_ID_ATTR

      public static final String CHECK_AD_USER_ID_ATTR
      Session attribute to hold current login user id value
      See Also:

    • DESKTOP_SESSION_INVALIDATED_ATTR

      public static final String DESKTOP_SESSION_INVALIDATED_ATTR
      Boolean attribute to indicate the HTTP session of a Desktop have been invalidated
      See Also:

    • APPLICATION_DESKTOP_KEY

      public static final String APPLICATION_DESKTOP_KEY
      Desktop attribute to hold IDesktop reference
      See Also:

    • ON_CREATE_LOGIN_WINDOW

      public static final String ON_CREATE_LOGIN_WINDOW
      See Also:

    • APP_NAME

      public static String APP_NAME
      org.zkoss.zk.ui.WebApp.name preference from zk.xml

    • UID

      public static final String UID
      Match to version at lang-addon.xml
      See Also:

    • WIDGET_INSTANCE_NAME

      public static final String WIDGET_INSTANCE_NAME
      Attribute for widget instance name, use for Selenium test
      See Also:

    • EXECUTION_CARRYOVER_SESSION_KEY

      @Deprecated(forRemoval=true, since="11") public static final String EXECUTION_CARRYOVER_SESSION_KEY
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Constructor Details

    • AdempiereWebUI

      public AdempiereWebUI()
      default constructor

  • Method Details

    • onCreate

      public void onCreate()
      Handle onCreate event from index.zul, don't call this directly.

    • onOk

      public void onOk()
      Handle onOK (enter key) event

    • onCancel

      public void onCancel()
      Handle onCancel(escape key) event

    • loginCompleted

      public void loginCompleted()
      Description copied from interface: IWebClient
      handle login completed
      Specified by:
      loginCompleted in interface IWebClient

    • getKeylistener

      public org.zkforge.keylistener.Keylistener getKeylistener()
      Description copied from interface: IWebClient
      Get global key listener
      Specified by:
      getKeylistener in interface IWebClient
      Returns:
      key listener

    • logout

      public void logout()
      Description copied from interface: IWebClient
      handle logout
      Specified by:
      logout in interface IWebClient

    • logoutAfterTabDestroyed

      public void logoutAfterTabDestroyed()
      Auto logout after user close browser tab without first logging out
      Specified by:
      logoutAfterTabDestroyed in interface IWebClient

    • logout0

      protected org.zkoss.zk.ui.Session logout0()
      Logout current session
      Returns:
      Session

    • getAppDeskop

      public IDesktop getAppDeskop()
      Description copied from interface: IWebClient
      Get IDesktop instance
      Specified by:
      getAppDeskop in interface IWebClient
      Returns:
      IDesktop

    • 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>

    • loadUserPreference

      public UserPreference loadUserPreference(int userId)
      Description copied from interface: IWebClient
      load user preference by user id
      Specified by:
      loadUserPreference in interface IWebClient
      Parameters:
      userId -
      Returns:
      UserPreference

    • getUserPreference

      public UserPreference getUserPreference()
      Description copied from interface: IWebClient
      Get current user preference
      Specified by:
      getUserPreference in interface IWebClient
      Returns:
      UserPrerence

    • isEventThreadEnabled

      public static boolean isEventThreadEnabled()
      Should always return false
      Returns:
      true if event thread is enabled

    • changeRole

      public void changeRole(MUser user)
      Description copied from interface: IWebClient
      handle change Role
      Specified by:
      changeRole in interface IWebClient

    • getClientInfo

      public ClientInfo getClientInfo()
      Description copied from interface: IWebClient
      Get current ClientInfo
      Specified by:
      getClientInfo in interface IWebClient
      Returns:
      ClientInfo

    • getUploadSetting

      public static String getUploadSetting()
      Returns:
      setting for setUpload call