All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jHelp.htmlHelpSearchPanel

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----jHelp.htmlHelpSearchPanel

public final class htmlHelpSearchPanel
extends Panel
implements ActionListener
This class creates a global word search panel. The word list is optionally compiled when the index is created, using jHelp.htmlHelpIndexBuilder, or the index wizard, jHelp.index.Wizard.


Constructor Index

 o htmlHelpSearchPanel(String, Object, Object)
This constructor creates a search panel, given the filespec of the compiled word list, the Applet or valid Frame instance of the program deploying jHelp, and an htmlHelpFrame or htmlHelpPanel associated with the word list.
 o htmlHelpSearchPanel(String, Object, Object, Locale)
This constructor creates a search panel, given the filespec of the compiled word list, the Applet or valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a specific Locale object.
 o htmlHelpSearchPanel(String, Object, Object, String)
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, and an htmlHelpFrame or htmlHelpPanel associated with the word list.
 o htmlHelpSearchPanel(String, Object, Object, String, Locale)
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a specific locale object.
 o htmlHelpSearchPanel(String, Object, Object, String, ResourceBundle)
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a jHelp.htmlResources ResourceBundle.

Method Index

 o actionPerformed(ActionEvent)
 o setBounds(int, int, int, int)

Constructors

 o htmlHelpSearchPanel
 public htmlHelpSearchPanel(String filename,
                            Object instance,
                            Object help)
This constructor creates a search panel, given the filespec of the compiled word list, the Applet or valid Frame instance of the program deploying jHelp, and an htmlHelpFrame or htmlHelpPanel associated with the word list.

Parameters:
filename - the filespec of the word list, generated with jHelp.htmlHelpIndexBuilder or the index wizard, jHelp.index.Wizard
instance - an Applet or if used in an application, a valid Frame instance of the program deploying jHelp
help - the jHelp.htmlHelpFrame or jHelp.htmlHelpPanel associated with the word list.
 o htmlHelpSearchPanel
 public htmlHelpSearchPanel(String zipentry,
                            Object instance,
                            Object help,
                            String zipfile)
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, and an htmlHelpFrame or htmlHelpPanel associated with the word list. Applets should not use this constructor.

Parameters:
filename - the filespec of the word list, generated with jHelp.htmlHelpIndexBuilder or the index wizard, jHelp.index.Wizard
instance - a valid Frame instance of the application deploying jHelp
help - the jHelp.htmlHelpFrame or jHelp.htmlHelpPanel associated with the word list.
 o htmlHelpSearchPanel
 public htmlHelpSearchPanel(String filename,
                            Object instance,
                            Object help,
                            Locale locale)
This constructor creates a search panel, given the filespec of the compiled word list, the Applet or valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a specific Locale object.

Parameters:
filename - the filespec of the word list, generated with jHelp.htmlHelpIndexBuilder or the index wizard, jHelp.index.Wizard
instance - an Applet or if used in an application, a valid Frame instance of the program deploying jHelp
help - the jHelp.htmlHelpFrame or jHelp.htmlHelpPanel associated with the word list.
locale - a specific locale object, overrides the user's default.
 o htmlHelpSearchPanel
 public htmlHelpSearchPanel(String zipentry,
                            Object instance,
                            Object help,
                            String zipfile,
                            Locale locale)
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a specific locale object. Applets should not use this constructor.

Parameters:
filename - the filespec of the word list, generated with jHelp.htmlHelpIndexBuilder or the index wizard, jHelp.index.Wizard
instance - a valid Frame instance of the application deploying jHelp
help - the jHelp.htmlHelpFrame or jHelp.htmlHelpPanel associated with the word list.
locale - a specific locale object
 o htmlHelpSearchPanel
 public htmlHelpSearchPanel(String zipentry,
                            Object instance,
                            Object help,
                            String zipfile,
                            ResourceBundle resources)
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a jHelp.htmlResources ResourceBundle. Applets should pass null as the zipfile parameter.

Parameters:
zipentry - the zip entry of the word list, generated with jHelp.htmlHelpIndexBuilder or the index wizard, jHelp.index.Wizard. If zipfile is null, this will be treated as a filespec.
instance - an Applet or valid Frame instance of the program deploying jHelp
help - the jHelp.htmlHelpFrame or jHelp.htmlHelpPanel associated with the word list.
zipfile - the filespec of the zip or jar containing the word list. Applets should pass null for this parameter.
resources - a jHelp.htmlResources object

Methods

 o setBounds
 public void setBounds(int x,
                       int y,
                       int w,
                       int h)
Overrides:
setBounds in class Component
 o actionPerformed
 public void actionPerformed(ActionEvent e)

All Packages  Class Hierarchy  This Package  Previous  Next  Index