Uses of Class
javax.help.HelpSet

Packages that use HelpSet
javax.help Supports presentation of online documentation with both content and contextual views of this information. 
javax.help.event Supports event changes in JavaHelp classes. 
javax.help.plaf.basic   
 

Uses of HelpSet in javax.help
 

Fields in javax.help declared as HelpSet
protected  HelpSet ServletHelpBroker.helpset
           
 HelpSet Map.ID.hs
           
 

Methods in javax.help that return HelpSet
 HelpSet InvalidHelpSetContextException.getContext()
          Get the context HelpSet
 HelpSet NavigatorView.getHelpSet()
          Gets the HelpSet for this Navigator view.
 HelpSet TreeItem.getHelpSet()
          Returns the HelpSet scoping this IndexItem.
 HelpSet FlatMap.getHelpSet()
          The HelpSet for this Map.
 HelpSet DefaultHelpModel.getHelpSet()
          Gets the backing HelpSet.
 HelpSet InvalidNavigatorViewException.getHelpSet()
           
 HelpSet Map.ID.getHelpSet()
          Getter for property hs.
 HelpSet HelpBroker.getHelpSet()
          Gets the current HelpSet for this JavaHelp object.
 HelpSet BadIDException.getHelpSet()
          The HelpSet that wasn't found in the Map
 HelpSet HelpModel.getHelpSet()
          Gets the loaded (aka "top") HelpSet for this model.
 HelpSet InvalidHelpSetContextException.getHelpSet()
          Get the offending HelpSet
 HelpSet DefaultHelpBroker.getHelpSet()
          Returns the default HelpSet
 HelpSet Presentation.getHelpSet()
          Returns the default HelpSet
 HelpSet ServletHelpBroker.getHelpSet()
          Returns the default HelpSet
static HelpSet CSH.getHelpSet(java.awt.Component comp)
          Returns the static HelpSet for a Component.
static HelpSet CSH.getHelpSet(java.awt.MenuItem comp)
          Returns the static HelpSet for a MenuItem.
static HelpSet CSH.getHelpSet(java.lang.Object comp, java.awt.AWTEvent evt)
          Returns the dynamic HelpSet for an object.
 HelpSet CSH.Manager.getHelpSet(java.lang.Object comp, java.awt.AWTEvent e)
          Returns HelpSet of the object depending on the event.
static HelpSet HelpSet.parse(java.net.URL url, java.lang.ClassLoader loader, javax.help.HelpSetFactory factory)
          Parsed a HelpSet file.
 HelpSet HelpSet.DefaultHelpSetFactory.parsingEnded(HelpSet hs)
          Parsing has ended.
 

Methods in javax.help with parameters of type HelpSet
 void HelpSet.add(HelpSet hs)
          Adds a HelpSet, HelpSetEvents are generated.
protected  void HelpSet.addSubHelpSet(HelpSet hs)
          Adds a SubHelpSet to the current list.
 boolean HelpSet.contains(HelpSet hs)
          Determines if a HelpSet is a sub-HelpSet of this object.
static NavigatorView NavigatorView.create(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.lang.String className, java.util.Hashtable params)
          Creates a NavigatorView for some given information.
