Package org.eclipse.help
Class HelpSystem
java.lang.Object
org.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.
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionstatic 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.
-
Method Details
-
getContext
Computes and returns context information for the given context id for the platform's current locale.- Parameters:
contextId
- the context id, e.g. "org.my.plugin.my_id"- Returns:
- the context, or
null
if none
-
getContext
Computes and returns context information for the given context id and locale.- Parameters:
contextId
- the context id, e.g. "org.my.plugin.my_id"locale
- the locale being requested, e.g. "en_US"- Returns:
- the context, or
null
if none
-
getTocs
Returns the list of all integrated tables of contents available. Each entry corresponds of a different help "book".- Returns:
- an array of TOC's
-
getIndex
Returns the keyword index available in the help system.- Returns:
- the keyword index
- Since:
- 3.2
-
getHelpContent
Returns an open input stream on the contents of the specified help resource in the platform's current locale. The client is responsible for closing the stream when finished.- Parameters:
href
- the URL (as a string) of the help resourceValid href are as described in
IHelpResource.getHref
- Returns:
- an input stream containing the contents of the help resource, or
null
if the help resource could not be found and opened
-
getHelpContent
Returns an open input stream on the contents of the specified help resource for the speficied locale. The client is responsible for closing the stream when finished.- Parameters:
href
- the URL (as a string) of the help resourceValid href are as described in
IHelpResource.getHref
locale
- the locale code, e.g. en_US- Returns:
- an input stream containing the contents of the help resource, or
null
if the help resource could not be found and opened - Since:
- 3.0
-