Class ElementHelpLocation

    • Method Detail

      • copyOf

        public static IElementHelpLocation copyOf​(IElementHelpLocation value)
        Parameters:
        value - An element help location to copy.
        Returns:
        A new help location with the same data as the given value. This is an immutable screenshot, subsequent modifications to the value will not be reflected in the returned instance.
      • forExternalLink

        public static IElementHelpLocation forExternalLink​(String url)
        Parameters:
        url - URL of the help page.
        Returns:
        A new help location pointing to the given external URL.
      • forExternalLink

        public static IElementHelpLocation forExternalLink​(URL url)
        Parameters:
        url - URL of the help page.
        Returns:
        A new help location pointing to the given external URL.
      • forHtmlFile

        public static IElementHelpLocation forHtmlFile​(ClassLoader loader,
                                                       String htmlPath,
                                                       Charset encoding)
                                                throws IOException
        Parameters:
        loader - Class loader to use for accessing the HTML document.
        htmlPath - Path to the HTML document.
        encoding - Encoding of the HTML document.
        Returns:
        A new help location pointing to the given HTML document.
        Throws:
        IOException - When the resource at the given location could not be read via the given class loader.
      • forHtmlFile

        public static IElementHelpLocation forHtmlFile​(String htmlFile)
        Parameters:
        htmlFile - HTML content of the help page.
        Returns:
        A new help location pointing to the given HTML document.
      • forOfficialHelpPage

        public static IElementHelpLocation forOfficialHelpPage​(String helpPagePath,
                                                               Locale locale)
        Parameters:
        helpPagePath - ID for the help page in the official formcycle help pages.
        locale - Language of the help page.
        Returns:
        A new help location pointing to the given path in the official formcycle help pages.