Package org.eclipse.help
Class AbstractContextProvider
- java.lang.Object
-
- org.eclipse.help.AbstractContextProvider
-
public abstract class AbstractContextProvider extends Object
AnAbstractContextProvideris a mechanism to provide arbitrary context-sensitive help for any part of the UI.AbstractContextProviders must be registered via theorg.eclipse.help.contextsextension point.- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description AbstractContextProvider()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract IContextgetContext(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[]getPlugins()Returns an array ofStrings containing the ids of the UI plug-ins for which this provider should be used.
-
-
-
Method Detail
-
getContext
public abstract 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.- Parameters:
id- the unique context help ID, e.g. "org.my.plugin.my_context_id"- Returns:
- the context help, or
nullif not available
-
getPlugins
public abstract String[] getPlugins()
Returns an array ofStrings containing the ids of the UI plug-ins for which this provider should be used. This is equivalent to thepluginattribute of thecontextselement of theorg.eclipse.help.contextsextension point, except you can specify any number of plug-ins.- Returns:
- the UI plug-ins for which this provider should be used
-
-