|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.help.base.AbstractHelpDisplay
public abstract class AbstractHelpDisplay
Constructor Summary | |
---|---|
AbstractHelpDisplay()
|
Method Summary | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractHelpDisplay()
Method Detail |
---|
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 perform
public 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.
|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.