Class AbstractHelpDisplay

java.lang.Object
org.eclipse.help.base.AbstractHelpDisplay

public abstract class AbstractHelpDisplay extends Object
Abstract class representing a help display which can be used to override the Eclipse help system UI using the extension point org.eclipse.help.base.display. Classes extending this abstract class must be capable of returning the help home page and other help related URLs.
Since:
3.6
  • Constructor Details

    • AbstractHelpDisplay

      public AbstractHelpDisplay()
  • Method Details

    • getHelpHome

      public abstract String getHelpHome(String hostname, int port, String tab)
      Returns the URL to the help home page
      Parameters:
      hostname - the hostname of the Eclipse help system
      port - the port of the Eclipse help system
      tab - is one of "search" "toc" "index" "bookmarks" or null, In the Eclipse help webapp these correspond to a tab which is in focus when the help system is started. For other help presentations this parameter should be seen as a hint representing an action the user wishes to perform
      Returns:
      String help home path
    • getHelpForTopic

      public abstract String getHelpForTopic(String topic, String hostname, int port)
      Returns the help page, including any frames, for a specific topic.
      Parameters:
      hostname - the hostname of the Eclipse help system
      port - the port of the Eclipse help system
      topic - The path of a topic in the help system. May be a relative path, representing a topic within the help system or a full URL including protocol.
      Returns:
      String URL translated for overriding help system