Package org.adempiere.webui.desktop

Interface IDesktop

All Superinterfaces:
UIPart
All Known Implementing Classes:
AbstractDesktop, DefaultDesktop, TabbedDesktop
public interface IDesktop extends UIPart
Desktop interface
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 shortcut
      See Also:

  • Method Details

    • getClientInfo

      ClientInfo getClientInfo()
      Returns:
      ClientInfo

    • onMenuSelected

      void onMenuSelected(int nodeId)
      Parameters:
      nodeId -

    • registerWindow

      int registerWindow(Object window)
      Parameters:
      window -
      Returns:
      windowNo

    • findWindow

      Object findWindow(int WindowNo)
      Parameters:
      WindowNo -
      Returns:
      Object

    • findWindowNo

      int findWindowNo(org.zkoss.zk.ui.Component component)
      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)
      Parameters:
      windowNo -
      Returns:
      boolean

    • showURL

      void showURL(String url, boolean closeable)
      Parameters:
      url -
      closeable -

    • showHTMLContent

      void showHTMLContent(String content, String title, boolean closeable)
      Parameters:
      content -
      title -
      closeable -

    • showWindow

      void showWindow(Window win)
      Parameters:
      win -

    • showWindow

      void showWindow(Window win, String position)
      Parameters:
      win -
      position -

    • showZoomWindow

      void showZoomWindow(int window_ID, MQuery query)
      Parameters:
      window_ID -
      query -

    • showWindow

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

    • unregisterWindow

      void unregisterWindow(int windowNo)
      Parameters:
      windowNo -

    • openProcessDialog

      ProcessDialog openProcessDialog(int processId, boolean soTrx)
      Parameters:
      processId -
      soTrx -
      Returns:
      ProcessDialog

    • openForm

      ADForm openForm(int formId)
      Parameters:
      formId -
      Returns:
      ADWindow

    • openInfo

      void openInfo(int infoId)
      Parameters:
      infoId -

    • openWindow

      void openWindow(int windowId, Callback<ADWindow> callback)
      Parameters:
      windowId -
      callback -

    • openWindow

      void openWindow(int windowId, MQuery query, Callback<ADWindow> callback)
      Parameters:
      windowId -
      query -
      callback -

    • openTask

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

    • openWorkflow

      void openWorkflow(int workflow_ID)
      Parameters:
      workflow_ID -

    • getComponent

      org.zkoss.zk.ui.Component getComponent()
      Get the root component of the 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)
      Parameters:
      clientInfo -

    • logout

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

    • logout

      default void logout(Callback<Boolean> callback)
      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

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

    • 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()
      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 shortcut allowed
      Returns:
      true if allowed

    • setCloseTabWithShortcut

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