Class jHelp.htmlHelpFrame
All Packages Class Hierarchy This Package Previous Next Index
Class jHelp.htmlHelpFrame
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----java.awt.Window
|
+----java.awt.Frame
|
+----jHelp.htmlHelpFrame
- public class htmlHelpFrame
- extends Frame
A class to provide a pop-up help browser Frame incorporating Back, Forward
Search and Close Buttons.
-
htmlHelpFrame(Object, String)
- This class provides a basic pop-up browser frame that contains Back, Forward
and Search buttons, in addition to an htmlHelpPanel component.
-
addFile(Object, String)
- The addFile method permits loading additional help source files subsequent
to construction.
-
handleEvent(Event)
-
-
show()
- This overridden show method simply displays the current help file, at the current
document position.
-
show(String)
- This overridden show method permits the named help file to be displayed,
optionally at a specific NAME'd location within
the file.
htmlHelpFrame
public htmlHelpFrame(Object instance,
String fileName)
- This class provides a basic pop-up browser frame that contains Back, Forward
and Search buttons, in addition to an htmlHelpPanel component.
The htmlHelpFrame constructor requires the instance of the parent container
as the first argument. This is used by jHelp to determine if the class is
being invoked by an applet or application.
The fileName argument is a String comprised of one or more help source file
names. Where more than one help file is being loaded in the constructor, the
names should be entered as a single string, with the file names delimited by
a '|' character.
For example
new htmlHelpFrame(this,"help1.html|help2.html|help3.html")
Help files need not be loaded during construction, and can be added using the
addFile method. They may also be loaded by activating a
hyperlink, if the requested file has not already been loaded.
The first file named in the fileNames argument will be the default file displayed
in the browser panel, unless specified otherwise.
- Parameters:
- instance - the parent instance, should either be an applet or application
- fileName - a String of one or several help source files, separated by '|'
- See Also:
- addFile
addFile
public void addFile(Object instance,
String fileName)
- The addFile method permits loading additional help source files subsequent
to construction. However, unlike the constructor, only a single file can be
specified. This method requires the instance of the parent container
as the first argument. This is used by jHelp to determine if the method is
being invoked within an applet or application.
The fileName argument is a String comprised of a single help source file.
- Parameters:
- instance - the parent instance, should either be an applet or application
- fileName - a String consisting of the name of one help source file.
show
public void show(String context)
- This overridden show method permits the named help file to be displayed,
optionally at a specific NAME'd location within
the file. The context argument takes the same form as an HREF, such as
help1.html#Usage, or simply #Usage. The latter form will attempt to find
the bookmark in the currently active help file.
If a context requests a file that has not been loaded, either in the constructor,
or with the addFile method, then jHelp will attempt to load the requested help
file.
- Parameters:
- context - the hyperlink to a file and/or bookmark
show
public void show()
- This overridden show method simply displays the current help file, at the current
document position.
- Overrides:
- show in class Window
handleEvent
public boolean handleEvent(Event e)
- Overrides:
- handleEvent in class Component
All Packages Class Hierarchy This Package Previous Next Index