wjhk.jupload2.gui.filepanel.treeview

Class MyAbstractTreeTableModel<T extends MyTreeNode>

java.lang.Object

wjhk.jupload2.gui.filepanel.treeview.MyAbstractTreeTableModel<T>

All Implemented Interfaces:

TreeModel, MyTreeTableModel<T>

Direct Known Subclasses:

FileDataTreeViewModel

public abstract class MyAbstractTreeTableModel<T extends MyTreeNode>
extends Object
implements MyTreeTableModel<T>

This code is taken from the tutorial written by Jörn Hameister, available here.

From Jörn sample, the main modifications are:

• Use of the uploadPolicy
• Add of the getRoot and setRoot methods
• Capability to remove an item
• Transformation in a generic type

In the next step, the interface is MyTreeTableModel to the abstract class MyAbstractTreeTableModel expanded. In this class, the Wuzelknoten (root) is stored, there is a method for checking whether child nodes are available and manages all event listener verwerden. The EventListener ensure that structural changes in the data model will be forwarded to the tree and displayed.
Note: We can not use the DefaultTreeModel for various model. One is that we need multiple columns. Another one is that we must delegate the content to the FilePanel, as the view may be flat or treeview. So we stay with the implementation which existed before the tree view, there would otherwise be too much changes in the applet code.

Author:

Jörn Hameister

Field Summary

Fields

Modifier and Type	Field and Description
protected T	absoluteRoot The absolute root of the hierarchical structure.
protected EventListenerList	listenerList
protected T	visibleRoot

Constructor Summary

Constructors

Constructor and Description
MyAbstractTreeTableModel(UploadPolicy uploadPolicy, T root)

Method Summary

Modifier and Type	Method and Description
void	addTreeModelListener(TreeModelListener l)
boolean	cleanHierarchy() This method removes all empty folders.
boolean	cleanHierarchy(T node) Cleans the hierarchy behind a given node.
void	fireTreeNodesChanged(Object source, TreePath path, int[] childIndices, T[] children) This method must be called when one or more nodes are changed.
void	fireTreeNodesInserted(Object source, TreePath path, int[] childIndices, T[] children) This method must be called when one or more nodes are changed.
void	fireTreeNodesRemoved(Object source, TreePath path, int[] childIndices, T[] children) This method must be called when one or more nodes are changed.
void	fireTreeStructureChanged(Object source, TreePath path, int[] childIndices, T[] children) This method must be called when one or more nodes are changed.
T	getAbsoluteRoot()
T	getChild(Object parent, int index)
int	getChildCount(Object child)
int	getIndexOfChild(Object parent, Object child) This is normally not called
T	getRoot() Get the visible root of the JTree view.
MyTreeTableCellRenderer	getTree()
TreePath	getTreePath(T item) This method build a TreePath for the given item.
abstract Object	getValueAt(T nodeForRow, int column) Returns the value of a node in a column.
boolean	isLeaf(Object node)
void	reload() Invoke this method if you've modified the TreeNodes upon which this model depends.
void	reload(T node) Invoke this method if you've modified the TreeNodes upon which this model depends.
void	remove(T item) Removes an item from the TreeView.
void	removeAndClean(T item) Removes an item from the TreeView, detach its descendant, and remove the parent node if this node was the only child of the parent.
void	removeTreeModelListener(TreeModelListener l)
void	setRoot(T root) Set the visible root of the JTree view.
void	setTree(MyTreeTableCellRenderer tree)
void	valueForPathChanged(TreePath path, Object newValue) This is normally not called

Methods inherited from class java.lang.Object

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

Methods inherited from interface wjhk.jupload2.gui.filepanel.treeview.MyTreeTableModel

attachObject, getColumnClass, getColumnCount, getColumnName, getColumnSizePercentage, getTreePathForObject, isCellEditable, setValueAt

Field Detail

absoluteRoot

protected T extends MyTreeNode absoluteRoot

The absolute root of the hierarchical structure. It can't be delegated to the tree table, as the displayed root can change, when adding other files to upload.
Note: on Windows, there can be several roots. So the JUpload's absolute root is a non existing folder, which contain one folder under Unix ('/') and may contain several folders under Windows ('C:\', 'D:\'...).

visibleRoot

protected T extends MyTreeNode visibleRoot

listenerList

protected EventListenerList listenerList

