story.scheherazade.virgil.help
Class HelpDisplay

java.lang.Object
  extended by story.scheherazade.virgil.help.HelpDisplay

public class HelpDisplay
extends java.lang.Object

A class dedicated to making a JTree inside a JPanel and returning a JPanel for outputting the HelpTopic information in a convenient Swing layout

Author:
Marshall

Field Summary
static java.awt.Color CONTENT_BG_COLOR
           
static java.awt.Color CONTENT_FG_COLOR
           
static java.awt.Color INDEX_BG_COLOR
           
static java.awt.Color INDEX_FG_COLOR
           
 
Constructor Summary
HelpDisplay(java.util.Vector<HelpTopic> topLevelHelpTopics)
           
 
Method Summary
 javax.swing.JPanel getHelpContent()
          Returns the JPanel containing the HelpTopic information
 javax.swing.JPanel getHelpIndex()
          Returns the JPanel containing the HelpTopic information
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INDEX_BG_COLOR

public static final java.awt.Color INDEX_BG_COLOR

INDEX_FG_COLOR

public static final java.awt.Color INDEX_FG_COLOR

CONTENT_BG_COLOR

public static final java.awt.Color CONTENT_BG_COLOR

CONTENT_FG_COLOR

public static final java.awt.Color CONTENT_FG_COLOR
Constructor Detail

HelpDisplay

public HelpDisplay(java.util.Vector<HelpTopic> topLevelHelpTopics)
            throws Scheherexception
Parameters:
topLevelHelpTopics - a vector of the top level help topics
Throws:
Scheherexception
Method Detail

getHelpContent

public javax.swing.JPanel getHelpContent()
Returns the JPanel containing the HelpTopic information

Returns:
the JPanel containing the HelpTopic information

getHelpIndex

public javax.swing.JPanel getHelpIndex()
Returns the JPanel containing the HelpTopic information

Returns:
the JPanel containing the HelpTopic information


Copyright © 2011 David K. Elson. All Rights Reserved.