instrument/JTree API Documentation

org.pvv.bcd.instrument.JTree
Class VetoableTreeStructureChangeEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--org.pvv.bcd.instrument.JTree.VetoableTreeStructureChangeEvent
All Implemented Interfaces:
java.io.Serializable

public class VetoableTreeStructureChangeEvent
extends java.util.EventObject

The event object for a tree structure change. Listeners to this event type have the power to veto the change, in which case it will not happen.

In an unfortunate turn of events (some would call it a design glitch, others will fess up and call it laziness), this event class is used for two distinct types of tree structure changes. For each of these two, some of our properties will make sense and others should be ignored. This is how it works;

  1. When a node is renamed, an event is filled in with its oldName, newName, source and node properties set. All others should be ignored as they will generally by null or zero or somesuch.
  2. When a node is moved, an event is filled in with its oldParent, oldIndex, newParent, newIndex, source and node properties set. All others should be ignored as they will generally by null or zero or somesuch.

See Also:
Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
VetoableTreeStructureChangeEvent(java.lang.Object source)
          Create an unspecified event.
VetoableTreeStructureChangeEvent(java.lang.Object source, javax.swing.tree.TreeNode node, java.lang.String oldname, java.lang.String newname)
          Create a "change name" event
VetoableTreeStructureChangeEvent(java.lang.Object source, javax.swing.tree.TreeNode node, javax.swing.tree.TreeNode oldparent, int oldindex, javax.swing.tree.TreeNode newparent, int newindex)
          Create a "node moved" event
 
Method Summary
 int getNewIndex()
           
 java.lang.String getNewName()
           
 javax.swing.tree.TreeNode getNewParent()
           
 javax.swing.tree.TreeNode getNode()
           
 int getOldIndex()
           
 java.lang.String getOldName()
           
 javax.swing.tree.TreeNode getOldParent()
           
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VetoableTreeStructureChangeEvent

public VetoableTreeStructureChangeEvent(java.lang.Object source)
Create an unspecified event.

VetoableTreeStructureChangeEvent

public VetoableTreeStructureChangeEvent(java.lang.Object source,
                                        javax.swing.tree.TreeNode node,
                                        java.lang.String oldname,
                                        java.lang.String newname)
Create a "change name" event
Parameters:
source - Event source
node - Node that changed
oldname - Old name for node
newname - New name for node

VetoableTreeStructureChangeEvent

public VetoableTreeStructureChangeEvent(java.lang.Object source,
                                        javax.swing.tree.TreeNode node,
                                        javax.swing.tree.TreeNode oldparent,
                                        int oldindex,
                                        javax.swing.tree.TreeNode newparent,
                                        int newindex)
Create a "node moved" event
Parameters:
source - Event source
node - Node that got moved
oldparent - Node we were moved from
oldindex - Index we used to have in our old parent
new - parent Node we are being moved to
newindex - Index we will be moved to in our new parent
Method Detail

getOldName

public java.lang.String getOldName()

getNewName

public java.lang.String getNewName()

getNode

public javax.swing.tree.TreeNode getNode()

getOldParent

public javax.swing.tree.TreeNode getOldParent()

getOldIndex

public int getOldIndex()

getNewParent

public javax.swing.tree.TreeNode getNewParent()

getNewIndex

public int getNewIndex()

instrument/JTree API Documentation