Package docking.help
Interface HelpService
-
- All Known Implementing Classes:
DefaultHelpService
,GhidraHelpService
,HelpManager
,TestHelpService
public interface HelpService
HelpService
defines a service for displaying Help content by an ID or URL.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DUMMY_HELP_SET_NAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearHelp(java.lang.Object helpObject)
Removes this object from the help system.void
excludeFromHelp(java.lang.Object helpObject)
Signals to the help system to ignore the given object when searching for and validating help.HelpLocation
getHelpLocation(java.lang.Object object)
Returns the registered (viaregisterHelp(Object, HelpLocation)
help location for the given object; null if there is no registered help.boolean
helpExists()
Returns true if the help system has been initialized properly; false if help does not exist or is not working.boolean
isExcludedFromHelp(java.lang.Object helpObject)
Returns true if the given object is meant to be ignored by the help systemvoid
registerHelp(java.lang.Object helpObject, HelpLocation helpLocation)
Register help for a specific object.void
showHelp(java.lang.Object helpObject, boolean infoOnly, java.awt.Component parent)
Display the Help content identified by the help object.void
showHelp(java.net.URL url)
Display the help page for the given URL.
-
-
-
Field Detail
-
DUMMY_HELP_SET_NAME
static final java.lang.String DUMMY_HELP_SET_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
showHelp
void showHelp(java.lang.Object helpObject, boolean infoOnly, java.awt.Component parent)
Display the Help content identified by the help object.- Parameters:
helpObject
- the object to which help was previously registeredinfoOnly
- displayHelpLocation
information only, not the help UIparent
- requesting component- See Also:
registerHelp(Object, HelpLocation)
-
showHelp
void showHelp(java.net.URL url)
Display the help page for the given URL. This is a specialty method for displaying help when a specific file is desired, like an introduction page. Showing help for objects within the system is accomplished by callingshowHelp(Object, boolean, Component)
.- Parameters:
url
- the URL to display- See Also:
showHelp(Object, boolean, Component)
-
excludeFromHelp
void excludeFromHelp(java.lang.Object helpObject)
Signals to the help system to ignore the given object when searching for and validating help. Once this method has been called, no help can be registered for the given object.- Parameters:
helpObject
- the object to exclude from the help system.
-
isExcludedFromHelp
boolean isExcludedFromHelp(java.lang.Object helpObject)
Returns true if the given object is meant to be ignored by the help system- Parameters:
helpObject
- the object to check- Returns:
- true if ignored
- See Also:
excludeFromHelp(Object)
-
registerHelp
void registerHelp(java.lang.Object helpObject, HelpLocation helpLocation)
Register help for a specific object.Do not call this method will a
null
help location. Instead, to signal that an item has no help, callexcludeFromHelp(Object)
.- Parameters:
helpObject
- the object to associate the specified help location withhelpLocation
- help content location
-
clearHelp
void clearHelp(java.lang.Object helpObject)
Removes this object from the help system. This method is useful, for example, when a single JavaComponent
will have different help locations assigned over its lifecycle.- Parameters:
helpObject
- the object for which to clear help
-
getHelpLocation
HelpLocation getHelpLocation(java.lang.Object object)
Returns the registered (viaregisterHelp(Object, HelpLocation)
help location for the given object; null if there is no registered help.- Parameters:
object
- The object for which to find a registered HelpLocation.- Returns:
- the registered HelpLocation
- See Also:
registerHelp(Object, HelpLocation)
-
helpExists
boolean helpExists()
Returns true if the help system has been initialized properly; false if help does not exist or is not working.- Returns:
- true if the help system has found the applications help content and has finished initializing
-
-