oracle.ide.help
Class HelpSystem

java.lang.Object
  oracle.ide.help.HelpSystem

public abstract class HelpSystem

extends java.lang.Object

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

Field Summary

static int	ADD_AFTER ADD_AFTER is used to indicate a HelpSet should be added AFTER a a specified HelpSet file
static int	ADD_BEFORE ADD_BEFORE is used to indicate a HelpSet should be added BEFORE a a specified HelpSet file

Constructor Summary

HelpSystem()

Method Summary

abstract void	clearHelpSystem()
static HelpSystem	getHelpSystem() Returns the HelpSystem instance that is active in the IDE.
abstract void	goTo(java.lang.String topicID) Invokes the Help Viewer on topicID
abstract 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.
abstract void	registerHelpSetURL(java.net.URL url) Registers the { @link URL} to a HelpSet file.
abstract void	registerHelpSetURL(java.net.URL url, java.lang.String relativeToName, int relativeLocation) Registers the { @link URL} to a HelpSet file.
abstract void	registerTopic(javax.swing.JComponent component, java.lang.String topicID) Registers the topicID with the JComponent for context sensitive help.
abstract void	registerTopicSubstitute(java.lang.String oldTopicId, java.lang.String newTopicId) Registers a substitute topic id.
static void	setHelpSystem(HelpSystem helpSystem) Publishes the specified HelpSystem as the active instance in the IDE.
abstract void	showHelp(Context c) Invokes the Help Viewer on help topic for the JComponent
abstract void	showHelp(HelpInfo helpInfo) Invokes the Help Viewer on the HelpInfo
abstract void	showHelp(javax.swing.JComponent component) Invokes the Help Viewer on help topic for the JComponent
abstract void	showLanguageHelp(Context context, java.lang.String symbolName) Shows help on the language symbol symbolName
abstract void	unregisterClientWindow(java.awt.Window aWindow) Registers the Window with the Help System.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADD_BEFORE

public static final int ADD_BEFORE

ADD_BEFORE is used to indicate a HelpSet should be added BEFORE a a specified HelpSet file

See Also:

Constant Field Values

ADD_AFTER

public static final int ADD_AFTER

ADD_AFTER is used to indicate a HelpSet should be added AFTER a a specified HelpSet file

See Also:

Constant Field Values

Constructor Detail

HelpSystem

public HelpSystem()

Method Detail

getHelpSystem

public static HelpSystem getHelpSystem()

Returns the HelpSystem instance that is active in the IDE.

setHelpSystem

public static void setHelpSystem(HelpSystem helpSystem)

Publishes the specified HelpSystem as the active instance in the IDE.

showHelp

public abstract void showHelp(javax.swing.JComponent component)

Invokes the Help Viewer on help topic for the JComponent

See Also:

JComponent

showHelp

public abstract void showHelp(Context c)

Invokes the Help Viewer on help topic for the JComponent

See Also:

JComponent

showHelp

public abstract void showHelp(HelpInfo helpInfo)

Invokes the Help Viewer on the HelpInfo

See Also:

HelpInfo

goTo

public abstract void goTo(java.lang.String topicID)

Invokes the Help Viewer on topicID

registerTopic

public abstract 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 abstract 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 abstract void unregisterClientWindow(java.awt.Window aWindow)

Registers the Window with the Help System.

showLanguageHelp

public abstract 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 abstract 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"); )

registerHelpSetURL

public abstract void registerHelpSetURL(java.net.URL url,
                                        java.lang.String relativeToName,
                                        int relativeLocation)

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"); ) This method is used to position the given HelpSet file before or after a HelpSet file already in the list of help sets. If the specified help set name cannot be found it will simply be added at the end of the list.

Parameters:

url - The URL of the HelpSet file to add to the help system

relativeToName - The file name to use for relative placement of this HelpSet file. Only use the file name, eg, getting_started.jar)

relativeLocation - Use the values HelpSystem.ADD_BEFORE or HelpSystem.ADD_AFTER to indicate how this HelpSet file should be place relative to the given relativeToName

clearHelpSystem

public abstract void clearHelpSystem()

registerTopicSubstitute

public abstract void registerTopicSubstitute(java.lang.String oldTopicId,
                                             java.lang.String newTopicId)

Registers a substitute topic id. Whenever a component is registered with the oldTopicId via the registerTopic() method, the newTopicId will be used as the actual topic ID. This can be used to dynamically change the topic ID used by other components at runtime.

Parameters:

oldTopicId - the old topic id

newTopicId - the new topic id.