# Uses of Class
javax.help.HelpSet

Packages that use HelpSet
Package
Description
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
Modifier and Type
Field
Description
`protected HelpSet`
ServletHelpBroker.`helpset`
`HelpSet`
Map.ID.`hs`
Methods in javax.help that return HelpSet
Modifier and Type
Method
Description
`HelpSet`
InvalidHelpSetContextException.`getContext()`
Get the context HelpSet
`HelpSet`
BadIDException.`getHelpSet()`
The HelpSet that wasn't found in the Map
`static HelpSet`
CSH.`getHelpSet(Component comp)`
Returns the static HelpSet for a Component.
`static HelpSet`
CSH.`getHelpSet(MenuItem comp)`
Returns the static HelpSet for a MenuItem.
`static HelpSet`
CSH.`getHelpSet(Object comp, AWTEvent evt)`
Returns the dynamic HelpSet for an object.
`HelpSet`
CSH.Manager.`getHelpSet(Object comp, AWTEvent e)`
Returns HelpSet of the object depending on the event.
`HelpSet`
DefaultHelpBroker.`getHelpSet()`
Returns the default HelpSet
`HelpSet`
DefaultHelpModel.`getHelpSet()`
Gets the backing HelpSet.
`HelpSet`
FlatMap.`getHelpSet()`
The HelpSet for this Map.
`HelpSet`
HelpBroker.`getHelpSet()`
Gets the current HelpSet for this JavaHelp object.
`HelpSet`
HelpModel.`getHelpSet()`
Gets the loaded (aka "top") HelpSet for this model.
`HelpSet`
InvalidHelpSetContextException.`getHelpSet()`
Get the offending HelpSet
`HelpSet`
InvalidNavigatorViewException.`getHelpSet()`
`HelpSet`
Map.ID.`getHelpSet()`
Getter for property hs.
`HelpSet`
NavigatorView.`getHelpSet()`
Gets the HelpSet for this Navigator view.
`HelpSet`
Presentation.`getHelpSet()`
Returns the default HelpSet
`HelpSet`
ServletHelpBroker.`getHelpSet()`
Returns the default HelpSet
`HelpSet`
TreeItem.`getHelpSet()`
Returns the HelpSet scoping this IndexItem.
`static HelpSet`
HelpSet.`parse(URL url, 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
Modifier and Type
Method
Description
`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 Map.ID`
Map.ID.`create(String id, HelpSet hs)`
A location within a HelpSet.
`static NavigatorView`
NavigatorView.`create(HelpSet hs, String name, String label, Locale locale, String className, Hashtable params)`
Creates a NavigatorView for some given information.
`TreeItem`
FavoritesView.DefaultFavoritesFactory.`createItem(String tagName, Hashtable atts, HelpSet hs, Locale locale)`
Creates an FavoritesItem with the given data.
`TreeItem`
IndexView.DefaultIndexFactory.`createItem(String tagName, Hashtable atts, HelpSet hs, Locale locale)`
Creates an IndexItem with the given data.
`TreeItem`
TOCView.DefaultTOCFactory.`createItem(String tagName, Hashtable atts, HelpSet hs, Locale locale)`
Create an TOCItem with the given data.
`TreeItem`
TreeItemFactory.`createItem(String tagName, Hashtable attributes, HelpSet hs, Locale locale)`
Creates a TreeItem from the given data.
`void`
DefaultHelpBroker.`enableHelp(Component comp, String id, HelpSet hs)`
Enables help for a Component.
`void`
DefaultHelpBroker.`enableHelp(MenuItem comp, String id, HelpSet hs)`
Enables help for a MenuItem.
`void`
HelpBroker.`enableHelp(Component comp, String id, HelpSet hs)`
Enables help for a component.
`void`
HelpBroker.`enableHelp(MenuItem comp, String id, HelpSet hs)`
Enables help for a MenuItem.
`void`
ServletHelpBroker.`enableHelp(Component comp, String id, HelpSet hs)`
Enables help for a Component.
`void`
ServletHelpBroker.`enableHelp(MenuItem comp, String id, HelpSet hs)`
Enables help for a MenuItem.
`void`
DefaultHelpBroker.`enableHelpKey(Component comp, String id, HelpSet hs)`
Enables the Help key on a Component.
`void`
DefaultHelpBroker.`enableHelpKey(Component comp, String id, HelpSet hs, String presentation, String presentationName)`
Enables the Help key on a Component.
`void`
HelpBroker.`enableHelpKey(Component comp, String id, HelpSet hs)`
Enables the Help key on a component.
`void`
HelpBroker.`enableHelpKey(Component comp, String id, HelpSet hs, String presentation, String presentationName)`
Enables the Help key on a component.
`void`
ServletHelpBroker.`enableHelpKey(Component comp, String id, HelpSet hs)`
Enables the Help key on a Component.
`void`
ServletHelpBroker.`enableHelpKey(Component comp, String id, HelpSet hs, String presentation, String presentationName)`
`void`
DefaultHelpBroker.`enableHelpOnButton(Component comp, String id, HelpSet hs)`
Enables help for a Component.
`void`
DefaultHelpBroker.`enableHelpOnButton(MenuItem comp, String id, HelpSet hs)`
Enables help for a MenuItem.
`void`
DefaultHelpBroker.`enableHelpOnButton(Object obj, String id, HelpSet hs, String presentation, String presentationName)`
Enables help for a Component.
`void`
HelpBroker.`enableHelpOnButton(Component comp, String id, HelpSet hs)`
Enables help for a component.
`void`
HelpBroker.`enableHelpOnButton(MenuItem comp, String id, HelpSet hs)`
Enables help for a MenuItem.
`void`
HelpBroker.`enableHelpOnButton(Object obj, String id, HelpSet hs, String presentation, String presentationName)`
Enables help for an object.
`void`
ServletHelpBroker.`enableHelpOnButton(Component comp, String id, HelpSet hs)`
Enables help for a Component.
`void`
ServletHelpBroker.`enableHelpOnButton(MenuItem comp, String id, HelpSet hs)`
Enables help for a MenuItem.
`void`
ServletHelpBroker.`enableHelpOnButton(Object obj, String id, HelpSet hs, String presentation, String presentationName)`
`protected void`
HelpSet.`fireHelpSetAdded(Object source, HelpSet helpset)`
Fires a helpSetAdded event.
`protected void`
HelpSet.`fireHelpSetRemoved(Object source, HelpSet helpset)`
Fires a helpSetRemoved event.
`Enumeration`
HelpSet.Presentation.`getHelpActions(HelpSet hs, Object control)`
Returns an Enumeration HelpActions created from the list of Actions in the Presentation.
`static Presentation`
MainWindow.`getPresentation(HelpSet hs, String name)`
Creates a new MainWindow for a given HelpSet and HelpSet.Presentation "name".
`static Presentation`
Popup.`getPresentation(HelpSet hs, String name)`
create a new Popup for a given HelpSet and HelpSet.Presentation "name".
`static Presentation`
Presentation.`getPresentation(HelpSet hs, String name)`
Get a "name" Presentation given the passed HelpSet.
`static Presentation`
SecondaryWindow.`getPresentation(HelpSet hs, String name)`
Get a named SecondaryWindow for a given HelpSet.
`boolean`
FlatMap.`isValidID(String id, HelpSet hs)`
Determines whether the given ID is valid.
`boolean`
Map.`isValidID(String id, HelpSet hs)`
Determines if the ID is valid (defined in the map file).
`boolean`
TryMap.`isValidID(String id, HelpSet hs)`
Determines if the ID is valid (known to in the project file).
`FavoritesNode`
FavoritesView.`parse(HelpSet hs, Locale locale, TreeItemFactory factory)`
Public method for parsing the Favorites in a URL.
`static DefaultMutableTreeNode`
IndexView.`parse(URL url, HelpSet hs, Locale locale, TreeItemFactory factory)`
Public method for parsing an Index in a URL.
`static DefaultMutableTreeNode`
TOCView.`parse(URL url, HelpSet hs, Locale locale, TreeItemFactory factory)`
Public method for parsing a TOC in a URL.
`static DefaultMutableTreeNode`
TOCView.`parse(URL url, HelpSet hs, 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, String value)`
A HomeID is found.
`void`
HelpSet.DefaultHelpSetFactory.`processMapRef(HelpSet hs, Hashtable attributes)`
process a <mapref>
`void`
FavoritesView.DefaultFavoritesFactory.`processPI(HelpSet hs, String target, String data)`
We have found a PI; ignore it
`void`
HelpSet.DefaultHelpSetFactory.`processPI(HelpSet hs, String target, String data)`
Processes a PI
`void`
IndexView.DefaultIndexFactory.`processPI(HelpSet hs, String target, String data)`
We have found a PI; ignore it
`void`
TOCView.DefaultTOCFactory.`processPI(HelpSet hs, String target, String data)`
Finds a PI--ignore it.
`void`
TreeItemFactory.`processPI(HelpSet hs, String target, String data)`
A Processing Instruction.
`void`
HelpSet.DefaultHelpSetFactory.`processPresentation(HelpSet hs, String name, boolean defaultPresentation, boolean displayViews, boolean displayViewImages, Dimension size, Point location, String title, String imageID, boolean toolbar, Vector helpActions)`
`void`
HelpSet.DefaultHelpSetFactory.`processSubHelpSet(HelpSet hs, Hashtable attributes)`
Called when a sub-HelpSet is found.
`void`
HelpSet.DefaultHelpSetFactory.`processTitle(HelpSet hs, String value)`
A title is found
`void`
HelpSet.DefaultHelpSetFactory.`processView(HelpSet hs, String name, String label, String type, Hashtable viewAttributes, String data, Hashtable dataAttributes, 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(Component comp, HelpSet hs)`
Sets the static HelpSet for a Component.
`static void`
CSH.`setHelpSet(MenuItem comp, HelpSet hs)`
Sets the static HelpSet for a MenuItem.
`void`
DefaultHelpBroker.`setHelpSet(HelpSet hs)`
Changes the HelpSet for this broker.
`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`
Presentation.`setHelpSet(HelpSet hs)`
Changes the HelpSet for this presentation.
`void`
ServletHelpBroker.`setHelpSet(HelpSet hs)`
Changes the HelpSet for this broker.
`void`
TreeItem.`setHelpSet(HelpSet hs)`
Set the HelpSet for this TreeItem.
`void`
WindowPresentation.`setHelpSet(HelpSet hs)`
Changes the HelpSet for this presentation.
Constructors in javax.help with parameters of type HelpSet
Modifier
Constructor
Description
``
`BadIDException(String msg, Map map, String id, HelpSet hs)`
Create the exception.
``
`DefaultHelpBroker(HelpSet hs)`
Constructor
``
`DefaultHelpModel(HelpSet hs)`
Constructs a HelpModel from a HelpSet
``
`DisplayHelpAfterTracking(HelpSet hs, String presentation, String presentationName)`
Create a DisplayHelpAfterTracking actionListener for a given HelpSet.
``
`DisplayHelpFromFocus(HelpSet hs, String presentation, String presentationName)`
Create a DisplayHelpFromFocus actionListener for a given HelpSet.
``
`DisplayHelpFromSource(HelpSet hs, String presentation, String presentationName)`
Create a DisplayHelpFromSource actionListener for a given HelpSet.
``
`FavoritesView(HelpSet hs, String name, String label, Hashtable params)`
Construct an FavoritesView with some given data.
``
`FavoritesView(HelpSet hs, String name, String label, Locale locale, Hashtable params)`
Constructs an FavoritesView with some given data.
``
`FlatMap(URL base, HelpSet hs)`
Create a FlatMap from a given URL.
``
`GlossaryView(HelpSet hs, String name, String label, Hashtable params)`
Construct a GlossaryView with some given data.
``
`GlossaryView(HelpSet hs, String name, String label, Locale locale, Hashtable params)`
Construct a GlossaryViewer VIew with some given data.
``
`IndexItem(Map.ID id, HelpSet hs, Locale locale)`
Create an IndexItem.
``
`IndexView(HelpSet hs, String name, String label, Hashtable params)`
Construct an IndexView with some given data.
``
`IndexView(HelpSet hs, String name, String label, Locale locale, Hashtable params)`
Constructs an IndexView with some given data.
``
`InvalidHelpSetContextException(String msg, HelpSet context, HelpSet hs)`
Create the exception.
``
`InvalidNavigatorViewException(String msg, HelpSet hs, String name, String label, Locale locale, String className, 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, String name, String label, URL data)`
Creates an Index navigator with explicit arguments.
``
`JHelpGlossaryNavigator(HelpSet hs, String name, String title)`
Creates JHelpGlossaryNavigator from given HelpSet, name and title
``
`JHelpIndexNavigator(HelpSet hs, String name, String label, URL data)`
Creates an Index navigator with explicit arguments.
``
`JHelpSearchNavigator(HelpSet hs, String name, String label, URL data)`
Creates a TOC navigator with explicit arguments.
``
`JHelpTOCNavigator(HelpSet hs, String name, String label, URL data)`
Creates a TOC navigator with explicit arguments.
`protected`
`NavigatorView(HelpSet hs, String name, String label, Locale locale, Hashtable params)`
Constructs a Navigator with some given data.
``
`SearchTOCItem(Map.ID id, Map.ID imageID, HelpSet hs, Locale locale)`
``
`SearchView(HelpSet hs, String name, String label, Hashtable params)`
Constructs a SearchView with some given data.
``
`SearchView(HelpSet hs, String name, String label, Locale locale, Hashtable params)`
Constructs a SearchView with some given data.
``
`TOCItem(Map.ID id, Map.ID imageID, HelpSet hs, Locale locale)`
Creates a TOCItem.
``
`TOCView(HelpSet hs, String name, String label, Hashtable params)`
Constructs a TOC VIew with some given data.
``
`TOCView(HelpSet hs, String name, String label, Locale locale, Hashtable params)`
Constructs a TOC VIew with some given data.
``
`TreeItem(Map.ID id, HelpSet hs, Locale locale)`
Create an TreeItem.
``
`WindowPresentation(HelpSet hs)`

## Uses of HelpSet in javax.help.event

Methods in javax.help.event that return HelpSet
Modifier and Type
Method
Description
`HelpSet`
HelpSetEvent.`getHelpSet()`
Constructors in javax.help.event with parameters of type HelpSet
Modifier
Constructor
Description
``
`HelpSetEvent(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
Modifier and Type
Method
Description
`protected void`
BasicGlossaryNavigatorUI.`addSubHelpSets(HelpSet hs)`
Adds subhelpsets
`protected void`
BasicIndexNavigatorUI.`addSubHelpSets(HelpSet hs)`
Adds subhelpsets
`protected void`
BasicSearchNavigatorUI.`addSubHelpSets(HelpSet hs)`
Adds subhelpsets
`protected void`
BasicTOCNavigatorUI.`addSubHelpSets(HelpSet hs)`
Adds subhelpsets