oracle.bali.ewt.help
Interface HelpProvider
- All Known Implementing Classes:
- JavaHelpProvider
- public interface HelpProvider
The HelpProvider interface provides a simple interface to an online help
system. This abstraction allows components such as JavaHelp or Oracle
Help for Java to be automatically handled by JEWT. Oracle
Help for Java 4.x provides an implementation of this interface.
HelpProvider implementations should use the default HelpSet and HelpID
available via the oracle.bali.ewt.help.HelpUtils class when necessary.
Method Summary |
void |
showHelp(java.awt.Component component)
Displays help as appropriate for the particular component. |
showHelp
public void showHelp(java.awt.Component component)
throws HelpUnavailableException
- Displays help as appropriate for the particular component. The exact
details of how this method knows what the topic is are dependent on
the implementation; for example, JavaHelpProvider uses the JavaHelp
CSH class to get the appropriate data.
- Parameters:
component
- The component to show help for- Throws:
HelpUnavailableException
- If unable to show help properly