|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.help.AbstractContextProvider
public abstract class 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(java.lang.String id,
java.lang.String locale)
Returns the context-sensitive help content for the UI element with the given context help ID, and for the given locale. |
abstract java.lang.String[] |
getPlugins()
Returns an array of Strings 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(java.lang.String id,
java.lang.String locale)
id - the unique context help ID, e.g. "org.my.plugin.my_context_id"
null if not availablepublic abstract java.lang.String[] getPlugins()
Strings 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.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.