Package org.eclipse.help
Class AbstractContextProvider
java.lang.Object
org.eclipse.help.AbstractContextProvider
An
AbstractContextProvider
is a mechanism to provide arbitrary
context-sensitive help for any part of the UI. AbstractContextProvider
s must be registered via the org.eclipse.help.contexts
extension point.- Since:
- 3.3
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract IContext
getContext
(String id, String locale) Returns the context-sensitive help content for the UI element with the given context help ID, and for the given locale.abstract String[]
Returns an array ofString
s containing the ids of the UI plug-ins for which this provider should be used.
-
Constructor Details
-
AbstractContextProvider
public AbstractContextProvider()
-
-
Method Details
-
getContext
Returns the context-sensitive help content for the UI element with the given context help ID, and for the given locale.- Parameters:
id
- the unique context help ID, e.g. "org.my.plugin.my_context_id"- Returns:
- the context help, or
null
if not available
-
getPlugins
Returns an array ofString
s containing the ids of the UI plug-ins for which this provider should be used. This is equivalent to theplugin
attribute of thecontexts
element of theorg.eclipse.help.contexts
extension point, except you can specify any number of plug-ins.- Returns:
- the UI plug-ins for which this provider should be used
-