Package org.adempiere.webui.desktop

Interface IDesktop

All Superinterfaces:
UIPart
All Known Implementing Classes:
AbstractDesktop, DefaultDesktop, TabbedDesktop
public interface IDesktop extends UIPart
Interface for iDempiere desktop
Author:
hengsin

  • Field Details

    • WINDOWNO_ATTRIBUTE

      static final String WINDOWNO_ATTRIBUTE
      See Also:

    • ACTIVITIES_EVENT_QUEUE

      static final String ACTIVITIES_EVENT_QUEUE
      EventQueue name for activities (workflow activities, request, notice and unprocessed documents)
      See Also:

    • ON_ACTIVITIES_CHANGED_EVENT

      static final String ON_ACTIVITIES_CHANGED_EVENT
      See Also:

    • ON_CLOSE_WINDOW_SHORTCUT_EVENT

      static final String ON_CLOSE_WINDOW_SHORTCUT_EVENT
      Event when closing window/tab with ESC shortcut key
      See Also:

  • Method Details

    • getClientInfo

      ClientInfo getClientInfo()
      Get client (browser) info
      Returns:
      ClientInfo

    • onMenuSelected

      void onMenuSelected(int nodeId)
      Launch menu item
      Parameters:
      nodeId -

    • onNewRecord

      void onNewRecord(int menuId)
      Launch AD Window in new record mode
      Parameters:
      menuId -

    • registerWindow

      int registerWindow(Object window)
      Register new window
      Parameters:
      window -
      Returns:
      windowNo for new window

    • findWindow

      Object findWindow(int WindowNo)
      Find window via registered window no
      Parameters:
      WindowNo -
      Returns:
      Object

    • findWindowNo

      int findWindowNo(org.zkoss.zk.ui.Component component)
      Find registered window no via component tree
      Parameters:
      component -
      Returns:
      register window no or -1 if not found

    • closeActiveWindow

      boolean closeActiveWindow()
      Close active window
      Returns:
      boolean

    • getActiveWindow

      org.zkoss.zk.ui.Component getActiveWindow()
      Get active window
      Returns:
      Component

    • closeWindow

      boolean closeWindow(int windowNo)
      Close window via registered window no
      Parameters:
      windowNo -
      Returns:
      boolean

    • showURL

      void showURL(String url, boolean closeable)
      Show URL in desktop window
      Parameters:
      url -
      closeable -

    • showHTMLContent

      void showHTMLContent(String content, String title, boolean closeable)
      Show HTML content in desktop window
      Parameters:
      content -
      title -
      closeable -

    • showWindow

      void showWindow(Window win)
      Show window in desktop
      Parameters:
      win -

    • showWindow

      void showWindow(Window win, String position)
      Show window in desktop
      Parameters:
      win -
      position -

    • showZoomWindow

      void showZoomWindow(int window_ID, MQuery query)
      Zoom to AD window and show in desktop
      Parameters:
      window_ID - AD_Window_ID
      query -

    • showWindow

      void showWindow(int window_ID, MQuery query)
      Deprecated.
      Parameters:
      window_ID -
      query -

    • unregisterWindow

      void unregisterWindow(int windowNo)
      Remove registered window
      Parameters:
      windowNo -

    • openProcessDialog

      ProcessDialog openProcessDialog(int processId, boolean soTrx)
      Open process dialog in desktop
      Parameters:
      processId -
      soTrx -
      Returns:
      ProcessDialog

    • openForm

      ADForm openForm(int formId)
      Open AD form in desktop
      Parameters:
      formId -
      Returns:
      ADWindow

    • openInfo

      void openInfo(int infoId)
      Open info window in desktop
      Parameters:
      infoId -

    • openWindow

      void openWindow(int windowId, Callback<ADWindow> callback)
      Open AD window in desktop
      Parameters:
      windowId - AD_Window_ID
      callback -

    • openWindow

      void openWindow(int windowId, MQuery query, Callback<ADWindow> callback)
      Open AD window in desktop
      Parameters:
      windowId - AD_Window_ID
      query -
      callback -

    • openTask

      void openTask(int task_ID)
      Open operating system task window
      Parameters:
      task_ID -

    • openWorkflow

      void openWorkflow(int workflow_ID)
      Open workflow window in desktop
      Parameters:
      workflow_ID -

    • getComponent

      org.zkoss.zk.ui.Component getComponent()
      Get root component of desktop
      Specified by:
      getComponent in interface UIPart
      Returns:
      Component

    • setPage

      void setPage(org.zkoss.zk.ui.Page page)
      Attached to page
      Parameters:
      page -

    • setClientInfo

      void setClientInfo(ClientInfo clientInfo)
      Set client (browser) info
      Parameters:
      clientInfo -

    • logout

      void logout()
      User logout from desktop, do clean up

    • logout

      default void logout(Callback<Boolean> callback)
      Logout from desktop (call logout().
      Parameters:
      callback - callback after logout

    • updateHelpContext

      void updateHelpContext(String ctxType, int infoWindowId, InfoPanel infoPanel)
      Update help content in help/info panel
      Parameters:
      infoWindowId -
      infoPanel -

    • updateHelpContext

      void updateHelpContext(String ctxType, int recordId)
      Update help content in help/info panel
      Parameters:
      ctxType -
      recordId -

    • updateHelpTooltip

      void updateHelpTooltip(GridField gridField)
      Update tooltip content in help/info panel
      Parameters:
      gridField -

    • updateHelpTooltip

      default void updateHelpTooltip(String hdr, String desc, String help, String otherContent)
      Update tooltip content in help/info panel
      Parameters:
      hdr -
      desc -
      help -
      otherContent -

    • updateHelpTooltip

      void updateHelpTooltip(String hdr, String desc, String help, String otherContent, String entityType)
      Update tooltip content in help/info panel
      Parameters:
      hdr -
      desc -
      help -
      otherContent -
      entityType -

    • updateHelpQuickInfo

      void updateHelpQuickInfo(GridTab gridTab)
      Update quick info (status line) in help/info panel
      Parameters:
      gridTab -

    • updateHelpQuickInfo

      void updateHelpQuickInfo(InfoPanel infoPanel)
      Update quick info (status line) in help/info panel
      Parameters:
      infoPanel -

    • isPendingWindow

      boolean isPendingWindow()
      Is pending changes to be saved
      Returns:
      true if there are changes not save yet

    • setTabTitle

      void setTabTitle(String title, int windowNo)
      Update tab title by windowNo
      Parameters:
      title -
      windowNo -

    • renderHomeTab

      void renderHomeTab()
      Render home tab

    • isCloseTabWithShortcut

      boolean isCloseTabWithShortcut()
      Is closing tab with ESC shortcut key allowed
      Returns:
      true if allowed

    • setCloseTabWithShortcut

      void setCloseTabWithShortcut(boolean isCloseTabWithShortcut)
      Set if closing tab with ESC shortcut key is allowed
      Parameters:
      isCloseTabWithShortcut -