org.midica.ui.model

Class MidicaTreeModel

java.lang.Object

javax.swing.tree.DefaultTreeModel

org.midica.ui.model.MidicaTreeModel

All Implemented Interfaces:

java.io.Serializable, javax.swing.tree.TreeModel

public class MidicaTreeModel
extends javax.swing.tree.DefaultTreeModel

This class defines a tree model for trees displaying MIDI sequence information.

It uses nodes of the type MidicaTreeNode.

In order to use this tree model, the following steps are necessary:

• Call the constructor with the text to be displayed by the root node.
• For each leaf: call add(ArrayList, String) providing one string array per node on the way to the leaf.
• After adding each leaf: call postprocess().
• Create the tree.
• Call setTree(MidicaTree).

Author:

Jan Trukenmüller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private MidicaTreeNode	rootNode
private static long	serialVersionUID
private MidicaTree	tree

Fields inherited from class javax.swing.tree.DefaultTreeModel

asksAllowsChildren, listenerList, root

Constructor Summary

Constructors

Constructor and Description
MidicaTreeModel(java.lang.String name) Creates a new tree model and initializes it with a new empty root node.
MidicaTreeModel(java.lang.String name, java.lang.Class<?> nodeClass) Creates a new tree model and initializes it with a new empty root node.

Method Summary

Modifier and Type	Method and Description
MidicaTreeNode	add(java.util.ArrayList<java.lang.String[]> params, java.lang.String ttAttachment) Adds a new path to the tree, if it does not yet exist, using the root node as the entry point.
private MidicaTreeNode	add(MidicaTreeNode parent, java.util.ArrayList<java.lang.String[]> params, java.lang.String ttAttachment, boolean mustIncrement) Adds and/or increments new nodes (branch or leaf) recursively.
MidicaTreeNode	addWithoutIncrementing(java.util.ArrayList<java.lang.String[]> params) Adds a new path to the tree, if it does not yet exist, using the root node as the entry point, without incrementing the nodes in the path.
void	expandOrCollapse(boolean mustExpand) Expands or collapses (selected) nodes of the tree.
private void	expandOrCollapse(javax.swing.tree.TreePath parentPath, boolean mustExpand) Expands or collapses all children of the given node recursively.
private void	fillPathsByIds(java.util.TreeSet<java.lang.String> ids, MidicaTreeNode node, java.util.ArrayList<javax.swing.tree.TreePath> selectionPaths) Fills the given selectionPaths structure with all nodes under the given node recursively, that contain one of the given ids.
java.util.TreeSet<java.lang.String>	getSelectedIds() Collects and returns all IDs of currently selected tree nodes.
MidicaTree	getTree() Returns the tree or null, if the tree is not yet set.
void	postprocess() Connects all nodes with each other recursively.
void	selectByIds(java.util.TreeSet<java.lang.String> ids) Selects all tree nodes that contain one of the given IDs.
void	setTree(MidicaTree tree) Sets the tree to which this model belongs.

Methods inherited from class javax.swing.tree.DefaultTreeModel

addTreeModelListener, asksAllowsChildren, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getChild, getChildCount, getIndexOfChild, getListeners, getPathToRoot, getPathToRoot, getRoot, getTreeModelListeners, insertNodeInto, isLeaf, nodeChanged, nodesChanged, nodeStructureChanged, nodesWereInserted, nodesWereRemoved, reload, reload, removeNodeFromParent, removeTreeModelListener, setAsksAllowsChildren, setRoot, valueForPathChanged

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

rootNode

private MidicaTreeNode rootNode

tree

private MidicaTree tree

Constructor Detail

MidicaTreeModel

public MidicaTreeModel(java.lang.String name)

Creates a new tree model and initializes it with a new empty root node. The root node will be a MidicaTreeNode object.

Parameters:

name - Name of the root node.

MidicaTreeModel

public MidicaTreeModel(java.lang.String name,
                       java.lang.Class<?> nodeClass)
                throws java.lang.InstantiationException,
                       java.lang.IllegalAccessException

Creates a new tree model and initializes it with a new empty root node. The root node can be a derived class of MidicaTreeNode.

Parameters:

name - Name of the root node.

nodeClass - Class of the nodes.

Throws:

java.lang.IllegalAccessException - if the node class or its nullary constructor is not accessible.

java.lang.InstantiationException - if the root node creation fails.

Method Detail

setTree

public void setTree(MidicaTree tree)

Sets the tree to which this model belongs.

Parameters:

tree - The tree showing the data of this model.

getTree

public MidicaTree getTree()

Returns the tree or null, if the tree is not yet set.

Returns:

the tree.

add

public MidicaTreeNode add(java.util.ArrayList<java.lang.String[]> params,
                          java.lang.String ttAttachment)
                   throws java.lang.ReflectiveOperationException

Adds a new path to the tree, if it does not yet exist, using the root node as the entry point.

All nodes on the way to the leaf will be created if not yet done and incremented by 1. That includes all branches and the leaf.

Parameters:

params - Two-dimensional list.

• 1st dimension: node
• 2nd dimension:
  • id
  • name
  • number
  • sort key (optional) – if missing, id is used instead

ttAttachment - added to the leaf node’s tool tip text, if not null

Returns:

the leaf node of the added path.

Throws:

java.lang.ReflectiveOperationException - if the new child node cannot be created.

addWithoutIncrementing

public MidicaTreeNode addWithoutIncrementing(java.util.ArrayList<java.lang.String[]> params)
                                      throws java.lang.ReflectiveOperationException

Adds a new path to the tree, if it does not yet exist, using the root node as the entry point, without incrementing the nodes in the path.

All nodes on the way to the leaf will be created if not yet done, but not incremented. That includes all branches and the leaf.

Parameters:

params - params Two-dimensional list.

• 1st dimension: node
• 2nd dimension:
  • id
  • name
  • number
  • sort key (optional) – if missing, id is used instead

Returns:

the leaf node of the added path.

Throws:

java.lang.ReflectiveOperationException

add

private MidicaTreeNode add(MidicaTreeNode parent,
                           java.util.ArrayList<java.lang.String[]> params,
                           java.lang.String ttAttachment,
                           boolean mustIncrement)
                    throws java.lang.ReflectiveOperationException

Adds and/or increments new nodes (branch or leaf) recursively.

Parameters:

parent - Data structure where the new node is to be added.

params - Two-dimensional list.

• 1st dimension: node
• 2nd dimension:
  • id
  • name
  • number
  • sort key (optional) – if missing, id is used instead

ttAttachment - added to the leaf node’s tool tip text, if not null

mustIncrement - true if the affected nodes should be incremented, otherwise false.

Returns:

the leaf node of the added/incremented path.

Throws:

java.lang.ReflectiveOperationException - if the new child node cannot be created.

postprocess

public void postprocess()

Connects all nodes with each other recursively.

expandOrCollapse

public void expandOrCollapse(boolean mustExpand)

Expands or collapses (selected) nodes of the tree. If no nodes are selected, all nodes are expanded or collapsed.

Parameters:

mustExpand - true for expanding, false for collapsing

expandOrCollapse

private void expandOrCollapse(javax.swing.tree.TreePath parentPath,
                              boolean mustExpand)

Expands or collapses all children of the given node recursively.

Parameters:

parentPath - Path of the node to be expended.

mustExpand - true for expanding, false for collapsing

getSelectedIds

public java.util.TreeSet<java.lang.String> getSelectedIds()

Collects and returns all IDs of currently selected tree nodes. Does not collect null IDs.

Returns:

the collected IDs.

selectByIds

public void selectByIds(java.util.TreeSet<java.lang.String> ids)

Selects all tree nodes that contain one of the given IDs.

Parameters:

ids - the IDs associated with the nodes to be selected.

fillPathsByIds

private void fillPathsByIds(java.util.TreeSet<java.lang.String> ids,
                            MidicaTreeNode node,
                            java.util.ArrayList<javax.swing.tree.TreePath> selectionPaths)

Fills the given selectionPaths structure with all nodes under the given node recursively, that contain one of the given ids. Works recursively.

Parameters:

ids - the IDs associated with the nodes to be collected.

node - the node under which to be searched.

selectionPaths - the structure to be filled.