Package javax.help

Class ServletHelpBroker

java.lang.Object
javax.help.ServletHelpBroker
All Implemented Interfaces:
HelpBroker

public class ServletHelpBroker extends Object implements HelpBroker
An implmentation of the HelpBroker interface for Servlets
  • Field Details

  • Constructor Details

    • ServletHelpBroker

      public ServletHelpBroker()
      Zero-argument constructor. It should be followed by a setHelpSet() invocation.
  • Method Details

    • getHelpSet

      public HelpSet getHelpSet()
      Returns the default HelpSet
      Specified by:
      getHelpSet in interface HelpBroker
      Returns:
      The HelpSet this JavaHelp is presenting.
    • setHelpSet

      public void setHelpSet(HelpSet hs)
      Changes the HelpSet for this broker.
      Specified by:
      setHelpSet in interface HelpBroker
      Parameters:
      hs - The HelpSet to set for this broker. A null hs is valid parameter.
    • getLocale

      public Locale getLocale()
      Gets the locale of this component.
      Specified by:
      getLocale in interface HelpBroker
      Returns:
      This component's locale. If this component does not have a locale, the defaultLocale is returned.
      See Also:
    • setLocale

      public void setLocale(Locale l)
      Sets the locale of this HelpBroker. The locale is propagated to the presentation.
      Specified by:
      setLocale in interface HelpBroker
      Parameters:
      l - The locale to become this component's locale. A null locale is the same as the defaultLocale.
      See Also:
    • getFont

      public Font getFont()
      Gets the font for this HelpBroker.
      Specified by:
      getFont in interface HelpBroker
    • setFont

      public void setFont(Font f)
      Sets the font for this this HelpBroker.
      Specified by:
      setFont in interface HelpBroker
      Parameters:
      f - The font.
    • setCurrentView

      public void setCurrentView(String name)
      Set the currentView to the navigator with the same name as the name parameter.
      Specified by:
      setCurrentView in interface HelpBroker
      Parameters:
      name - The name of the navigator to set as the current view. If nav is null or not a valid Navigator in this HelpBroker then an IllegalArgumentException is thrown.
      Throws:
      IllegalArgumentException - if nav is null or not a valid Navigator.
    • getCurrentView

      public String getCurrentView()
      Determines the current navigator.
      Specified by:
      getCurrentView in interface HelpBroker
      Returns:
      The name of the current navigational view.
    • getCurrentNavigatorView

      public NavigatorView getCurrentNavigatorView()
      Returns the current navigator as a NavigatorView.
    • initPresentation

      public void initPresentation()
      Initializes the presentation. Not implemented in ServletHelpBroker.
      Specified by:
      initPresentation in interface HelpBroker
    • setDisplayed

      public void setDisplayed(boolean b)
      Displays the presentation to the user.
      Specified by:
      setDisplayed in interface HelpBroker
      Parameters:
      b - Makes the presentation visible or not.
    • isDisplayed

      public boolean isDisplayed()
      Determines if the presentation is displayed.
      Specified by:
      isDisplayed in interface HelpBroker
      Returns:
      Whether the presentation is currently visible.
    • setLocation

      public void setLocation(Point p) throws UnsupportedOperationException
      Requests the presentation be located at a given position. This operation throws an UnsupportedOperationException in ServletHelpBroker
      Specified by:
      setLocation in interface HelpBroker
      Throws:
      UnsupportedOperationException
    • getLocation

      public Point getLocation() throws UnsupportedOperationException
      Requests the location of the presentation. This operation throws an UnsupportedOperationException in ServletHelpBroker
      Specified by:
      getLocation in interface HelpBroker
      Throws:
      UnsupportedOperationException
    • setSize

      public void setSize(Dimension d) throws UnsupportedOperationException
      Requests the presentation be set to a given size. This operation throws an UnsupportedOperationException in ServletHelpBroker
      Specified by:
      setSize in interface HelpBroker
      Throws:
      UnsupportedOperationException
    • getSize

      public Dimension getSize() throws UnsupportedOperationException
      Requests the size of the presentation. throws UnsupportedOperationException in ServletHelpBroker.
      Specified by:
      getSize in interface HelpBroker
      Throws:
      UnsupportedOperationException
    • setScreen

      public void setScreen(int screen) throws UnsupportedOperationException
      Requests the presentation be set to a given screen. This operation throws an UnsupportedOperationException in ServletHelpBroker
      Specified by:
      setScreen in interface HelpBroker
      Throws:
      UnsupportedOperationException
    • getScreen

      public int getScreen() throws UnsupportedOperationException
      Requests the screen of the presentation. throws UnsupportedOperationException in ServletHelpBroker.
      Specified by:
      getScreen in interface HelpBroker
      Throws:
      UnsupportedOperationException
    • setViewDisplayed

      public void setViewDisplayed(boolean displayed)
      Hides/Shows view.
      Specified by:
      setViewDisplayed in interface HelpBroker
      Parameters:
      displayed - Make the navigational views visible or not.
    • isViewDisplayed

      public boolean isViewDisplayed()
      Determines if the current view is visible.
      Specified by:
      isViewDisplayed in interface HelpBroker
      Returns:
      Whether the navigational views are visible.
    • setCurrentID

      public void setCurrentID(String id) throws BadIDException
      Shows this ID as content relative to the (top) HelpSet for the HelpBroker instance--HelpVisitListeners are notified.
      Specified by:
      setCurrentID in interface HelpBroker
      Parameters:
      id - A string that identifies the topic to show for the loaded (top) HelpSet
      Throws:
      BadIDException - The ID is not valid for the HelpSet
    • setCurrentID

      public void setCurrentID(Map.ID id) throws InvalidHelpSetContextException
      Displays this ID--HelpVisitListeners are notified.
      Specified by:
      setCurrentID in interface HelpBroker
      Parameters:
      id - a Map.ID indicating the URL to display
      Throws:
      InvalidHelpSetContextException - if the current helpset does not contain id.helpset
      See Also:
    • getCurrentID

      public Map.ID getCurrentID()
      Determines which ID is displayed (if any).
      Specified by:
      getCurrentID in interface HelpBroker
      Returns:
      The ID being shown.
    • setCurrentURL

      public void setCurrentURL(URL url)
      Displays this URL. HelpVisitListeners are notified. The currentID changes if there is a mathing ID for this URL
      Specified by:
      setCurrentURL in interface HelpBroker
      Parameters:
      url - The url to display. A null URL is a valid url.
    • getCurrentURL

      public URL getCurrentURL()
      Determines which URL is displayed.
      Specified by:
      getCurrentURL in interface HelpBroker
      Returns:
      The URL being shown.
    • enableHelpKey

      public void enableHelpKey(Component comp, String id, HelpSet hs)
      Enables the Help key on a Component. Not implemented in ServletHelpBroker
      Specified by:
      enableHelpKey in interface HelpBroker
      Parameters:
      comp - The component to enable the keyboard actions on.
      id - The default HelpID to be displayed.
      hs - The default HelpSet to be displayed.
    • enableHelp

      public void enableHelp(Component comp, String id, HelpSet hs)
      Enables help for a Component. Not implemented in ServletHelpBroker
      Specified by:
      enableHelp in interface HelpBroker
      See Also:
      • invalid reference
        CSH.setHelpID
      • invalid reference
        CSH.setHelpSet
    • enableHelp

      public void enableHelp(MenuItem comp, String id, HelpSet hs)
      Enables help for a MenuItem. Not implemented in ServletHelpBroker
      Specified by:
      enableHelp in interface HelpBroker
      See Also:
      • invalid reference
        CSH.setHelpID
      • invalid reference
        CSH.setHelpSet
    • enableHelpOnButton

      public void enableHelpOnButton(Component comp, String id, HelpSet hs)
      Enables help for a Component. Not implemented in ServletHelpBroker
      Specified by:
      enableHelpOnButton in interface HelpBroker
      See Also:
    • enableHelpOnButton

      public void enableHelpOnButton(MenuItem comp, String id, HelpSet hs)
      Enables help for a MenuItem. Not implemented in ServletHelpBroker.
      Specified by:
      enableHelpOnButton in interface HelpBroker
      See Also:
      • invalid reference
        CSH.setHelpID
      • invalid reference
        CSH.setHelpSet
      • MenuItem
    • setHelpSetPresentation

      public void setHelpSetPresentation(HelpSet.Presentation pres)
      Description copied from interface: HelpBroker
      Sets the presentation attributes from a HelpSet.Presentation. The HelpSet.Presentation must be in the current HelpSet.
      Specified by:
      setHelpSetPresentation in interface HelpBroker
      Parameters:
      pres - The HelpSet.Presentation
    • showID

      public void showID(String id, String presentation, String presentationName) throws BadIDException
      Description copied from interface: HelpBroker
      Displays this ID in a particular presentation
      Specified by:
      showID in interface HelpBroker
      Parameters:
      id - A String identifying the topic to show relative to getHelpSet()
      presentation - The Presentation class to display the Help in.
      presentationName - The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.
      Throws:
      BadIDException - if the ID is not valid in the map.
      See Also:
    • showID

      public void showID(Map.ID id, String presentation, String presentationName) throws InvalidHelpSetContextException
      Description copied from interface: HelpBroker
      Displays this ID in a given presentation
      Specified by:
      showID in interface HelpBroker
      Parameters:
      id - An ID that identifies the topic to display.
      presentation - The Presentation class to display the Help in.
      presentationName - The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.
      Throws:
      InvalidHelpSetContextException - If id.hs is not contanied in the current HelpSet of this broker.
      See Also:
    • enableHelpKey

      public void enableHelpKey(Component comp, String id, HelpSet hs, String presentation, String presentationName)
      Description copied from interface: HelpBroker
      Enables the Help key on a component. This method works best when the component is the rootPane of a JFrame in Swing implementations, or a java.awt.Window (or subclass thereof) in AWT implementations. This method sets the default helpID and HelpSet for the component and registers keyboard actions to trap the "Help" keypress. When the "Help" key is pressed, if the object with the current focus has a helpID, the helpID is displayed, otherwise the default helpID is displayed.
      Specified by:
      enableHelpKey in interface HelpBroker
      Parameters:
      comp - The component to enable the keyboard actions on.
      id - The default HelpID to be displayed.
      hs - The default HelpSet to be displayed.
      presentation - The Presentation class to display the Help in.
      presentationName - The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.
      See Also:
    • enableHelpOnButton

      public void enableHelpOnButton(Object obj, String id, HelpSet hs, String presentation, String presentationName)
      Description copied from interface: HelpBroker
      Enables help for an object. This method sets a object's helpID and HelpSet and adds an ActionListener. When an action is performed it displays the component's helpID and HelpSet in the default viewer or the presenation if defined. If the component is not a javax.swing.AbstractButton or a java.awt.Button an IllegalArgumentException is thrown.
      Specified by:
      enableHelpOnButton in interface HelpBroker
      Parameters:
      id - The default HelpID to be displayed.
      hs - The default HelpSet to be displayed.
      presentation - The Presentation class to display the Help in.
      presentationName - The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.
      See Also: