All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jHelp.htmlHelpIndexFrame 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Frame
                                   |
                                   +----jHelp.htmlHelpIndexFrame
public class htmlHelpIndexFrame
extends Frame
This class provides a basic pop-up index frame that contains a navigable list of indexed items, and optionally word search and query panels.

If constructed with only the name of an index file, then the search and query panels are not created. If a word-list file (generated by htmlHelpIndexBuilder) is included in the constructor, then the index panel and search and query panels are presented in the frame using a tabbed-folders style of UI.

The source of the index and the word list are compiled using the helper application jHelpIndexBuilder. The sequence for implementing an index frame is as follows:

  1. Construct an htmlHelpFrame or htmlHelpPanel object.
  2. Construct an htmlHelpIndexFrame object, passing the instance of the help frame or panel to it in the constructor.
  3. If you are using htmlHelpFrame, use htmlHelpFrame.setHelpIndex to enable the "Index" button, and assign the htmlHelpIndexFrame object to the htmlHelpFrame object.

Note that if you are using an htmlHelpPanel, you will be responsible for implementing an "Index" button to show the index frame in your UI.

Constructor Index

o htmlHelpIndexFrame(String, String, Object, Object)
The most basic index frame constructor, does not provide a word list and uses the default Locale of the machine.
o htmlHelpIndexFrame(String, String, Object, Object, Locale)
This constructor does not provide a word list and uses the specified Locale.
o htmlHelpIndexFrame(String, String, Object, Object, String)
This constructor does not provide a word list, uses the default Locale, and specifies a zip or jar containing the index file.
o htmlHelpIndexFrame(String, String, String, Object, Object)
This constructor, provides both an index and a word list and uses the default Locale of the machine.
o htmlHelpIndexFrame(String, String, String, Object, Object, Locale)
This constructor, provides both an index and a word list and uses the specified Locale.
o htmlHelpIndexFrame(String, String, String, Object, Object, String)
This constructor provides both an index file and a word list, uses the default Locale, and specifies a zip or jar containing the index and word files.
o htmlHelpIndexFrame(String, String, String, Object, Object, String, Locale)
This constructor provides both an index file and a word list, uses the specified Locale, and specifies a zip or jar containing the index and word files.

Method Index

o setLocation(int, int)
Set the index frame's location.
o setLocation(Point)
Set the index frame's location.
o setSize(Dimension)
Set the size of the index frame.
o setSize(int, int)
Set the size of the index frame.
o setVisible(boolean)
Display the index frame, at either the default size and location, or at a previously set size and location.
o show()
Display the index frame, at either the default size and location, or at a previously set size and location.

Constructors

o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           Object instance,
                           Object hf)
The most basic index frame constructor, does not provide a word list and uses the default Locale of the machine.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path)
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           Object instance,
                           Object hf,
                           Locale locale)
This constructor does not provide a word list and uses the specified Locale.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path)
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
locale - a specific Locale object
o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           Object instance,
                           Object hf,
                           String zipfile)
This constructor does not provide a word list, uses the default Locale, and specifies a zip or jar containing the index file.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path), must be a zip entry of the named zip file
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
zipfile - the name of a zip or jar containing the requested index file
o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           String filename2,
                           Object instance,
                           Object hf)
This constructor, provides both an index and a word list and uses the default Locale of the machine.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path)
filename2 - the name of the compiled word-list file (with path)
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           String filename2,
                           Object instance,
                           Object hf,
                           Locale locale)
This constructor, provides both an index and a word list and uses the specified Locale.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path)
filename2 - the name of the compiled word-list file (with path)
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
locale - a specific Locale object
o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           String filename2,
                           Object instance,
                           Object hf,
                           String zipfile)
This constructor provides both an index file and a word list, uses the default Locale, and specifies a zip or jar containing the index and word files.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path), must be a zip entry of the named zip file
filename2 - the name of the compiled word-list file (with path), must be a zip entry of the named zip file
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
zipfile - the name of a zip or jar containing the requested index file
o htmlHelpIndexFrame 
 public htmlHelpIndexFrame(String title,
                           String filename,
                           String filename2,
                           Object instance,
                           Object hf,
                           String zipfile,
                           Locale locale)
This constructor provides both an index file and a word list, uses the specified Locale, and specifies a zip or jar containing the index and word files.

Parameters:
title - the caption to appear in the Frame's title bar
filename - the name of the compiled index file (with path), must be a zip entry of the named zip file
filename2 - the name of the compiled word-list file (with path), must be a zip entry of the named zip file
instance - either an applet, or application frame instance (determines how files ar loaded.)
hf - an instance of either jHelp.htmlHelpFrame or jHelp.htmlHelpPanel that will be associated with this index frame.
zipfile - the name of a zip or jar containing the requested index file
locale - a specific Locale object

Methods

o setSize 
 public void setSize(int width,
                     int height)
Set the size of the index frame. By default, it sets itself to 320x400.

Parameters:
width - the width of the frame
height - the height of the frame
Overrides:
setSize in class Component
o setSize 
 public void setSize(Dimension dim)
Set the size of the index frame. By default, it sets itself to 320x400.

Parameters:
dim - the Dimension that specified the width and height for the frame
Overrides:
setSize in class Component
o setLocation 
 public void setLocation(int x,
                         int y)
Set the index frame's location. By default, it sets itself to fit into the top left corner of the display, with a little clearance from the edges.

Parameters:
x - - the x coordinate of the frame origin
y - - the y coordinate of the frame origin
Overrides:
setLocation in class Component
o setLocation 
 public void setLocation(Point p)
Set the index frame's location. By default, it sets itself to fit into the top left corner of the display, with a little clearance from the edges.

Parameters:
p - - the origin point of the index frame
Overrides:
setLocation in class Component
o show 
 public void show()
Display the index frame, at either the default size and location, or at a previously set size and location.

Overrides:
show in class Window
o setVisible 
 public void setVisible(boolean state)
Display the index frame, at either the default size and location, or at a previously set size and location.

Overrides:
setVisible in class Component 
All Packages  Class Hierarchy  This Package  Previous  Next  Index