com.tensegrity.palowebviewer.modules.widgets.client.tree
Interface ITreeModel

All Known Implementing Classes:
AbstractTreeModel, CubeHeaderModel, DatabaseBrowserTreeModel, FavoriteViewsModel, FilterTreeModel, LabeledNodeTreeModel, NodeTreeModel, PaloTreeModel, ProxyTreeModel, SubTreeModel, XElementPathTree

public interface ITreeModel

Model of a tree. It is dynamicly loadable.


Method Summary
 void addTreeModelListener(ITreeModelListener listener)
          Adds a listener for the TreeModelEvent posted after the tree changes.
 java.lang.Object getChild(java.lang.Object parent, int index)
          Returns the child of parent at index index in the parent's child array.
 int getChildCount(java.lang.Object parent)
          Returns the number of children of parent.
 int getIndexOfChild(java.lang.Object parent, java.lang.Object child)
          Returns the index of child in parent.
 java.lang.Object getRoot()
          Returns the root of the tree.
 boolean isLeaf(java.lang.Object node)
          Returns true if node is a leaf.
 boolean isLoaded(java.lang.Object object)
           
 void load(java.lang.Object object)
          Requires to load children of object
 void removeTreeModelListener(ITreeModelListener listener)
          Removes a listener previously added with addTreeModelListener.
 void valueForPathChanged(TreePath path, java.lang.Object newValue)
          Messaged when the user has altered the value for the item identified by path to newValue.
 

Method Detail

addTreeModelListener

void addTreeModelListener(ITreeModelListener listener)
Adds a listener for the TreeModelEvent posted after the tree changes.

Parameters:
l - the listener to add
See Also:
removeTreeModelListener(com.tensegrity.palowebviewer.modules.widgets.client.tree.ITreeModelListener)

getChild

java.lang.Object getChild(java.lang.Object parent,
                          int index)
Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).

Parameters:
parent - a node in the tree, obtained from this data source
Returns:
the child of parent at index index

getChildCount

int getChildCount(java.lang.Object parent)
Returns the number of children of parent. Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.

Parameters:
parent - a node in the tree, obtained from this data source
Returns:
the number of children of the node parent

getIndexOfChild

int getIndexOfChild(java.lang.Object parent,
                    java.lang.Object child)
Returns the index of child in parent. If parent is null or child is null, returns -1.

Parameters:
parent - a note in the tree, obtained from this data source
child - the node we are interested in
Returns:
the index of the child in the parent, or -1 if either child or parent are null

getRoot

java.lang.Object getRoot()
Returns the root of the tree. Returns null only if the tree has no nodes.

Returns:
the root of the tree

isLoaded

boolean isLoaded(java.lang.Object object)
Parameters:
object -
Returns:
true if the object is part of the tree and it's children are loaded.

load

void load(java.lang.Object object)
Requires to load children of object

Parameters:
object - - object to load children.

isLeaf

boolean isLeaf(java.lang.Object node)
Returns true if node is a leaf. It is possible for this method to return false even if node has no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children.

Parameters:
node - a node in the tree, obtained from this data source
Returns:
true if node is a leaf

removeTreeModelListener

void removeTreeModelListener(ITreeModelListener listener)
Removes a listener previously added with addTreeModelListener.

Parameters:
listener - the listener to remove
See Also:
addTreeModelListener(com.tensegrity.palowebviewer.modules.widgets.client.tree.ITreeModelListener)

valueForPathChanged

void valueForPathChanged(TreePath path,
                         java.lang.Object newValue)
Messaged when the user has altered the value for the item identified by path to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.

Parameters:
path - path to the node that the user has altered
newValue - the new value