com.tensegrity.palowebviewer.modules.widgets.client.tree
Class ProxyTreeModel

java.lang.Object
  extended by com.tensegrity.palowebviewer.modules.widgets.client.tree.AbstractTreeModel
      extended by com.tensegrity.palowebviewer.modules.widgets.client.tree.ProxyTreeModel
All Implemented Interfaces:
IDisposable, ITreeModel
Direct Known Subclasses:
FilterTreeModel, SubTreeModel

public abstract class ProxyTreeModel
extends AbstractTreeModel
implements IDisposable

Base class for ITreeModel proxy. It just redirects all calls to base model.


Constructor Summary
ProxyTreeModel(ITreeModel model)
           
 
Method Summary
 void dispose()
           
 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.
 ITreeModel getTreeModel()
           
 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
protected  void subModelNodesChanged(TreeModelEvent e)
           
protected  void subModelNodesInserted(TreeModelEvent e)
           
protected  void subModelNodesRemoved(TreeModelEvent e)
           
protected  void subModelStructureChanged(TreeModelEvent e)
           
 void valueForPathChanged(TreePath path, java.lang.Object newValue)
          Messaged when the user has altered the value for the item identified by path to newValue.
 
Methods inherited from class com.tensegrity.palowebviewer.modules.widgets.client.tree.AbstractTreeModel
addTreeModelListener, fireTreeNodesChanged, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeNodesRemoved, fireTreeStructureChanged, fireTreeStructureChanged, fireTreeStructureChanged, getChildNodes, isEventLocked, lockEvents, removeTreeModelListener, unlockEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProxyTreeModel

public ProxyTreeModel(ITreeModel model)
Method Detail

getChild

public java.lang.Object getChild(java.lang.Object parent,
                                 int index)
Description copied from interface: ITreeModel
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)).

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

getChildCount

public int getChildCount(java.lang.Object parent)
Description copied from interface: ITreeModel
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.

Specified by:
getChildCount in interface ITreeModel
Parameters:
parent - a node in the tree, obtained from this data source
Returns:
the number of children of the node parent

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)
Description copied from interface: ITreeModel
Returns the index of child in parent. If parent is null or child is null, returns -1.

Specified by:
getIndexOfChild in interface ITreeModel
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

public java.lang.Object getRoot()
Description copied from interface: ITreeModel
Returns the root of the tree. Returns null only if the tree has no nodes.

Specified by:
getRoot in interface ITreeModel
Returns:
the root of the tree

isLoaded

public boolean isLoaded(java.lang.Object object)
Specified by:
isLoaded in interface ITreeModel
Overrides:
isLoaded in class AbstractTreeModel
Returns:
true if the object is part of the tree and it's children are loaded.

load

public void load(java.lang.Object object)
Description copied from interface: ITreeModel
Requires to load children of object

Specified by:
load in interface ITreeModel
Overrides:
load in class AbstractTreeModel
Parameters:
object - - object to load children.

isLeaf

public boolean isLeaf(java.lang.Object node)
Description copied from interface: ITreeModel
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.

Specified by:
isLeaf in interface ITreeModel
Parameters:
node - a node in the tree, obtained from this data source
Returns:
true if node is a leaf

valueForPathChanged

public void valueForPathChanged(TreePath path,
                                java.lang.Object newValue)
Description copied from interface: ITreeModel
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.

Specified by:
valueForPathChanged in interface ITreeModel
Parameters:
path - path to the node that the user has altered
newValue - the new value

getTreeModel

public ITreeModel getTreeModel()

subModelNodesChanged

protected void subModelNodesChanged(TreeModelEvent e)

subModelNodesInserted

protected void subModelNodesInserted(TreeModelEvent e)

subModelNodesRemoved

protected void subModelNodesRemoved(TreeModelEvent e)

subModelStructureChanged

protected void subModelStructureChanged(TreeModelEvent e)

dispose

public void dispose()
Specified by:
dispose in interface IDisposable