org.fife.help
Class HelpTreeNode

java.lang.Object
  org.fife.help.HelpTreeNode

public class HelpTreeNode

extends java.lang.Object

Helper class to HelpDialog; your DefaultMutableTreeNodes need to contain instances of this class when creating a HelpDialog.

Version:

1.0

Author:

Robert Futrell

Field Summary

java.lang.String	title The text of the node.
java.net.URL	url The help page that will be loaded when the user clicks on this node in the Contents tree.

Constructor Summary

HelpTreeNode(java.lang.String title)
Creates a HelpTreeNode with no URL.

HelpTreeNode(java.lang.String title, java.lang.String urlString)
Creates a HelpTreeNode.

HelpTreeNode(java.lang.String title, java.net.URL url)
Creates a HelpTreeNode.

Method Summary

java.lang.String

toString() Returns the title of this node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

url

public java.net.URL url

The help page that will be loaded when the user clicks on this node in the Contents tree.

title

public java.lang.String title

The text of the node.

Constructor Detail

HelpTreeNode

public HelpTreeNode(java.lang.String title)

Creates a HelpTreeNode with no URL. This constructor should be used for nodes that you do not wish to associate a help page with, such as expandable ("folder") nodes.

Parameters:

title - The text displayed beside this Contents tree node.

HelpTreeNode

public HelpTreeNode(java.lang.String title,
                    java.net.URL url)

Creates a HelpTreeNode.

Parameters:

title - The text displayed beside this Contents tree node.

url - The help page that will be loaded when the user clicks on this node.

HelpTreeNode

public HelpTreeNode(java.lang.String title,
                    java.lang.String urlString)

Creates a HelpTreeNode.

Parameters:

title - The text displayed beside this Contents tree node.

urlString - The URL path to the help page that will be loaded when the user clicks on this node.

Method Detail

toString

public java.lang.String toString()

Returns the title of this node.