Constructor Detail

MyAbstractTreeTableModel

public MyAbstractTreeTableModel(UploadPolicy uploadPolicy,
                                T root)

Method Detail

getTree

public MyTreeTableCellRenderer getTree()

Returns:

the tree

setTree

public void setTree(MyTreeTableCellRenderer tree)

Specified by:

setTree in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

tree - the tree to set

getAbsoluteRoot

public T getAbsoluteRoot()

getRoot

public T getRoot()

Description copied from interface: MyTreeTableModel

Get the visible root of the JTree view.

Specified by:

getRoot in interface TreeModel

Specified by:

getRoot in interface MyTreeTableModel<T extends MyTreeNode>

See Also:

MyTreeTableModel.getRoot()

setRoot

public void setRoot(T root)

Description copied from interface: MyTreeTableModel

Set the visible root of the JTree view.

Specified by:

setRoot in interface MyTreeTableModel<T extends MyTreeNode>

Throws:

IllegalArgumentException - If this root is not valid.

See Also:

MyTreeTableModel.setRoot(MyTreeNode)

remove

public void remove(T item)

Description copied from interface: MyTreeTableModel

Removes an item from the TreeView. This method just removed the given node. Of course, it detaches all descendants of this node, if any.
There is no impact on the parent, out of the 'detaching' of this node.

Specified by:

remove in interface MyTreeTableModel<T extends MyTreeNode>

See Also:

MyTreeTableModel.remove(MyTreeNode)

removeAndClean

public void removeAndClean(T item)

Description copied from interface: MyTreeTableModel

Removes an item from the TreeView, detach its descendant, and remove the parent node if this node was the only child of the parent. If this item has children, then all children are also removed.

Specified by:

removeAndClean in interface MyTreeTableModel<T extends MyTreeNode>

See Also:

MyTreeTableModel.remove(MyTreeNode)

getTreePath

public TreePath getTreePath(T item)

Description copied from interface: MyTreeTableModel

This method build a TreePath for the given item. This item should be in the current tree.

Specified by:

getTreePath in interface MyTreeTableModel<T extends MyTreeNode>

Returns:

The build TreePath

See Also:

MyTreeTableModel.getTreePath(MyTreeNode)

addTreeModelListener

public void addTreeModelListener(TreeModelListener l)

Specified by:

addTreeModelListener in interface TreeModel

removeTreeModelListener

public void removeTreeModelListener(TreeModelListener l)

Specified by:

removeTreeModelListener in interface TreeModel

cleanHierarchy

public boolean cleanHierarchy()

Description copied from interface: MyTreeTableModel

This method removes all empty folders. Empty folder can typically be created, when adding files. For instance, if there is subfolder1/subolfer2, and subfolder2 is empty. Then it is not created. But avoiding to create also subfolder1 needs to parse the whole hierarchy for each folder. Too long. It's quicker to clean afterwards.

Specified by:

cleanHierarchy in interface MyTreeTableModel<T extends MyTreeNode>

Returns:

true if at least one node is removed. The MyTreeTableModel.reload() method is called.

See Also:

MyTreeTableModel.cleanHierarchy()

cleanHierarchy

public boolean cleanHierarchy(T node)

Cleans the hierarchy behind a given node. It's actually the recursive implementation for MyTreeTableModel.cleanHierarchy()

Returns:

true if at least one node was removed, due to cleaning. false if no cleaning was needed.

reload

public void reload()

Description copied from interface: MyTreeTableModel

Invoke this method if you've modified the TreeNodes upon which this model depends. The model will notify all of its listeners that the model has changed. It will fire the events, necessary to update the layout caches and repaint the tree. The tree will not be properly refreshed if you call the JTree.repaint instead.

This method will refresh the information about whole tree from the root. If only part of the tree should be refreshed, it is more effective to call #reload(TreeNode).

Note: code taken from the JDK DefaultTreeModel.

Specified by:

reload in interface MyTreeTableModel<T extends MyTreeNode>

See Also:

MyTreeTableModel.reload()

reload

public void reload(T node)

Description copied from interface: MyTreeTableModel

Invoke this method if you've modified the TreeNodes upon which this model depends. The model will notify all of its listeners that the model has changed. It will fire the events, necessary to update the layout caches and repaint the tree. The tree will not be properly refreshed if you call the JTree.repaint instead.

Specified by:

