Package javax.help

Class JHelpTOCNavigator

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

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

    • JHelpTOCNavigator

      public JHelpTOCNavigator(NavigatorView view)
      Create a TOC navigator
      Parameters:
      view - The NavigatorView. If view is null it creates a JHelpTOCNavigator without a HelpModel and a null NavigatorView.
    • JHelpTOCNavigator

      public JHelpTOCNavigator(NavigatorView view, HelpModel model)
      Creates a TOC navigator.
      Parameters:
      view - The NavigatorView. If view is null it creates a JHelpTOCNavigator with a null NavigatorView.
      model - The model for the Navigator. If model is null it creates a JHelpTOCNavigator witout a model.
    • JHelpTOCNavigator

      public JHelpTOCNavigator(HelpSet hs, String name, String label, URL data) throws InvalidNavigatorViewException
      Creates a TOC navigator with explicit arguments. Note that this should not throw an InvalidNavigatorViewException since the type is implicitly passed.
      Parameters:
      hs - HelpSet
      name - The name indentifying 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()
      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:
      • invalid reference
        merge()
      • invalid reference
        remove()
    • merge

      public void merge(NavigatorView view)
      Merges a NavigatorView into this instance.
      Overrides:
      merge in class JHelpNavigator
      Parameters:
      view - The data to merge. This must be a TOCView.
      Throws:
      IllegalArgumentException
      IllegalStateException
      See Also:
      • invalid reference
        canMerge()
      • invalid reference
        remove()
    • remove

      public void remove(NavigatorView view)
      Removes a NavigatorView from this instance.
      Overrides:
      remove in class JHelpNavigator
      Parameters:
      view - The data to merge.
      Throws:
      IllegalArgumentException
      IllegalStateException
      See Also:
      • invalid reference
        canMerge()
      • invalid reference
        merge()
    • 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