Package docking

Class DefaultHelpService

  • All Implemented Interfaces:
    HelpService
    public class DefaultHelpService
extends java.lang.Object
implements HelpService

    • 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 (via HelpService.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 system
      void 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.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DefaultHelpService

        public DefaultHelpService()

    • 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 interface HelpService
        Parameters:
        helpObj - the object to which help was previously registered
        infoOnly - display HelpLocation information only, not the help UI
        parent - requesting component
        See Also:
        HelpService.registerHelp(Object, HelpLocation)

      • 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 interface HelpService
        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 interface HelpService
        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 Java Component will have different help locations assigned over its lifecycle.
        Specified by:
        clearHelp in interface HelpService
        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, call HelpService.excludeFromHelp(Object).

        Specified by:
        registerHelp in interface HelpService
        Parameters:
        helpObj - the object to associate the specified help location with
        helpLocation - help content location

      • 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 interface HelpService
        Returns:
        true if the help system has found the applications help content and has finished initializing