Package javax.help

Class JHelpNavigator

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
Direct Known Subclasses:
JHelpFavoritesNavigator, JHelpGlossaryNavigator, JHelpIndexNavigator, JHelpSearchNavigator, JHelpTOCNavigator

public class JHelpNavigator extends JComponent implements Accessible
A JHelpNavigator is a control that presents navigational help data. It is identified by a type and it interacts with a HelpModel. There are three JHelpNavigators that most JavaHelp implementations should support:
See Also:
  • Field Details

  • Constructor Details

    • JHelpNavigator

      public JHelpNavigator(NavigatorView view)
      Returns a JHelpNavigator with an instance of DefaultHelpModel as its data model.
      Parameters:
      view - The NavigatorView to use. If view is null it creates a JHelpTOCNavigator with a null NavigatorView.
    • JHelpNavigator

      public JHelpNavigator(NavigatorView view, HelpModel model)
      Constructs a JHelpNavigator from some view and with a preexisting model and in default initial state of navigation entries.
      Parameters:
      view - The NavigatorView. If view is null it creates a JHelpNavigator with a null NavigatorView.
      model - The model that generates changes. If model is null it creates a JHelpNavigator without a model.
  • Method Details

    • getSelectedItems

      public TreeItem[] getSelectedItems()
      Returns a list of selected items
    • setSelectedItems

      public void setSelectedItems(TreeItem[] selectedItems)
      Sets the list of selected items
    • getUIClassID

      public String getUIClassID()
      Overrides:
      getUIClassID in class JComponent
      Returns:
      "HelpNavigatorUI"
    • canMerge

      public boolean canMerge(NavigatorView view)
      Determines if this instance of a JHelpNavigator can merge its data with another one.
      Parameters:
      view - The data to merge.
      Returns:
      Whether it can be merged.
      See Also:
    • merge

      public void merge(NavigatorView view)
      Merged a NavigatorView into this instance.
      Parameters:
      view - The data to merge
      Throws:
      UnsupportedOperationException
      See Also:
    • remove

      public void remove(NavigatorView view)
      Removes a NavigatorView from this instance.
      Parameters:
      view - The data to merge
      Throws:
      UnsupportedOperationException
      See Also:
    • getNavigatorName

      public String getNavigatorName()
      Names this Navigator.
      Returns:
      The name of this Navigator. This is locale independent and can be used by the application to identify the view.
    • getNavigatorView

      public NavigatorView getNavigatorView()
      Gets the NavigatorView that created this Navigator View.
      Returns:
      the NavigatorView
    • getNavigatorLabel

      public String getNavigatorLabel()
      Gets the name of this navigator view.
      Returns:
      The label for this NavigatorView.
    • getNavigatorLabel

      public String getNavigatorLabel(Locale locale)
      Gets locale-dependent name for this navigator view.
      Returns:
      the label for this NavigatorView. If locale is null it is treated as the default Locale.
    • getIcon

      public Icon getIcon()
      Gets an icon to identify this Navigator. Currently this is a read-only property.
      Returns:
      An icon to identify this navigator.
    • setModel

      public void setModel(HelpModel newModel)
      Sets the HelpModel that provides the data.
      Parameters:
      newModel - The HelpModel for this component. A null for newModel is valid.
    • getModel

      public HelpModel getModel()
      Returns the HelpModel that provides the data.
    • setUI

      public void setUI(HelpNavigatorUI ui)
      Sets the HelpUI that provides the current look and feel.
    • getUI

      public HelpNavigatorUI getUI()
      Returns the HelpUI that provides the current look and feel.
      Overrides:
      getUI in class JComponent
    • updateUI

      public void updateUI()
      Replaces the UI with the latest version from the default UIFactory.
      Overrides:
      updateUI in class JComponent
    • addHelpModelListener

      public void addHelpModelListener(HelpModelListener l)
      Adds a listener for the HelpModelEvent posted after the model has changed.
      Parameters:
      l - - The listener to add.
      See Also:
    • removeHelpModelListener

      public void removeHelpModelListener(HelpModelListener l)
      Removes a listener previously added with addHelpModelListener.
      Parameters:
      l - - The listener to remove.
      See Also:
    • createParams

      protected static Hashtable createParams(URL data)
      Creates the parameters for a Navigator from data stored in a URL.
      Returns:
      A Hashtable of parameters
    • getAccessibleContext

      public AccessibleContext getAccessibleContext()
      Get the AccessibleContext associated with this JComponent.
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class Component
      Returns:
      The AccessibleContext of this JComponent