All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class edu.wpi.mqp.graphics.jviz.HelpTopics 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----com.sun.java.swing.JDialog
                                           |
                                           +----edu.wpi.mqp.graphics.jviz.HelpTopics
public class HelpTopics
extends JDialog
This class implements a VERY basic help system. It uses a lot of the documentation from XmdvTool. The output is not pretty, but it is functional The documentation is stored in files that must be in the correct spot. The class was admittedly not well designed in implemented quickly. Some extra time spent with this class could implement a solid help system in the next version.

Version:
1.0
Author:
Matthew C. Jucius

Variable Index

o doneButton
o helpText
o topicList
o topicPanel
o topics

Constructor Index

o HelpTopics(JFrame)
Constructor

Method Index

o changeTopic(String)
This method changes the text in the text area.

Variables

o topicPanel 
 protected JPanel topicPanel
o doneButton 
 protected JButton doneButton
o topicList 
 protected JComboBox topicList
o topics 
 protected String topics[]
o helpText 
 protected JTextArea helpText

Constructors

o HelpTopics 
 public HelpTopics(JFrame parentFrame)
Constructor

Parameters:
parentFrame - link to the parent frame so this dialog box can display

Methods

o changeTopic 
 public void changeTopic(String newTopic)
This method changes the text in the text area. It reads in a file associated with the newTopic String and displays the text. It uses a URL so we can package the files within a .jar file. Since we are using URL's, it is concievable that we could have online help.

Parameters:
newTopic - the topic to display the text for. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index