Package com.pathomation.UI

Class UI

java.lang.Object
com.pathomation.UI.UI
public class UI extends Object
Wrapper class around PMA.UI JavaScript framework

  • Field Details

    • pmaStartUIJavascriptPath

      public static String pmaStartUIJavascriptPath

    • pmaUIJavascriptPath

      public static String pmaUIJavascriptPath

    • pmaUIFrameworkEmbedded

      public static boolean pmaUIFrameworkEmbedded

    • pmaUIViewportCount

      public static int pmaUIViewportCount

    • pmaUIViewports

      public static List<String> pmaUIViewports

    • pmaUIGalleryCount

      public static int pmaUIGalleryCount

    • pmaUIGalleries

      public static List<String> pmaUIGalleries

    • pmaUILoaderCount

      public static int pmaUILoaderCount

    • pmaUILoaders

      public static List<String> pmaUILoaders

    • logger

      public static Logger logger

  • Constructor Details

    • UI

      public UI()

  • Method Details

    • pmaEmbedPmaUIFramework

      public static String pmaEmbedPmaUIFramework(String sessionID)
      Internal helper function to prevent PMA.UI framework from being loaded more than once
      Parameters:
      sessionID - session ID of the actual session
      Returns:
      The links related to JS and CSS files to be included

    • embedSlideBySessionID

      public static List<String> embedSlideBySessionID(String server, String slideRef, String sessionID, Map<String,String>... varargs)
      Output HTML code to display a single slide through a PMA.UI viewport control authentication against PMA.core happens through a pre-established
      Parameters:
      server - PMA.Start or PMA.core instance
      slideRef - path to the slide
      sessionID - session id of the actual session
      varargs - Array of optional arguments

      options : First optional argument(Map<String, String>), default value(null), Map of the options defining the display of the view port

      Returns:
      List of embed slides

    • embedSlideByUsername

      public static List<String> embedSlideByUsername(String server, String slideRef, String username, Object... varargs)
      Output HTML code to display a single slide through a PMA.UI viewport control authentication against PMA.core happens in real-time through the provided $username and $password credentials Note that the username and password and NOT rendered in the HTML output (authentication happens on the server-side).
      Parameters:
      server - PMA.Start or PMA.core instance
      slideRef - path to the slide
      username - credentials' username
      varargs - Array of optional arguments

      password : First optional argument(String), default value(""), credentials' password

      options : Second optional argument(Map<String, String>), default value(null), Map of the options defining the display of the view port

      Returns:
      List of embed slides by username

    • embedGalleryBySessionID

      public static List<String> embedGalleryBySessionID(String server, String path, String sessionID, Map<String,String>... varargs)
      Output HTML code to display a gallery that shows all thumbnails that exist in a specific folder hosted by the specified PMA.core instance authentication against PMA.core happens through a pre-established SessionID
      Parameters:
      server - PMA.Start or PMA.core instance
      path - folder containing the slides
      sessionID - session id of the actual session
      varargs - Array of optional arguments

      options : First optional argument(Map<String, String>), default value(null), Map of the options defining the display of the view port

      Returns:
      List of embed galleries by session ID

    • embedGalleryByUsername

      public static List<String> embedGalleryByUsername(String server, String path, String username, Object... varargs)
      Output HTML code to display a gallery that shows all thumbnails that exist in a specific folder hosted by the specified PMA.core instance authentication against PMA.core happens in real-time through the provided $username and $password credentials Note that the username and password are NOT rendered in the HTML output (authentication happens on the server-side). * @param server PMA.Start of PMA.core
      Parameters:
      server - PMA.Start or PMA.core instance
      path - folder containing the slides
      username - credentials' username
      varargs - Array of optional arguments

      password : First optional argument(String), default value(""), credentials' password

      options : Second optional argument(Map<String, String>), default value(null), Map of the options defining the display of the view port

      Returns:
      List of embed galleries by username

    • linkGalleryToViewport

      public static String linkGalleryToViewport(String galleryDiv, String viewportDiv) throws Exception
      Output HTML code to couple an earlier instantiated PMA.UI gallery to a PMA.UI viewport. The PMA.UI viewport can be instantiated earlier, or not at all
      Parameters:
      galleryDiv - HTML Div holding the gallery
      viewportDiv - HTML Div holding the viewport
      Returns:
      Html code generated couple an earlier instantiated PMA.UI gallery to a PMA.UI viewport
      Throws:
      Exception - if galleryDiv is not a PMA.UI gallery or galleryDiv is not a valid PMA.UI gallery container or viewportDiv is not a PMA.UI viewport