org.sbml.jsbml.util

Class TreeNodeRemovedEvent

java.lang.Object

java.util.EventObject

org.sbml.jsbml.util.TreeNodeRemovedEvent

All Implemented Interfaces:

java.io.Serializable

public class TreeNodeRemovedEvent
extends java.util.EventObject

A special EventObject to notify a TreeNodeChangeListener about a removed node and its previous position within the tree. To this end, this TreeNodeRemovedEvent contains a pointer to both the actual removed node and its previous parent node. Note that when removing an element from the SBML tree, its pointer to its parent is set to null. To give an example why information about the previous parent is necessary: Imagine, an instance of speciesReference has been removed from the SBML tree. After removing it, the model does no longer point to an element with its id. Many reactions might have been the origin of this removed node. If a TreeNodeChangeListener wants to, e.g., undo this change, it is necessary to identify the previous position of the node within the tree. That's why this class has two important methods, namely getSource() and getPreviousParent().

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private javax.swing.tree.TreeNode	previousParent The previous parent node in the tree, i.e., the node that was the parent of the deleted node (see getSource()) before the deletion.
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TreeNodeRemovedEvent(TreeNodeRemovedEvent treeNodeRemovedEvent) Clone constructor.
TreeNodeRemovedEvent(javax.swing.tree.TreeNode source, javax.swing.tree.TreeNode prevParent) Creates a new TreeNodeRemovedEvent that contains information about an element that has just been removed from a tree together with its previous parent node.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	clone()
javax.swing.tree.TreeNode	getPreviousParent() Access the pointer to the previous parent node of the removed node, may be null.
javax.swing.tree.TreeNode	getSource()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

previousParent

private final javax.swing.tree.TreeNode previousParent

The previous parent node in the tree, i.e., the node that was the parent of the deleted node (see getSource()) before the deletion.

Constructor Detail

TreeNodeRemovedEvent

public TreeNodeRemovedEvent(javax.swing.tree.TreeNode source,
                            javax.swing.tree.TreeNode prevParent)

Creates a new TreeNodeRemovedEvent that contains information about an element that has just been removed from a tree together with its previous parent node.

Parameters:

source - the node that has just been removed from the tree.

prevParent - the node that was the parent node of the removed element, may be null if the node didn't have a parent.

TreeNodeRemovedEvent

public TreeNodeRemovedEvent(TreeNodeRemovedEvent treeNodeRemovedEvent)

Clone constructor.

Parameters:

treeNodeRemovedEvent -

Method Detail

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getPreviousParent

public javax.swing.tree.TreeNode getPreviousParent()

Access the pointer to the previous parent node of the removed node, may be null.

Returns:

the previosParent

See Also:

getSource()

getSource

public javax.swing.tree.TreeNode getSource()

Overrides:

getSource in class java.util.EventObject

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject