|
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.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.
Constructor Summary | |
---|---|
AbstractContextProvider()
|
Method Summary | |
---|---|
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. |
abstract String[] |
getPlugins()
Returns an array of String s containing the ids of the
UI plug-ins for which this provider should be used. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractContextProvider()
Method Detail |
public abstract IContext getContext(String id, String locale)
id
- the unique context help ID, e.g. "org.my.plugin.my_context_id"
null
if not availablepublic abstract String[] getPlugins()
String
s containing the ids of the
UI plug-ins for which this provider should be used. This is equivalent to
the plugin
attribute of the contexts
element
of the org.eclipse.help.contexts
extension point, except you
can specify any number of plug-ins.
|
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.