oracle.ide.help
Interface HelpSystem

public interface HelpSystem

HelpSystem interface - high-level abstraction between the interaction of the IDE from the underlying implementation of a Help System.

Method Summary

void	clearHelpSystem()
void	goTo(java.lang.String topicID) Invokes the Help Viewer on topicID
void	registerClientWindow(java.awt.Window aWindow) Registers the Window with the Help System so that when the Window is modal, the Help Viewer will still operate properly.
void	registerHelpSetURL(java.net.URL url) Registers the { @link URL} to a HelpSet file.
void	registerTopic(javax.swing.JComponent component, java.lang.String topicID) Registers the topicID with the JComponent for context sensitive help.
void	showHelp(Context c) Invokes the Help Viewer on help topic for the JComponent
void	showHelp(HelpInfo helpInfo) Invokes the Help Viewer on the HelpInfo
void	showHelp(javax.swing.JComponent component) Invokes the Help Viewer on help topic for the JComponent
void	showLanguageHelp(Context context, java.lang.String symbolName) Shows help on the language symbol symbolName
void	unregisterClientWindow(java.awt.Window aWindow) Registers the Window with the Help System.

Method Detail

showHelp

public void showHelp(javax.swing.JComponent component)

Invokes the Help Viewer on help topic for the JComponent

See Also:

JComponent

showHelp

public void showHelp(Context c)

Invokes the Help Viewer on help topic for the JComponent

See Also:

JComponent

showHelp

public void showHelp(HelpInfo helpInfo)

Invokes the Help Viewer on the HelpInfo

See Also:

HelpInfo

goTo

public void goTo(java.lang.String topicID)

Invokes the Help Viewer on topicID

registerTopic

public void registerTopic(javax.swing.JComponent component,
                          java.lang.String topicID)

Registers the topicID with the JComponent for context sensitive help.

See Also:

JComponent

registerClientWindow

public void registerClientWindow(java.awt.Window aWindow)

Registers the Window with the Help System so that when the Window is modal, the Help Viewer will still operate properly.

unregisterClientWindow

public void unregisterClientWindow(java.awt.Window aWindow)

Registers the Window with the Help System.

showLanguageHelp

public void showLanguageHelp(Context context,
                             java.lang.String symbolName)

Shows help on the language symbol symbolName

Parameters:

context - The current context to use for resolving the symbolName

symbolName - the language token used for help

registerHelpSetURL

public void registerHelpSetURL(java.net.URL url)

Registers the { @link URL} to a HelpSet file. This is typically an absolute JAR URL (ie, jar:file:C:/jdev/lib/ext/helpset.jar!/helpset.hs) or a relative URL on the CLASSPATH (ie URL u = getClass().getResource("/helpset.hs"); )

clearHelpSystem

public void clearHelpSystem()