org.mozdev.firebirdhelp.HelpViewer
Interface iHelpTopic

All Known Implementing Classes:
HelpTree

public interface iHelpTopic


Method Summary
 void addSubTopic(iHelpTopic aSubTopic)
          Add a subtopic of this help topic.
 javax.swing.tree.DefaultMutableTreeNode getTreeNode()
          Returns a TreeNode of this topic so you can insert it in a JTree.
 java.lang.String name()
          Returns the name of the topic.
 void removeSubTopics()
          Removes all subtopics of this topic.
 java.util.Iterator topicIterator()
          Returns an iterator that will let you iterate through all of the sub-topics.
 java.lang.String url()
          Returns the URL that should be loaded in the Help Viewer when this topic is clicked on or enabled.
 

Method Detail

addSubTopic

void addSubTopic(iHelpTopic aSubTopic)
Add a subtopic of this help topic.

Parameters:
aSubTopic - The iHelpTopic to make the child of this node.

removeSubTopics

void removeSubTopics()
Removes all subtopics of this topic.


topicIterator

java.util.Iterator topicIterator()
Returns an iterator that will let you iterate through all of the sub-topics.


getTreeNode

javax.swing.tree.DefaultMutableTreeNode getTreeNode()
Returns a TreeNode of this topic so you can insert it in a JTree.


name

java.lang.String name()
Returns the name of the topic.


url

java.lang.String url()
Returns the URL that should be loaded in the Help Viewer when this topic is clicked on or enabled.



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