com.screenscraper.model

Class MainTreeModel

java.lang.Object

com.screenscraper.model.MainTreeModel

All Implemented Interfaces:

javax.swing.tree.TreeModel

public class MainTreeModel
extends java.lang.Object
implements javax.swing.tree.TreeModel

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
MainTreeModel() Constructs the model.

Method Summary

Modifier and Type	Method and Description
void	addTopLevelItem(java.lang.Object item) Adds a top-level item.
void	addTreeModelListener(javax.swing.event.TreeModelListener l) Adds a listener for the TreeModelEvent posted after the tree changes.
void	fireTreeNodeChanged(java.lang.Object object, javax.swing.tree.TreePath treePath) The only event raised by this model is TreeStructureChanged with the root as path, i.e.
void	fireTreeStructureChanged(javax.swing.tree.TreePath treePath) Indicates that the overall structure of the tree has changed.
java.lang.Object	getChild(java.lang.Object parent, int index) Returns the child of parent at 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.
int	getNumTopLevelItems() Gets the number of top-level items.
java.lang.Object	getRoot() Returns the root of the tree.
int	getSequenceOfTopLevelItem(java.lang.Object object) Gets the sequence of the object amongst the top-level items.
java.util.Iterator	getTopLevelItemsIterator() Returns an Iterator over which the top-level items can be cycled.
boolean	isLeaf(java.lang.Object node) Returns true if node is a leaf.
void	reload() Re-loads all top-level items.
void	removeTreeModelListener(javax.swing.event.TreeModelListener l) Removes a listener previously added with addTreeModelListener().
void	valueForPathChanged(javax.swing.tree.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

MainTreeModel

public MainTreeModel()

Constructs the model.

Method Detail

getNumTopLevelItems

public int getNumTopLevelItems()

Gets the number of top-level items.

getTopLevelItemsIterator

public java.util.Iterator getTopLevelItemsIterator()

Returns an Iterator over which the top-level items can be cycled.

Returns:

An Iterator.

getSequenceOfTopLevelItem

public int getSequenceOfTopLevelItem(java.lang.Object object)

Gets the sequence of the object amongst the top-level items.

Parameters:

object - The object to seek.

Returns:

The sequence, if the object is found. Returns -1, otherwise.

addTopLevelItem

public void addTopLevelItem(java.lang.Object item)

Adds a top-level item.

Parameters:

item - The item to add.

reload

public void reload()

Re-loads all top-level items.

getRoot

public java.lang.Object getRoot()

Returns the root of the tree.

Specified by:

getRoot in interface javax.swing.tree.TreeModel

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)

Returns the index of child in parent.

Specified by:

getIndexOfChild in interface javax.swing.tree.TreeModel

getChild

public java.lang.Object getChild(java.lang.Object parent,
                                 int index)

Returns the child of parent at index in the parent's child array.

Specified by:

getChild in interface javax.swing.tree.TreeModel

getChildCount

public int getChildCount(java.lang.Object parent)

Returns the number of children of parent.

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

isLeaf

public boolean isLeaf(java.lang.Object node)

Returns true if node is a leaf.

Specified by:

isLeaf in interface javax.swing.tree.TreeModel

removeTreeModelListener

public void removeTreeModelListener(javax.swing.event.TreeModelListener l)

Removes a listener previously added with addTreeModelListener().

Specified by:

removeTreeModelListener in interface javax.swing.tree.TreeModel

addTreeModelListener

public void addTreeModelListener(javax.swing.event.TreeModelListener l)

Adds a listener for the TreeModelEvent posted after the tree changes.

Specified by:

addTreeModelListener in interface javax.swing.tree.TreeModel

fireTreeNodeChanged

public void fireTreeNodeChanged(java.lang.Object object,
                                javax.swing.tree.TreePath treePath)

The only event raised by this model is TreeStructureChanged with the root as path, i.e. the whole tree has changed.

Parameters:

object - The object that changed.

treePath - The TreePath corresponding to the object that changed.

fireTreeStructureChanged

public void fireTreeStructureChanged(javax.swing.tree.TreePath treePath)

Indicates that the overall structure of the tree has changed.

valueForPathChanged

public void valueForPathChanged(javax.swing.tree.TreePath path,
                                java.lang.Object newValue)

Messaged when the user has altered the value for the item identified by path to newValue. Not used by this model.

Specified by:

valueForPathChanged in interface javax.swing.tree.TreeModel