public abstract class HelpSystem
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
HelpSystem() |
Modifier and Type | Method and Description |
---|---|
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 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 |
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 |
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 |
unregisterClientWindow(java.awt.Window aWindow)
Registers the
Window with the Help System. |
public static final java.lang.String VIEW_TYPE
public static final java.lang.String VIEW_NAME
public static final int ADD_BEFORE
public static final int ADD_AFTER
public static final int ADD_UPDATE_ACTION
public static final int REMOVE_ACTION
public static HelpSystem getHelpSystem()
public static void setHelpSystem(HelpSystem helpSystem)
public abstract boolean doesTopicExist(java.lang.String helpTopic)
public abstract void showHelp(javax.swing.JComponent component)
JComponent
JComponent
public abstract Editor showHelp(java.net.URL url)
url
- the url to invoke the help viewer on.public abstract void showHelp(Context c)
JComponent
JComponent
public abstract void showHelp(HelpInfo helpInfo)
HelpInfo
HelpInfo
public abstract void goTo(java.lang.String topicID)
topicID
public abstract void registerTopic(javax.swing.JComponent component, java.lang.String topicID)
topicID
with the JComponent
for context sensitive help.JComponent
public abstract void registerClientWindow(java.awt.Window aWindow)
Window
with the Help System so that when the Window
is modal, the Help Viewer will still operate properly.public abstract void unregisterClientWindow(java.awt.Window aWindow)
Window
with the Help System.public abstract void showLanguageHelp(Context context, java.lang.String symbolName)
context
- The current context to use for resolving the symbolNamesymbolName
- the language token used for helppublic abstract void registerHelpSetURL(java.net.URL url)
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"); )public abstract void registerHelpSetURL(java.net.URL url, java.lang.String relativeToName, int relativeLocation)
url
- The URL
of the HelpSet file to add to the help systemrelativeToName
- 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 relativeToNamepublic void registerHelpSetURL(java.lang.String name, int helpAction, java.net.URL controlFileURL, java.lang.String relativeName, int relativeLocation)
URL
to a HelpSet jar file that contains all the control files necessary for OHJ.name
- unique key used to identify the help jarhelpAction
- ADD_UPDATE_ACTION or REMOVE_ACTIONcontrolFileURL
- the url to use for creating the HelpSet
relativeName
- key used to identify a help jar this help jar should appear relative torelativeLocation
- ADD_BEFORE or ADD_AFTER; value is meaningless when relativeName is nullpublic 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)
public abstract void registerBrowseSymbolResolver(java.lang.String resolverClass)
resolverClass
- fully-qualified class name of a class that implements BrowseSymbolResolver
public abstract void clearHelpSystem()
public abstract void registerTopicSubstitute(java.lang.String oldTopicId, java.lang.String newTopicId)
oldTopicId
- the old topic idnewTopicId
- the new topic id.public abstract java.net.URL resolveTopicId(java.lang.String topicId)
topicId
- the topic id to resolve@Deprecated public abstract void invokeWizard(java.lang.String helpWizardInvokeString, Context context)
helpWizardInvokeString
-public abstract java.lang.Boolean checkWizard(java.lang.String helpWizardInvokeString, Context context)
helpWizardInvokeString
-context
-@Deprecated public abstract void invokeAction(java.lang.String actionString, Context context)
actionString
-context
-