org.mozdev.firebirdhelp.HelpViewer
Class HelpTree

java.lang.Object
  extended by org.mozdev.firebirdhelp.HelpViewer.HelpTree
All Implemented Interfaces:
iHelpTopic

public class HelpTree
extends java.lang.Object
implements iHelpTopic


Constructor Summary
HelpTree(java.lang.String aTopicName, java.lang.String aURL)
          Creates a standard HelpTree object that is designed to create a tree of objects.
 
Method Summary
 void addSubTopic(iHelpTopic aSubTopic)
          Add a sub-topic to branch out of this help topic in a JTree.
 javax.swing.tree.DefaultMutableTreeNode getTreeNode()
          Returns a TreeNode of this object that can be added to a JTree to display this topic and its sub-topics in a tree visually.
 java.lang.String name()
          Returns the name of this help topic.
 void removeSubTopics()
          Removes all of the sub-topics of this topic.
 java.util.Iterator topicIterator()
          Returns an iterator that iterates through all of the help sub-topics.
 java.lang.String url()
          Returns the URL of this help topic.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpTree

public HelpTree(java.lang.String aTopicName,
                java.lang.String aURL)
Creates a standard HelpTree object that is designed to create a tree of objects.

Parameters:
aTopicName - The name of this topic to display in the tree.
aURL - The url to load when this help topic is enabled.
Method Detail

addSubTopic

public void addSubTopic(iHelpTopic aSubTopic)
Add a sub-topic to branch out of this help topic in a JTree.

For example, JTree's will look like this:

  -- thisTopic
     -- subtopic taken in.

Specified by:
addSubTopic in interface iHelpTopic
Parameters:
aSubTopic - The subtopic of this help topic.

topicIterator

public java.util.Iterator topicIterator()
Returns an iterator that iterates through all of the help sub-topics.

Specified by:
topicIterator in interface iHelpTopic

getTreeNode

public javax.swing.tree.DefaultMutableTreeNode getTreeNode()
Returns a TreeNode of this object that can be added to a JTree to display this topic and its sub-topics in a tree visually.

Specified by:
getTreeNode in interface iHelpTopic

url

public java.lang.String url()
Returns the URL of this help topic.

Specified by:
url in interface iHelpTopic

name

public java.lang.String name()
Returns the name of this help topic.

Specified by:
name in interface iHelpTopic

removeSubTopics

public void removeSubTopics()
Removes all of the sub-topics of this topic.

Specified by:
removeSubTopics in interface iHelpTopic


Copyright © 2003-2004 R.J. Keller. All Rights Reserved.