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
static int	ADD_UPDATE_ACTION ADD_UPDATE_ACTION inicates that the HelpSet identified by the helpURL element in the extension.xml file should be added or updated in the HelpSystem registry.
static int	REMOVE_ACTION REMOVE_ACTION inicates that the HelpSet identified by the helpURL element in the extension.xml file should be removed from the HelpSystem registry.
static java.lang.String	VIEW_NAME
static java.lang.String	VIEW_TYPE

Constructor Summary

HelpSystem()

Method Summary

abstract java.lang.Boolean	checkWizard(java.lang.String helpWizardInvokeString, Context context) Deprecated.
abstract void	clearHelpSystem()
abstract boolean	doesTopicExist(java.lang.String helpTopic) Method to determine if a helpTopic maps to a URL successfully.
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 boolean	hasTipOfDayEntries() Gets whether the tip of the day feature is enabled.
abstract void	invokeAction(java.lang.String actionString, Context context) Deprecated.
abstract void	invokeWizard(java.lang.String helpWizardInvokeString, Context context) Deprecated.
abstract void	registerBrowseSymbolResolver(java.lang.String resolverClass) Registers a fully-qualified class as a browse symbol resolver.
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.
void	registerHelpSetURL(java.lang.String name, int helpAction, java.net.URL controlFileURL, java.lang.String relativeName, int relativeLocation) Registers the URL to a HelpSet jar file that contains all the control files necessary for OHJ.
abstract void	registerHelpSetURL(java.lang.String name, int helpAction, java.net.URL controlFileURL, java.lang.String relativeName, int relativeLocation, java.util.Map<java.lang.String,java.lang.String> bookMap)
abstract void	registerHelpSetURL(java.net.URL url) Registers the 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	registerTipOfDayURL(java.net.URL tipOfDayURL) Registers a file as a tip of the day provider.
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.
abstract java.net.URL	resolveTopicId(java.lang.String topicId) Resolved the specified topic id to the URL that it represents.
static void	setHelpSystem(HelpSystem helpSystem) Publishes the specified HelpSystem as the active instance in the IDE.
abstract void	showCueCard(java.lang.String cueCardId) Invokes a cue card for the specified cue card id
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 Editor	showHelp(java.net.URL url) Invokes the Help Viewer on a specific URL.
abstract void	showLanguageHelp(Context context, java.lang.String symbolName) Shows help on the language symbol symbolName
abstract void	showTipOfTheDay() Handles showing a tip of the day
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

VIEW_TYPE

public static final java.lang.String VIEW_TYPE

See Also:

Constant Field Values

VIEW_NAME

public static final java.lang.String VIEW_NAME

See Also:

Constant Field Values

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

ADD_UPDATE_ACTION

public static final int ADD_UPDATE_ACTION

ADD_UPDATE_ACTION inicates that the HelpSet identified by the helpURL element in the extension.xml file should be added or updated in the HelpSystem registry.

See Also:

Constant Field Values

REMOVE_ACTION

public static final int REMOVE_ACTION

REMOVE_ACTION inicates that the HelpSet identified by the helpURL element in the extension.xml file should be removed from the HelpSystem registry.

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.

doesTopicExist

public abstract boolean doesTopicExist(java.lang.String helpTopic)

Method to determine if a helpTopic maps to a URL successfully.

Returns:

true if the help topic exists; false otherwise

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 Editor showHelp(java.net.URL url)

Invokes the Help Viewer on a specific URL.

Parameters:

url - the url to invoke the help viewer on.

Returns:

the editor that was opened, or null if an error occurred.

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 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

registerHelpSetURL

public void registerHelpSetURL(java.lang.String name,
                               int helpAction,
                               java.net.URL controlFileURL,
                               java.lang.String relativeName,
                               int relativeLocation)

Registers the URL to a HelpSet jar file that contains all the control files necessary for OHJ.

Parameters:

name - unique key used to identify the help jar

helpAction - ADD_UPDATE_ACTION or REMOVE_ACTION

controlFileURL - the url to use for creating the HelpSet

relativeName - key used to identify a help jar this help jar should appear relative to

relativeLocation - ADD_BEFORE or ADD_AFTER; value is meaningless when relativeName is null

registerHelpSetURL

public abstract void registerHelpSetURL(java.lang.String name,
                                        int helpAction,
                                        java.net.URL controlFileURL,
                                        java.lang.String relativeName,
                                        int relativeLocation,
                                        java.util.Map<java.lang.String,java.lang.String> bookMap)

registerTipOfDayURL

public abstract void registerTipOfDayURL(java.net.URL tipOfDayURL)

Registers a file as a tip of the day provider. The file registered must be a jar file with html files at the top level that can be used to display tips of the day. The html file names must end in html.

Parameters:

tipOfDayURL - the jar file to use to obtain tips of the day

registerBrowseSymbolResolver

public abstract void registerBrowseSymbolResolver(java.lang.String resolverClass)

Registers a fully-qualified class as a browse symbol resolver.

Parameters:

resolverClass - fully-qualified class name of a class that implements BrowseSymbolResolver

showTipOfTheDay

public abstract void showTipOfTheDay()

Handles showing a tip of the day

hasTipOfDayEntries

public abstract boolean hasTipOfDayEntries()

Gets whether the tip of the day feature is enabled. It is not enabled if not jar files are registered to provide tips

Returns:

true if the feature is enabled; false otherwise

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.

resolveTopicId

public abstract java.net.URL resolveTopicId(java.lang.String topicId)

Resolved the specified topic id to the URL that it represents. May return null if the topic id cannot be resolved.

Parameters:

topicId - the topic id to resolve

Returns:

the URL for the help content. May be null.

showCueCard

public abstract void showCueCard(java.lang.String cueCardId)

Invokes a cue card for the specified cue card id

Parameters:

cueCardId -

invokeWizard

@Deprecated
public abstract void invokeWizard(java.lang.String helpWizardInvokeString,
                                             Context context)

Deprecated.

Invokes a wizard using a special help-system-specific string that encodes the wizard plus arguments needed to invoke the wizard. This should be considered deprecated by all but the application overview for now.

Parameters:

helpWizardInvokeString -

checkWizard

public abstract java.lang.Boolean checkWizard(java.lang.String helpWizardInvokeString,
                                              Context context)

Deprecated.

Checks whether a wizard using a special help-system-specific string that encodes the wizard plus arguments needed to invoke the wizard is available in the context. This should be considered deprecated by all but the applicaton overview for now.

Parameters:

helpWizardInvokeString -

context -

Returns:

Boolean indicating whether the wizard is available, may return null if it cannot determine availability (most likely cannot determine what wizard to invoke)

invokeAction

@Deprecated
public abstract void invokeAction(java.lang.String actionString,
                                             Context context)

Deprecated.

Invokes an action using a special help-system-specific string that encodes the action id. This should be considered deprecated by all but the application overview for now.

Parameters:

actionString -

context -