Package javax.help

Class JHelpFavoritesNavigator

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public class JHelpFavoritesNavigator extends JHelpNavigator
JHelpFavoritesNavigator is a JHelpNavigator for Favorites. All the tree navigation and selection has been delegated to the UI where the JTree is created.
See Also:
  • Constructor Details

    • JHelpFavoritesNavigator

      public JHelpFavoritesNavigator(NavigatorView view)
      Creates an Index navigator.
      Parameters:
      view - The NavigatorView
    • JHelpFavoritesNavigator

      public JHelpFavoritesNavigator(NavigatorView view, HelpModel model)
      Creates a Index navigator.
      Parameters:
      view - The NavigatorView.
      model - The model for the Navigator.
    • JHelpFavoritesNavigator

      public JHelpFavoritesNavigator(HelpSet hs, String name, String label, URL data) throws InvalidNavigatorViewException
      Creates an Index navigator with explicit arguments. Note that this should not throw an InvalidNavigatorViewException since we are implicitly passing the type.
      Parameters:
      hs - HelpSet
      name - The name identifying this HelpSet.
      label - The label to use (for this locale).
      data - The "data" part of the parameters, a URL location of the TOC data.
      Throws:
      InvalidNavigatorViewException
  • Method Details

    • getUIClassID

      public String getUIClassID()
      Gets the UID for this JComponent.
      Overrides:
      getUIClassID in class JHelpNavigator
      Returns:
      "HelpNavigatorUI"
    • canMerge

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

      public void expandID(String target)
      Sets state of navigation entry for given target to expanded. Non-empty entry is expanded. Empty entry is visible.
      Parameters:
      target - The target to expand
    • collapseID

      public void collapseID(String target)
      Sets state of navigation entry for given target to collapsed if entry is visible. Parent is collapsed if entry is empty.
      Parameters:
      target - The target to collapse
    • getAddAction

      public Action getAddAction()
      Returns an AddAction object for this navigator