net.sourceforge.olduvai.treejuxtaposer
Class Help

java.lang.Object
  extended by net.sourceforge.olduvai.treejuxtaposer.Help

public class Help
extends java.lang.Object

Display help and other information about TJ. We use the release README file for dialog.

Author:
jslack

Field Summary
static javax.swing.JFrame aboutFrame
          Class state needed by the internal declaration of ActionListener for the help window: The JFrame.
private static java.lang.String filename
          Class state needed by the internal declaration of ActionListener for the help window: The filename for the readme file in this directory.
 
Constructor Summary
Help()
           
 
Method Summary
protected static java.lang.String getReadme()
          Load a resource (readme file) and return its contents as a string
protected static java.io.BufferedReader getResourceAsReader(java.lang.String resource)
          Helper function used by getReadme(), to load the text file resource.
static void showAboutFrame()
          Show the help file in a frame.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

aboutFrame

public static javax.swing.JFrame aboutFrame
Class state needed by the internal declaration of ActionListener for the help window: The JFrame.


filename

private static java.lang.String filename
Class state needed by the internal declaration of ActionListener for the help window: The filename for the readme file in this directory.

Constructor Detail

Help

public Help()
Method Detail

getResourceAsReader

protected static final java.io.BufferedReader getResourceAsReader(java.lang.String resource)
Helper function used by getReadme(), to load the text file resource.

Parameters:
resource - The name of the readme file.
Returns:
A reader object that the calling function will use to parse out the text for the help display.

getReadme

protected static java.lang.String getReadme()
Load a resource (readme file) and return its contents as a string

Returns:
Resource contents on success as a string; null on failure

showAboutFrame

public static void showAboutFrame()
Show the help file in a frame. Event handlers for closing the window defined inside here.