Uses of Class javax.help.HelpSet

Uses in package javax.help

Constructors with parameter type javax.help.HelpSet

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

Fields of type javax.help.HelpSet

HelpSet
HelpSet

Methods with parameter type javax.help.HelpSet

void
Adds a HelpSet, HelpSetEvents are generated.
void
Adds a SubHelpSet to the current list.
boolean
Determines if a HelpSet is a sub-HelpSet of this object.
Map.ID
Map.ID.create(String id, HelpSet hs)
A location within a HelpSet.
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
HelpBroker.enableHelp(Component comp, String id, HelpSet hs)
Enables help for a component.
void
ServletHelpBroker.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(MenuItem comp, String id, HelpSet hs)
Enables help for a MenuItem.
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
HelpBroker.enableHelpKey(Component comp, String id, HelpSet hs)
Enables the Help key on a component.
void
ServletHelpBroker.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, String presentation, String presentationName)
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
HelpBroker.enableHelpOnButton(Component comp, String id, HelpSet hs)
Enables help for a component.
void
ServletHelpBroker.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
HelpBroker.enableHelpOnButton(MenuItem comp, String id, HelpSet hs)
Enables help for a MenuItem.
void
ServletHelpBroker.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(Object obj, String id, HelpSet hs, String presentation, String presentationName)
Enables help for an object.
void
ServletHelpBroker.enableHelpOnButton(Object obj, String id, HelpSet hs, String presentation, String presentationName)
void
HelpSet.fireHelpSetAdded(Object source, HelpSet helpset)
Fires a helpSetAdded event.
void
HelpSet.fireHelpSetRemoved(Object source, HelpSet helpset)
Fires a helpSetRemoved event.
Enumeration
Returns an Enumeration HelpActions created from the list of Actions in the Presentation.
Presentation
Creates a new MainWindow for a given HelpSet and HelpSet.Presentation "name".
Presentation
Popup.getPresentation(HelpSet hs, String name)
create a new Popup for a given HelpSet and HelpSet.Presentation "name".
Presentation
Get a "name" Presentation given the passed HelpSet.
Presentation
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).
DefaultMutableTreeNode
IndexView.parse(URL url, HelpSet hs, Locale locale, TreeItemFactory factory)
Public method for parsing an Index in a URL.
DefaultMutableTreeNode
TOCView.parse(URL url, HelpSet hs, Locale locale, TreeItemFactory factory)
Public method for parsing a TOC in a URL.
DefaultMutableTreeNode
TOCView.parse(URL url, HelpSet hs, Locale locale, TreeItemFactory factory, TOCView view)
Public method for parsing a TOC in a URL.
FavoritesNode
FavoritesView.parse(HelpSet hs, Locale locale, TreeItemFactory factory)
Public method for parsing the Favorites in a URL.
HelpSet
Parsing has ended.
void
A HomeID is found.
void
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
Called when a sub-HelpSet is found.
void
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
Removes a HelpSet from this HelpSet; HelpSetEvents are generated Return True if it is found, otherwise false.
void
Removes entries related to removed HelpSet from history
void
Removes entries related to removed HelpSet from history
void
CSH.setHelpSet(Component comp, HelpSet hs)
Sets the static HelpSet for a Component.
void
CSH.setHelpSet(MenuItem comp, HelpSet hs)
Sets the static HelpSet for a MenuItem.
void
Changes the HelpSet for this broker.
void
Sets the HelpSet for this HelpModel.
void
Sets the current HelpSet for this HelpBroker.
void
Sets the loaded (aka "top") HelpSet for this model.
void
Changes the HelpSet for this presentation.
void
Changes the HelpSet for this broker.
void
Set the HelpSet for this TreeItem.
void
Changes the HelpSet for this presentation.

Methods with return type javax.help.HelpSet

HelpSet
Get the context HelpSet
HelpSet
The HelpSet that wasn't found in the Map
HelpSet
Returns the default HelpSet
HelpSet
Gets the backing HelpSet.
HelpSet
The HelpSet for this Map.
HelpSet
Gets the current HelpSet for this JavaHelp object.
HelpSet
Gets the loaded (aka "top") HelpSet for this model.
HelpSet
Get the offending HelpSet
HelpSet
HelpSet
Getter for property hs.
HelpSet
Gets the HelpSet for this Navigator view.
HelpSet
Returns the default HelpSet
HelpSet
Returns the default HelpSet
HelpSet
Returns the HelpSet scoping this IndexItem.
HelpSet
CSH.getHelpSet(Component comp)
Returns the static HelpSet for a Component.
HelpSet
CSH.getHelpSet(MenuItem comp)
Returns the static HelpSet for a MenuItem.
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
HelpSet.parse(URL url, ClassLoader loader, javax.help.HelpSetFactory factory)
Parsed a HelpSet file.
HelpSet
Parsing has ended.

Uses in package javax.help.event

Constructors with parameter type javax.help.HelpSet

HelpSetEvent.HelpSetEvent(Object source, HelpSet helpset, int action)
Creates a HelpSetEvent.

Methods with return type javax.help.HelpSet

HelpSet

Uses in package javax.help.plaf.basic

Methods with parameter type javax.help.HelpSet

void
Adds subhelpsets
void
Adds subhelpsets
void
Adds subhelpsets
void
Adds subhelpsets