All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jHelp.htmlHelpIndexPanel 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----jHelp.htmlHelpIndexPanel
public final class htmlHelpIndexPanel
extends Panel
implements ActionListener
This class creates an index panel, in which the user can select index entries to navigate to the associated document. Index files are compiled using jHelp.htmlHelpIndexBuilder or the GUI wizard, jHelp.index.Wizard.

Constructor Index

o htmlHelpIndexPanel(String, Object, Object)
This constructor takes a filespec for the compiled index file, the applet or frame instance of the program deploying jHelp, and either an htmlHelpFrame or htmlHelpPanel object.
o htmlHelpIndexPanel(String, Object, Object, Locale)
This constructor takes a filespec for the compiled index file, the applet or frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, and a specific locale.
o htmlHelpIndexPanel(String, Object, Object, String)
This constructor takes a zip entry name for the compiled index file, the frame instance of the application deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, and the filespec of the zip or jar file that contains the index file as specified.
o htmlHelpIndexPanel(String, Object, Object, String, Locale)
This constructor takes a zip entry name for the compiled index file, the frame instance of the application deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, the filespec of the zip or jar file that contains the index file as specified, and a specific locale.
o htmlHelpIndexPanel(String, Object, Object, String, ResourceBundle)
This constructor takes a zip entry name for the compiled index file, the applet or frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, the filespec of the zip or jar file that contains the index file as specified, and a specific ResourceBundle

Method Index

o actionPerformed(ActionEvent)

Constructors

o htmlHelpIndexPanel 
 public htmlHelpIndexPanel(String filename,
                           Object instance,
                           Object hf)
This constructor takes a filespec for the compiled index file, the applet or frame instance of the program deploying jHelp, and either an htmlHelpFrame or htmlHelpPanel object.

Parameters:
filename - the filespec of the compiled index file
instance - either an Applet, or valid frame (for an application)
hf - the htmlHelpFrame or htmlHelpPanel associated with the index.
o htmlHelpIndexPanel 
 public htmlHelpIndexPanel(String zipentry,
                           Object instance,
                           Object hf,
                           String zipfile)
This constructor takes a zip entry name for the compiled index file, the frame instance of the application deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, and the filespec of the zip or jar file that contains the index file as specified. Applets should not use this as they cannot use separate zips or jars.

Parameters:
zipentry - the zip entry name of the compiled index file
instance - either an Applet, or valid frame (for an application)
hf - the htmlHelpFrame or htmlHelpPanel associated with the index.
zipfile - the filespec of the zip or jar containing the index
o htmlHelpIndexPanel 
 public htmlHelpIndexPanel(String filename,
                           Object instance,
                           Object hf,
                           Locale locale)
This constructor takes a filespec for the compiled index file, the applet or frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, and a specific locale.

Parameters:
filename - the filespec of the compiled index file
instance - either an Applet, or valid frame (for an application)
hf - the htmlHelpFrame or htmlHelpPanel associated with the index.
locale - a Locale object, overrides the user's default
o htmlHelpIndexPanel 
 public htmlHelpIndexPanel(String zipentry,
                           Object instance,
                           Object hf,
                           String zipfile,
                           Locale locale)
This constructor takes a zip entry name for the compiled index file, the frame instance of the application deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, the filespec of the zip or jar file that contains the index file as specified, and a specific locale. Applets should not use this as they cannot use separate zips or jars.

Parameters:
zipentry - the zip entry name of the compiled index file
instance - either an Applet, or valid frame (for an application)
hf - the htmlHelpFrame or htmlHelpPanel associated with the index.
zipfile - the filespec of the zip or jar containing the index
locale - a Locale object, overrides the user's default
o htmlHelpIndexPanel 
 public htmlHelpIndexPanel(String zipentry,
                           Object instance,
                           Object hf,
                           String zipfile,
                           ResourceBundle resources)
This constructor takes a zip entry name for the compiled index file, the applet or frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, the filespec of the zip or jar file that contains the index file as specified, and a specific ResourceBundle

Parameters:
zipentry - the zip entry name of the compiled index file
instance - either an Applet, or valid frame (for an application)
hf - the htmlHelpFrame or htmlHelpPanel associated with the index.
zipfile - the filespec of the zip or jar containing the index. If null, the zipentry name is treated as a filespec. Applets should pass null for this parameter.
resources - a jHelp.htmlResources ResourceBundle object.

Methods

o actionPerformed 
 public void actionPerformed(ActionEvent e)

All Packages  Class Hierarchy  This Package  Previous  Next  Index