Interface DesktopAgent

All Superinterfaces:
Agent, QueryAgent
All Known Implementing Classes:
DefaultDesktopAgent

public interface DesktopAgent extends QueryAgent
The desktop agent, represents a server-side ZK desktop
Author:
pao, Dennis, henrichen
  • Method Details

    • getId

      String getId()
      get ID. of this the desktop.
      Returns:
      ID or null if it hasn't.
    • getPages

      List<PageAgent> getPages()
      get pages in this desktop
    • getAttribute

      Object getAttribute(String name)
      get attribute by specify name.
      Parameters:
      name - attribute name.
      Returns:
      attribute value or null if not found or otherwise.
    • destroy

      void destroy()
      destroy this desktop.
    • getDownloadable

      Resource getDownloadable()
      Get the current downloadable resource.
      Returns:
      downloadable resource or null if there is no such resource.
      Since:
      1.1.0
    • getZkLog

      List<String> getZkLog()
      Gets the Clients.log results.
      Returns:
      Messages. An empty list if no message.
      Since:
      2.1.0
    • getDesktop

      org.zkoss.zk.ui.Desktop getDesktop()
      Get the attached Desktop instance.
      Returns:
      the attached Desktop instance.
      Since:
      2.1.0