All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class JObserve.GUI.HelpBox 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----JObserve.GUI.ObserveBox
                                           |
                                           +----JObserve.GUI.HelpBox
public class HelpBox
extends ObserveBox
Online help display for JObserve Uses modless dialog. This widget parses a text file looking for help information. A line starting with $topic$ contains a topic A line starting with $subtopic$ contains a subtopic Any other lines are help text for the previous subtopic or topic if the topic has no subtopics.

Variable Index

o iceBrowser
The html browser
o isActive
Flag indicating if display is active
o myBox
The one true HelpBox
o subtopicList
AWT List to show subtopics
o topicList
AWT List to show main topics

Constructor Index

o HelpBox(Frame, String, String, String, String)
Make Help Box.

Method Index

o clearSelect()
Clear navigation selections
o loadHelpFile(String)
Load HelpFile.
o main(String[])
main program for testing
o makeHelpBox(Frame, String, String, String, String)
Make Help Box, if it exists simple change display.
o showHelp(String, String)
Select Help information displayed If topic is different from current get new sub topics from file and ignore subtopic displaying the first found in the new topic.

Variables

o isActive 
 public static boolean isActive
Flag indicating if display is active

o myBox 
 public static HelpBox myBox
The one true HelpBox

o topicList 
 public List topicList
AWT List to show main topics

o subtopicList 
 public List subtopicList
AWT List to show subtopics

o iceBrowser 
 public Browser iceBrowser
The html browser

Constructors

o HelpBox 
 public HelpBox(Frame parent,
                String file,
                String html,
                String topic,
                String subtopic)
Make Help Box.

Parameters:
Frame - Frame on which to hang the dialog
String - file name for help file, null means none
String - html base directory
String - topic to display, null means none
String - subtopic to display, null means none

Methods

o makeHelpBox 
 public static HelpBox makeHelpBox(Frame parent,
                                   String file,
                                   String html,
                                   String topic,
                                   String subtopic)
Make Help Box, if it exists simple change display.

Parameters:
Frame - Frame on which to hang the dialog
String - file name for help file, null means none
String - html base directory
String - topic to display, null means none
String - subtopic to display, null means none
o clearSelect 
 public void clearSelect()
Clear navigation selections

o showHelp 
 public void showHelp(String topic,
                      String subtopic)
Select Help information displayed If topic is different from current get new sub topics from file and ignore subtopic displaying the first found in the new topic. If the topic if the same display the new subtopic.

Parameters:
String - Topic, null if no topic.
String - Subtopic, null if no subtopic
o loadHelpFile 
 public void loadHelpFile(String file)
Load HelpFile. Extracts topics from the help file Topic lines start with a $topic$ Selects first topic and subtopic.

Parameters:
String - name of file to display
o main 
 public static void main(String args[])
main program for testing 

All Packages  Class Hierarchy  This Package  Previous  Next  Index