reload in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

node - - the tree node, from which the tree nodes have changed (inclusive). If you do not know this node, call MyTreeTableModel.reload() instead.

See Also:

MyTreeTableModel.reload(MyTreeNode)

fireTreeNodesChanged

public void fireTreeNodesChanged(Object source,
                                 TreePath path,
                                 int[] childIndices,
                                 T[] children)

Description copied from interface: MyTreeTableModel

This method must be called when one or more nodes are changed.

Specified by:

fireTreeNodesChanged in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

source - - the Object responsible for generating the event (typically the creator of the event object passes this for its value)

path - - a TreePath object that identifies the path to the parent of the modified item(s)

childIndices - - an array of int that specifies the index values of the modified items

children - - an array of Object containing the inserted, removed, or changed objects

See Also:

MyTreeTableModel#fireTreeNodesChanged(MyTreeNode, MyTreeNode[], int[], MyTreeNode[])

fireTreeNodesInserted

public void fireTreeNodesInserted(Object source,
                                  TreePath path,
                                  int[] childIndices,
                                  T[] children)

Description copied from interface: MyTreeTableModel

This method must be called when one or more nodes are changed.

Specified by:

fireTreeNodesInserted in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

source - - the Object responsible for generating the event (typically the creator of the event object passes this for its value)

path - - a TreePath object that identifies the path to the parent of the modified item(s)

childIndices - - an array of int that specifies the index values of the modified items

children - - an array of Object containing the inserted, removed, or changed objects

See Also:

MyTreeTableModel#fireTreeNodesInserted(MyTreeNode, MyTreeNode[], int[], MyTreeNode[])

fireTreeNodesRemoved

public void fireTreeNodesRemoved(Object source,
                                 TreePath path,
                                 int[] childIndices,
                                 T[] children)

Description copied from interface: MyTreeTableModel

This method must be called when one or more nodes are changed.

Specified by:

fireTreeNodesRemoved in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

source - - the Object responsible for generating the event (typically the creator of the event object passes this for its value)

path - - a TreePath object that identifies the path to the parent of the modified item(s)

childIndices - - an array of int that specifies the index values of the modified items

children - - an array of Object containing the inserted, removed, or changed objects

See Also:

MyTreeTableModel#fireTreeNodesRemoved(MyTreeNode, MyTreeNode[], int[], MyTreeNode[])

fireTreeStructureChanged

public void fireTreeStructureChanged(Object source,
                                     TreePath path,
                                     int[] childIndices,
                                     T[] children)

Description copied from interface: MyTreeTableModel

This method must be called when one or more nodes are changed.

Specified by:

fireTreeStructureChanged in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

source - - the Object responsible for generating the event (typically the creator of the event object passes this for its value)

path - - a TreePath object that identifies the path to the parent of the modified item(s)

childIndices - - an array of int that specifies the index values of the modified items

children - - an array of Object containing the inserted, removed, or changed objects

See Also:

MyTreeTableModel#fireTreeStructureChanged(MyTreeNode, MyTreeNode[], int[], MyTreeNode[])

getChild

public final T getChild(Object parent,
                        int index)

Specified by:

getChild in interface TreeModel

See Also:

TreeModel.getChild(Object, int)

getChildCount

public final int getChildCount(Object child)

Specified by:

getChildCount in interface TreeModel

See Also:

TreeModel.getChildCount(Object)

isLeaf

public final boolean isLeaf(Object node)

Specified by:

isLeaf in interface TreeModel

See Also:

TreeModel.isLeaf(Object)

valueForPathChanged

public final void valueForPathChanged(TreePath path,
                                      Object newValue)

This is normally not called

Specified by:

valueForPathChanged in interface TreeModel

See Also:

TreeModel.valueForPathChanged(TreePath, Object)

getIndexOfChild

public final int getIndexOfChild(Object parent,
                                 Object child)

This is normally not called

Specified by:

getIndexOfChild in interface TreeModel

See Also:

TreeModel.getIndexOfChild(Object, Object)

getValueAt

public abstract Object getValueAt(T nodeForRow,
                                  int column)

Description copied from interface: MyTreeTableModel

Returns the value of a node in a column.

Specified by:

getValueAt in interface MyTreeTableModel<T extends MyTreeNode>

Parameters:

nodeForRow - Node

column - Column number

Returns:

Value of the node in the column