public abstract class AbstractHelpDisplay extends Object
Constructor and Description |
---|
AbstractHelpDisplay() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getHelpForTopic(String topic,
String hostname,
int port)
Returns the help page, including any frames, for a specific topic.
|
abstract String |
getHelpHome(String hostname,
int port,
String tab)
Returns the URL to the help home page
|
public abstract String getHelpHome(String hostname, int port, String tab)
hostname
- the hostname of the Eclipse help systemport
- the port of the Eclipse help systemtab
- 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 performpublic abstract String getHelpForTopic(String topic, String hostname, int port)
hostname
- the hostname of the Eclipse help systemport
- the port of the Eclipse help systemtopic
- 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.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.