Package docking
Class DefaultHelpService
- java.lang.Object
-
- docking.DefaultHelpService
-
- All Implemented Interfaces:
HelpService
public class DefaultHelpService extends java.lang.Object implements HelpService
-
-
Field Summary
-
Fields inherited from interface docking.help.HelpService
DUMMY_HELP_SET_NAME
-
-
Constructor Summary
Constructors Constructor Description DefaultHelpService()
-
Method Summary
All Methods Instance Methods Concrete 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 (viaHelpService.registerHelp(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 helpObj, HelpLocation helpLocation)
Register help for a specific object.void
showHelp(java.lang.Object helpObj, 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.
-
-
-
Method Detail
-
showHelp
public void showHelp(java.lang.Object helpObj, boolean infoOnly, java.awt.Component parent)
Description copied from interface:HelpService
Display the Help content identified by the help object.- Specified by:
showHelp
in interfaceHelpService
- Parameters:
helpObj
- the object to which help was previously registeredinfoOnly
- displayHelpLocation
information only, not the help UIparent
- requesting component- See Also:
HelpService.registerHelp(Object, HelpLocation)
-
showHelp
public void showHelp(java.net.URL url)
Description copied from interface:HelpService
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 callingHelpService.showHelp(Object, boolean, Component)
.- Specified by:
showHelp
in interfaceHelpService
- Parameters:
url
- the URL to display- See Also:
HelpService.showHelp(Object, boolean, Component)
-
excludeFromHelp
public void excludeFromHelp(java.lang.Object helpObject)
Description copied from interface:HelpService
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.- Specified by:
excludeFromHelp
in interfaceHelpService
- Parameters:
helpObject
- the object to exclude from the help system.
-
isExcludedFromHelp
public boolean isExcludedFromHelp(java.lang.Object helpObject)
Description copied from interface:HelpService
Returns true if the given object is meant to be ignored by the help system- Specified by:
isExcludedFromHelp
in interfaceHelpService
- Parameters:
helpObject
- the object to check- Returns:
- true if ignored
- See Also:
HelpService.excludeFromHelp(Object)
-
clearHelp
public void clearHelp(java.lang.Object helpObject)
Description copied from interface:HelpService
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.- Specified by:
clearHelp
in interfaceHelpService
- Parameters:
helpObject
- the object for which to clear help
-
registerHelp
public void registerHelp(java.lang.Object helpObj, HelpLocation helpLocation)
Description copied from interface:HelpService
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, callHelpService.excludeFromHelp(Object)
.- Specified by:
registerHelp
in interfaceHelpService
- Parameters:
helpObj
- the object to associate the specified help location withhelpLocation
- help content location
-
getHelpLocation
public HelpLocation getHelpLocation(java.lang.Object object)
Description copied from interface:HelpService
Returns the registered (viaHelpService.registerHelp(Object, HelpLocation)
help location for the given object; null if there is no registered help.- Specified by:
getHelpLocation
in interfaceHelpService
- Parameters:
object
- The object for which to find a registered HelpLocation.- Returns:
- the registered HelpLocation
- See Also:
HelpService.registerHelp(Object, HelpLocation)
-
helpExists
public boolean helpExists()
Description copied from interface:HelpService
Returns true if the help system has been initialized properly; false if help does not exist or is not working.- Specified by:
helpExists
in interfaceHelpService
- Returns:
- true if the help system has found the applications help content and has finished initializing
-
-