org.crosswire.bibledesktop.passage
Class BibleTreeNode

java.lang.Object
  extended by org.crosswire.bibledesktop.passage.BibleTreeNode
All Implemented Interfaces:
TreeNode
Direct Known Subclasses:
BookTreeNode

public class BibleTreeNode
extends Object
implements TreeNode

BibleTreeNode.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:
$Id: BibleTreeNode.java,v 1.6 2005/03/19 18:45:12 dmsmith Exp $
Author:
Joe Walker [joe at eireneh dot com]
See Also:
Licence

Nested Class Summary
 class BibleTreeNode.NodeEnumeration
          The Enumerate over an array
 
Field Summary
protected  TreeNode[] kids
          The ChapterTreeNodes that we have created
protected  Passage ref
          If we are only displaying some of the verses
 
Constructor Summary
BibleTreeNode()
           
 
Method Summary
 Enumeration children()
          Returns the children of the reciever as an Enumeration.
 boolean getAllowsChildren()
          Returns true if the receiver allows children.
 TreeNode getChildAt(int i)
          Returns the child TreeNode at index i
 int getChildCount()
          Returns the number of children TreeNodes the receiver contains.
 int getIndex(TreeNode node)
          Returns the index of node in the receivers children.
 TreeNode getParent()
          Returns the parent TreeNode of the receiver.
 boolean isLeaf()
          Returns true if the receiver is a leaf.
 void setPassage(Passage ref, boolean filter)
           
 String toString()
          Returns the children of the reciever as an Enumeration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ref

protected Passage ref
If we are only displaying some of the verses


kids

protected TreeNode[] kids
The ChapterTreeNodes that we have created

Constructor Detail

BibleTreeNode

public BibleTreeNode()
Method Detail

setPassage

public void setPassage(Passage ref,
                       boolean filter)

getChildAt

public TreeNode getChildAt(int i)
Returns the child TreeNode at index i

Specified by:
getChildAt in interface TreeNode

getChildCount

public int getChildCount()
Returns the number of children TreeNodes the receiver contains.

Specified by:
getChildCount in interface TreeNode

getParent

public TreeNode getParent()
Returns the parent TreeNode of the receiver.

Specified by:
getParent in interface TreeNode

getIndex

public int getIndex(TreeNode node)
Returns the index of node in the receivers children. If the receiver does not contain node, -1 will be returned.

Specified by:
getIndex in interface TreeNode

getAllowsChildren

public boolean getAllowsChildren()
Returns true if the receiver allows children.

Specified by:
getAllowsChildren in interface TreeNode

isLeaf

public boolean isLeaf()
Returns true if the receiver is a leaf.

Specified by:
isLeaf in interface TreeNode

children

public Enumeration children()
Returns the children of the reciever as an Enumeration.

Specified by:
children in interface TreeNode

toString

public String toString()
Returns the children of the reciever as an Enumeration.

Overrides:
toString in class Object

Copyright ? 2003-2004