Uses of Class
javax.help.HelpSet
Packages that use HelpSet
Package
Description
Supports presentation of online documentation with both
content and contextual views of this information.
Supports event changes in JavaHelp classes.
-
Uses of HelpSet in javax.help
Fields in javax.help declared as HelpSetMethods in javax.help that return HelpSetModifier and TypeMethodDescriptionInvalidHelpSetContextException.getContext()
Get the context HelpSetBadIDException.getHelpSet()
The HelpSet that wasn't found in the Mapstatic 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.CSH.Manager.getHelpSet
(Object comp, AWTEvent e) Returns HelpSet of the object depending on the event.DefaultHelpBroker.getHelpSet()
Returns the default HelpSetDefaultHelpModel.getHelpSet()
Gets the backing HelpSet.FlatMap.getHelpSet()
The HelpSet for this Map.HelpBroker.getHelpSet()
Gets the current HelpSet for this JavaHelp object.HelpModel.getHelpSet()
Gets the loaded (aka "top") HelpSet for this model.InvalidHelpSetContextException.getHelpSet()
Get the offending HelpSetInvalidNavigatorViewException.getHelpSet()
Map.ID.getHelpSet()
Getter for property hs.NavigatorView.getHelpSet()
Gets the HelpSet for this Navigator view.Presentation.getHelpSet()
Returns the default HelpSetServletHelpBroker.getHelpSet()
Returns the default HelpSetTreeItem.getHelpSet()
Returns the HelpSet scoping this IndexItem.static HelpSet
HelpSet.parse
(URL url, ClassLoader loader, javax.help.HelpSetFactory factory) Parsed a HelpSet file.HelpSet.DefaultHelpSetFactory.parsingEnded
(HelpSet hs) Parsing has ended.Methods in javax.help with parameters of type HelpSetModifier and TypeMethodDescriptionvoid
Adds a HelpSet, HelpSetEvents are generated.protected void
HelpSet.addSubHelpSet
(HelpSet hs) Adds a SubHelpSet to the current list.boolean
Determines if a HelpSet is a sub-HelpSet of this object.static Map.ID
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.FavoritesView.DefaultFavoritesFactory.createItem
(String tagName, Hashtable atts, HelpSet hs, Locale locale) Creates an FavoritesItem with the given data.IndexView.DefaultIndexFactory.createItem
(String tagName, Hashtable atts, HelpSet hs, Locale locale) Creates an IndexItem with the given data.TOCView.DefaultTOCFactory.createItem
(String tagName, Hashtable atts, HelpSet hs, Locale locale) Create an TOCItem with the given data.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.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
Determines whether the given ID is valid.boolean
Determines if the ID is valid (defined in the map file).boolean
Determines if the ID is valid (known to in the project file).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
Public method for parsing a TOC in a URL.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
We have found a PI; ignore itvoid
Processes a PIvoid
We have found a PI; ignore itvoid
Finds a PI--ignore it.void
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 foundvoid
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
DefaultHelpHistoryModel.removeHelpSet
(HelpSet hs) Removes entries related to removed HelpSet from historyvoid
HelpHistoryModel.removeHelpSet
(HelpSet hs) Removes entries related to removed HelpSet from historystatic 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 HelpSetModifierConstructorDescriptionBadIDException
(String msg, Map map, String id, HelpSet hs) Create the exception.ConstructorConstructs a HelpModel from a HelpSetDisplayHelpAfterTracking
(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.Constructs an FavoritesView with some given data.Create a FlatMap from a given URL.GlossaryView
(HelpSet hs, String name, String label, Hashtable params) Construct a GlossaryView with some given data.Construct a GlossaryViewer VIew with some given data.Create an IndexItem.Construct an IndexView with some given data.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.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
(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 titleJHelpIndexNavigator
(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
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.Constructs a SearchView with some given data.Creates a TOCItem.Constructs a TOC VIew with some given data.Constructs a TOC VIew with some given data.Create an TreeItem. -
Uses of HelpSet in javax.help.event
Methods in javax.help.event that return HelpSetConstructors in javax.help.event with parameters of type HelpSetModifierConstructorDescriptionHelpSetEvent
(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 HelpSetModifier and TypeMethodDescriptionprotected void
BasicGlossaryNavigatorUI.addSubHelpSets
(HelpSet hs) Adds subhelpsetsprotected void
BasicIndexNavigatorUI.addSubHelpSets
(HelpSet hs) Adds subhelpsetsprotected void
BasicSearchNavigatorUI.addSubHelpSets
(HelpSet hs) Adds subhelpsetsprotected void
BasicTOCNavigatorUI.addSubHelpSets
(HelpSet hs) Adds subhelpsets