wjhk.jupload2.gui.filepanel.treeview

Interface MyTreeTableModel<T extends MyTreeNode>

All Superinterfaces:

TreeModel

All Known Implementing Classes:

FileDataTreeViewModel, MyAbstractTreeTableModel

public interface MyTreeTableModel<T extends MyTreeNode>
extends TreeModel

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

From Jörn sample, the main modifications are:

• Add of the getRoot and setRoot methods
• Capability to remove an item
• Transformation in a generic type
• Add of the reload method, to help refreshing the display.
• Add of the getColumnSizePercentage(int) method, to allow the resizing of the column, along with the table resizing (see FilePanelTableImp.componentResized(java.awt.event.ComponentEvent)
  
  First, the interface is TreeModel through the interface MyTreeTableModel expanded. This extension creates the possibility that a node (Node) multiple columns (Columns) can have.
  
  This class can not be generic, as TreeModel is not generic

Author:

Jörn Hameister

Method Summary

Modifier and Type	Method and Description
int	attachObject(Object o) Attach a new Object into the current hierarchy.
boolean	cleanHierarchy() This method removes all empty folders.
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.
Class<?>	getColumnClass(int column) Returns the type (class) of a column.
int	getColumnCount() Returns the number of available columns.
String	getColumnName(int column) Returns the column name.
int	getColumnSizePercentage(int col) Retrieves the default colum percentage size of a column, that is: its percentage of the available width.
T	getRoot() Get the visible root of the JTree view.
TreePath	getTreePath(T item) This method build a TreePath for the given item.
TreePath	getTreePathForObject(Object o) Get the TreePath for the given object.
Object	getValueAt(T node, int column) Returns the value of a node in a column.
boolean	isCellEditable(T node, int column) Check if a cell of a node in one column is editable.
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	setRoot(T root) Set the visible root of the JTree view.
void	setTree(MyTreeTableCellRenderer tree)
void	setValueAt(Object aValue, T node, int column) Sets a value for a node in one column.

Methods inherited from interface javax.swing.tree.TreeModel

addTreeModelListener, getChild, getChildCount, getIndexOfChild, isLeaf, removeTreeModelListener, valueForPathChanged

Method Detail

getRoot

T getRoot()

Get the visible root of the JTree view.

Specified by:

getRoot in interface TreeModel

Parameters:

root -

setRoot

void setRoot(T root)

Set the visible root of the JTree view.

Parameters:

root -

remove

void remove(T item)

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.

Parameters:

item -

See Also:

removeAndClean(MyTreeNode)

removeAndClean

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. If this item has children, then all children are also removed.

Parameters:

item -

cleanHierarchy

boolean cleanHierarchy()

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.

Returns:

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

reload

void reload()

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.

reload

void reload(T node)

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.

Parameters:

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

getColumnCount

int getColumnCount()

Returns the number of available columns.

Returns:

Number of Columns

getColumnName

String getColumnName(int column)

Returns the column name.

Parameters:

column - Column number

Returns:

Column name

getColumnSizePercentage

int getColumnSizePercentage(int col)

Retrieves the default colum percentage size of a column, that is: its percentage of the available width.

Parameters:

col - The index of the column to query.

Returns:

the default size of the requested column.

getColumnClass

Class<?> getColumnClass(int column)

Returns the type (class) of a column.

Parameters:

column - Column number

Returns:

Class

attachObject

int attachObject(Object o)
          throws IllegalStateException,
                 IllegalArgumentException,
                 JUploadExceptionStopAddingFiles

Attach a new Object into the current hierarchy. This method is not mandatory. If not implemented, it should raise an {@link IllegalStateException].

Parameters:

o -

Returns:

The total number of object added. It may be more than one, for instance, when adding a folder (including its descendants) in a file hierarchy

Throws:

IllegalStateException - If this method is called on an instance, which doesn't possess this capability

IllegalArgumentException - If the given Object is not of the right type, to allow an attachment into the current hierarchy

JUploadExceptionStopAddingFiles - When an error occurs, indicating that not all files were added

getValueAt

Object getValueAt(T node,
                  int column)

Returns the value of a node in a column.

Parameters:

node - Node

column - Column number

Returns:

Value of the node in the column

isCellEditable

boolean isCellEditable(T node,
                       int column)

Check if a cell of a node in one column is editable.

Parameters:

node - Node

column - Column number

Returns:

true/false

setValueAt

void setValueAt(Object aValue,
                T node,
                int column)

Sets a value for a node in one column.

Parameters:

aValue - New value

node - Node

column - Column number

setTree

void setTree(MyTreeTableCellRenderer tree)

Parameters:

tree - the tree to set

fireTreeNodesChanged

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

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

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:

TreeModelListener

fireTreeNodesInserted

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

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

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:

TreeModelListener

fireTreeNodesRemoved

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

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

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:

TreeModelListener

fireTreeStructureChanged

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

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

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:

TreeModelListener

getTreePath

TreePath getTreePath(T item)

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

Parameters:

item -

Returns:

The build TreePath

Throws:

IllegalArgumentException - If item is not in the tree represented by this model.

getTreePathForObject

TreePath getTreePathForObject(Object o)

Get the TreePath for the given object. This method is optional. It is typically only applicable if this hierarchy maps on another hierarchy (for instance a hierarchy of files, based on a local file system)

Parameters:

o -

Returns:

The TreePath, with the last component being the node linked to the o object. It returns null, if this object is not in the hierarchy.

Throws:

IllegalStateException - If this method is called on an instance, which doesn't possess this capability

IllegalArgumentException - If the given Object is not of the right type, to allow an attachment into the current hierarchy