static Map.ID Map.ID.create(java.lang.String id, HelpSet hs)
          A location within a HelpSet.
 TreeItem FavoritesView.DefaultFavoritesFactory.createItem(java.lang.String tagName, java.util.Hashtable atts, HelpSet hs, java.util.Locale locale)
          Creates an FavoritesItem with the given data.
 TreeItem TOCView.DefaultTOCFactory.createItem(java.lang.String tagName, java.util.Hashtable atts, HelpSet hs, java.util.Locale locale)
          Create an TOCItem with the given data.
 TreeItem IndexView.DefaultIndexFactory.createItem(java.lang.String tagName, java.util.Hashtable atts, HelpSet hs, java.util.Locale locale)
          Creates an IndexItem with the given data.
 TreeItem TreeItemFactory.createItem(java.lang.String tagName, java.util.Hashtable attributes, HelpSet hs, java.util.Locale locale)
          Creates a TreeItem from the given data.
 void HelpBroker.enableHelp(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables help for a component.
 void DefaultHelpBroker.enableHelp(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables help for a Component.
 void ServletHelpBroker.enableHelp(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables help for a Component.
 void HelpBroker.enableHelp(java.awt.MenuItem comp, java.lang.String id, HelpSet hs)
          Enables help for a MenuItem.
 void DefaultHelpBroker.enableHelp(java.awt.MenuItem comp, java.lang.String id, HelpSet hs)
          Enables help for a MenuItem.
 void ServletHelpBroker.enableHelp(java.awt.MenuItem comp, java.lang.String id, HelpSet hs)
          Enables help for a MenuItem.
 void HelpBroker.enableHelpKey(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables the Help key on a component.
 void DefaultHelpBroker.enableHelpKey(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables the Help key on a Component.
 void ServletHelpBroker.enableHelpKey(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables the Help key on a Component.
 void HelpBroker.enableHelpKey(java.awt.Component comp, java.lang.String id, HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Enables the Help key on a component.
 void DefaultHelpBroker.enableHelpKey(java.awt.Component comp, java.lang.String id, HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Enables the Help key on a Component.
 void ServletHelpBroker.enableHelpKey(java.awt.Component comp, java.lang.String id, HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
           
 void HelpBroker.enableHelpOnButton(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables help for a component.
 void DefaultHelpBroker.enableHelpOnButton(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables help for a Component.
 void ServletHelpBroker.enableHelpOnButton(java.awt.Component comp, java.lang.String id, HelpSet hs)
          Enables help for a Component.
 void HelpBroker.enableHelpOnButton(java.awt.MenuItem comp, java.lang.String id, HelpSet hs)
          Enables help for a MenuItem.
 void DefaultHelpBroker.enableHelpOnButton(java.awt.MenuItem comp, java.lang.String id, HelpSet hs)
          Enables help for a MenuItem.
 void ServletHelpBroker.enableHelpOnButton(java.awt.MenuItem comp, java.lang.String id, HelpSet hs)
          Enables help for a MenuItem.
 void HelpBroker.enableHelpOnButton(java.lang.Object obj, java.lang.String id, HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Enables help for an object.
 void DefaultHelpBroker.enableHelpOnButton(java.lang.Object obj, java.lang.String id, HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Enables help for a Component.
 void ServletHelpBroker.enableHelpOnButton(java.lang.Object obj, java.lang.String id, HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
           
protected  void HelpSet.fireHelpSetAdded(java.lang.Object source, HelpSet helpset)
          Fires a helpSetAdded event.
protected  void HelpSet.fireHelpSetRemoved(java.lang.Object source, HelpSet helpset)
          Fires a helpSetRemoved event.
 java.util.Enumeration HelpSet.Presentation.getHelpActions(HelpSet hs, java.lang.Object control)
          Returns an Enumeration HelpActions created from the list of Actions in the Presentation.
static Presentation SecondaryWindow.getPresentation(HelpSet hs, java.lang.String name)
          Get a named SecondaryWindow for a given HelpSet.
static Presentation MainWindow.getPresentation(HelpSet hs, java.lang.String name)
          Creates a new MainWindow for a given HelpSet and HelpSet.Presentation "name".
static Presentation Popup.getPresentation(HelpSet hs, java.lang.String name)
          create a new Popup for a given HelpSet and HelpSet.Presentation "name".
static Presentation Presentation.getPresentation(HelpSet hs, java.lang.String name)
          Get a "name" Presentation given the passed HelpSet.
 boolean TryMap.isValidID(java.lang.String id, HelpSet hs)
          Determines if the ID is valid (known to in the project file).
 boolean FlatMap.isValidID(java.lang.String id, HelpSet hs)
          Determines whether the given ID is valid.
 boolean Map.isValidID(java.lang.String id, HelpSet hs)
          Determines if the ID is valid (defined in the map file).
 FavoritesNode FavoritesView.parse(HelpSet hs, java.util.Locale locale, TreeItemFactory factory)
          Public method for parsing the Favorites in a URL.
static javax.swing.tree.DefaultMutableTreeNode TOCView.parse(java.net.URL url, HelpSet hs, java.util.Locale locale, TreeItemFactory factory)
          Public method for parsing a TOC in a URL.
static javax.swing.tree.DefaultMutableTreeNode IndexView.parse(java.net.URL url, HelpSet hs, java.util.Locale locale, TreeItemFactory factory)
          Public method for parsing an Index in a URL.
static javax.swing.tree.DefaultMutableTreeNode TOCView.parse(java.net.URL url, HelpSet hs, java.util.Locale locale, TreeItemFactory factory, TOCView view)
          Public method for parsing a TOC in a URL.
 HelpSet HelpSet.DefaultHelpSetFactory.parsingEnded(HelpSet hs)
          Parsing has ended.
 void HelpSet.DefaultHelpSetFactory.processHomeID(HelpSet hs, java.lang.String value)
          A HomeID is found.
 void HelpSet.DefaultHelpSetFactory.processMapRef(HelpSet hs, java.util.Hashtable attributes)
          process a <mapref>
 void FavoritesView.DefaultFavoritesFactory.processPI(HelpSet hs, java.lang.String target, java.lang.String data)
          We have found a PI; ignore it
 void TOCView.DefaultTOCFactory.processPI(HelpSet hs, java.lang.String target, java.lang.String data)
          Finds a PI--ignore it.
 void IndexView.DefaultIndexFactory.processPI(HelpSet hs, java.lang.String target, java.lang.String data)
          We have found a PI; ignore it
 void TreeItemFactory.processPI(HelpSet hs, java.lang.String target, java.lang.String data)
          A Processing Instruction.
 void HelpSet.DefaultHelpSetFactory.processPI(HelpSet hs, java.lang.String target, java.lang.String data)
          Processes a PI
 void HelpSet.DefaultHelpSetFactory.processPresentation(HelpSet hs, java.lang.String name, boolean defaultPresentation, boolean displayViews, boolean displayViewImages, java.awt.Dimension size, java.awt.Point location, java.lang.String title, java.lang.String imageID, boolean toolbar, java.util.Vector helpActions)
           
 void HelpSet.DefaultHelpSetFactory.processSubHelpSet(HelpSet hs, java.util.Hashtable attributes)
          Called when a sub-HelpSet is found.
 void HelpSet.DefaultHelpSetFactory.processTitle(HelpSet hs, java.lang.String value)
          A title is found
 void HelpSet.DefaultHelpSetFactory.processView(HelpSet hs, java.lang.String name, java.lang.String label, java.lang.String type, java.util.Hashtable viewAttributes, java.lang.String data, java.util.Hashtable dataAttributes, java.util.Locale locale)
           
 boolean HelpSet.remove(HelpSet hs)
          Removes a HelpSet from this HelpSet; HelpSetEvents are generated Return True if it is found, otherwise false.
 void DefaultHelpHistoryModel.removeHelpSet(HelpSet hs)
          Removes entries related to removed HelpSet from history
 void HelpHistoryModel.removeHelpSet(HelpSet hs)
          Removes entries related to removed HelpSet from history
static void CSH.setHelpSet(java.awt.Component comp, HelpSet hs)
          Sets the static HelpSet for a Component.
 void WindowPresentation.setHelpSet(HelpSet hs)
          Changes the HelpSet for this presentation.
 void TreeItem.setHelpSet(HelpSet hs)
          Set the HelpSet for this TreeItem.
 void DefaultHelpModel.setHelpSet(HelpSet hs)
          Sets the HelpSet for this HelpModel.
 void HelpBroker.setHelpSet(HelpSet hs)
          Sets the current HelpSet for this HelpBroker.
 void HelpModel.setHelpSet(HelpSet hs)
          Sets the loaded (aka "top") HelpSet for this model.
 void DefaultHelpBroker.setHelpSet(HelpSet hs)
          Changes the HelpSet for this broker.
 void Presentation.setHelpSet(HelpSet hs)
          Changes the HelpSet for this presentation.
 void ServletHelpBroker.setHelpSet(HelpSet hs)
          Changes the HelpSet for this broker.
static void CSH.setHelpSet(java.awt.MenuItem comp, HelpSet hs)
          Sets the static HelpSet for a MenuItem.
 

Constructors in javax.help with parameters of type HelpSet
BadIDException(java.lang.String msg, Map map, java.lang.String id, HelpSet hs)
          Create the exception.
CSH.DisplayHelpAfterTracking(HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Create a DisplayHelpAfterTracking actionListener for a given HelpSet.
CSH.DisplayHelpFromFocus(HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Create a DisplayHelpFromFocus actionListener for a given HelpSet.
CSH.DisplayHelpFromSource(HelpSet hs, java.lang.String presentation, java.lang.String presentationName)
          Create a DisplayHelpFromSource actionListener for a given HelpSet.
DefaultHelpBroker(HelpSet hs)
          Constructor
DefaultHelpModel(HelpSet hs)
          Constructs a HelpModel from a HelpSet
FavoritesView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
          Construct an FavoritesView with some given data.
FavoritesView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
          Constructs an FavoritesView with some given data.
FlatMap(java.net.URL base, HelpSet hs)
          Create a FlatMap from a given URL.
GlossaryView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
          Construct a GlossaryView with some given data.
GlossaryView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
          Construct a GlossaryViewer VIew with some given data.
IndexItem(Map.ID id, HelpSet hs, java.util.Locale locale)
          Create an IndexItem.
IndexView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
          Construct an IndexView with some given data.
IndexView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
          Constructs an IndexView with some given data.
InvalidHelpSetContextException(java.lang.String msg, HelpSet context, HelpSet hs)
          Create the exception.
InvalidNavigatorViewException(java.lang.String msg, HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.lang.String className, java.util.Hashtable params)
          Create an exception.
JHelp(HelpSet hs)
          Create a JHelp with a JHelpContentViewer and all Navigators requested in the HelpSet.
JHelpContentViewer(HelpSet hs)
          Creates a JHelp with an instance of DefaultHelpModel as its data model.
JHelpFavoritesNavigator(HelpSet hs, java.lang.String name, java.lang.String label, java.net.URL data)
          Creates an Index navigator with explicit arguments.
JHelpGlossaryNavigator(HelpSet hs, java.lang.String name, java.lang.String title)
          Creates JHelpGlossaryNavigator from given HelpSet, name and title
JHelpIndexNavigator(HelpSet hs, java.lang.String name, java.lang.String label, java.net.URL data)
          Creates an Index navigator with explicit arguments.
JHelpSearchNavigator(HelpSet hs, java.lang.String name, java.lang.String label, java.net.URL data)
          Creates a TOC navigator with explicit arguments.
JHelpTOCNavigator(HelpSet hs, java.lang.String name, java.lang.String label, java.net.URL data)
          Creates a TOC navigator with explicit arguments.
NavigatorView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
          Constructs a Navigator with some given data.
SearchTOCItem(Map.ID id, Map.ID imageID, HelpSet hs, java.util.Locale locale)
           
SearchView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
          Constructs a SearchView with some given data.
SearchView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
          Constructs a SearchView with some given data.
TOCItem(Map.ID id, Map.ID imageID, HelpSet hs, java.util.Locale locale)
          Creates a TOCItem.
TOCView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
          Constructs a TOC VIew with some given data.
TOCView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
          Constructs a TOC VIew with some given data.
TreeItem(Map.ID id, HelpSet hs, java.util.Locale locale)
          Create an TreeItem.
WindowPresentation(HelpSet hs)
           
 

Uses of HelpSet in javax.help.event
 

Methods in javax.help.event that return HelpSet
 HelpSet HelpSetEvent.getHelpSet()
           
 

Constructors in javax.help.event with parameters of type HelpSet
HelpSetEvent(java.lang.Object source, HelpSet helpset, int action)
          Creates a HelpSetEvent.
 

Uses of HelpSet in javax.help.plaf.basic
 

Methods in javax.help.plaf.basic with parameters of type HelpSet
protected  void BasicTOCNavigatorUI.addSubHelpSets(HelpSet hs)
          Adds subhelpsets
protected  void BasicIndexNavigatorUI.addSubHelpSets(HelpSet hs)
          Adds subhelpsets
protected  void BasicGlossaryNavigatorUI.addSubHelpSets(HelpSet hs)
          Adds subhelpsets
protected  void BasicSearchNavigatorUI.addSubHelpSets(HelpSet hs)
          Adds subhelpsets