|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mozdev.firebirdhelp.HelpViewer.HelpTree
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 |
---|
public HelpTree(java.lang.String aTopicName, java.lang.String aURL)
aTopicName
- The name of this topic to display in the tree.aURL
- The url to load when this help topic is enabled.Method Detail |
---|
public void addSubTopic(iHelpTopic aSubTopic)
For example, JTree's will look like this:
-- thisTopic
-- subtopic taken in.
addSubTopic
in interface iHelpTopic
aSubTopic
- The subtopic of this help topic.public java.util.Iterator topicIterator()
topicIterator
in interface iHelpTopic
public javax.swing.tree.DefaultMutableTreeNode getTreeNode()
getTreeNode
in interface iHelpTopic
public java.lang.String url()
url
in interface iHelpTopic
public java.lang.String name()
name
in interface iHelpTopic
public void removeSubTopics()
removeSubTopics
in interface iHelpTopic
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |