IHelpDriver Interface

com.bea.ide.ui.help
IHelpDriver Interface

public interface IHelpDriver

The IHelpDriver interface is used to generate a list of context URNs from the current context. The current context is typically the curently selected IElement, but could also be the currently selected IView or any other contextual information. A document view or frame view can implement this driver to provide generation of context URNs that will be resolved by HelpSvc.I.resolveContextAsync(URI[]).


All Known Implementing Classes
JavaHelpDriver

Method Summary

public URI[]
getHelpContextList(IElement el)

Obtain the context URNs associated with the specified element.

Method Detail

getHelpContextList(IElement) Method

public URI[] getHelpContextList(IElement el)

Obtain the context URNs associated with the specified element.

For an explanation of context URN formats and interpretation, see HelpSvc

Parameters

el
the element for which context-sensitive help is desired. Note that some implementations may ignore the IElement and determine the context ID in some other way.

Returns

an ordered list of opaque URIs which are help context URNs