|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.help.HelpSystem
This class provides general access to help content contributed to the
"org.eclipse.help.toc"
and
"org.eclipse.help.contexts"
extension points.
This class provides static methods only; it is not intended to be instantiated or subclassed.
Method Summary | |
---|---|
static IContext |
getContext(String contextId)
Computes and returns context information for the given context id for the platform's current locale. |
static IContext |
getContext(String contextId,
String locale)
Computes and returns context information for the given context id and locale. |
static InputStream |
getHelpContent(String href)
Returns an open input stream on the contents of the specified help resource in the platform's current locale. |
static InputStream |
getHelpContent(String href,
String locale)
Returns an open input stream on the contents of the specified help resource for the speficied locale. |
static IIndex |
getIndex()
Returns the keyword index available in the help system. |
static IToc[] |
getTocs()
Returns the list of all integrated tables of contents available. |
static boolean |
isShared()
Returns whether or not the help system, in its current mode of operation, can be shared by multiple (potentially remote) users. |
static void |
setShared(boolean shared)
Sets whether or not the help system, in its current mode of operation, can be shared by multiple (potentially remote) users. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static IContext getContext(String contextId)
contextId
- the context id, e.g. "org.my.plugin.my_id"
null
if nonepublic static IContext getContext(String contextId, String locale)
contextId
- the context id, e.g. "org.my.plugin.my_id"locale
- the locale being requested, e.g. "en_US"
null
if nonepublic static IToc[] getTocs()
public static IIndex getIndex()
public static InputStream getHelpContent(String href)
href
- the URL (as a string) of the help resource
Valid href are as described in
IHelpResource.getHref
null
if the help resource could not be found and
openedpublic static InputStream getHelpContent(String href, String locale)
href
- the URL (as a string) of the help resource
Valid href are as described in
IHelpResource.getHref
locale
- the locale code, e.g. en_US
null
if the help resource could not be found and
openedpublic static boolean isShared()
For example, when true
, the default dynamic content producer
implementation will not perform any filtering based on local system
properties such as operating system or activities.
If you are providing your own help implementation that is shared, you
must notify the platform on startup by calling setShared(true)
.
public static void setShared(boolean shared)
By default the help system is flagged as not shared. If you are providing
your own help implementation that is shared, you must call this on startup
with the parameter true
.
shared
- whether or not the help system can be shared by multiple users
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.