org.stringer.ui
Class TransferableTreeNode

java.lang.Object
  |
  +--javax.swing.tree.DefaultMutableTreeNode
        |
        +--org.stringer.ui.TransferableTreeNode

All Implemented Interfaces:

java.lang.Cloneable, javax.swing.tree.MutableTreeNode, java.io.Serializable, java.awt.datatransfer.Transferable, javax.swing.tree.TreeNode

public class TransferableTreeNode

extends javax.swing.tree.DefaultMutableTreeNode

implements java.awt.datatransfer.Transferable

A Custom Transferable object. During a drag operation on a Jtree this the TransferableTreeNode is the object that is dragged around. Any DefaultMutableTreeNode can be dragged around, so you do not have to do anything special to create tree nodes just for draggable trees. Its primary job is to return the proper object from public Object getTransferData(DataFlavor flavor), based upon the requested flavor from the drop point. To support our custom flavor, we need to create a DataFlavor and be sure public DataFlavor[] getTransferDataFlavors() returns it, along with the other supported flavors.

Implements the Transferable interface for classes that can be used to provide data for a transfer operation.

The Path Taken by a Transferrable

• The DragGestureListener gets the Transferable (probably from the GUI component) and sends it to the DragSource via the startDrag message.
• The DragSource sends the same message to its DragSourceContext, which in turn forwards it to its peer (passing itself as a parameter). The native system thus has access to the Transferable through the DragSourceContext.
• The DropTargetContextPeer now has access to this Transferable. When the DropTargetContext receives the getTransferable message, it creates and returns a TransferableProxy object from the DropTargetContextPeer's Transferable.
• The TransferableProxy is returned to the DropTargetListener when the DropTargetListener asks the DropTargetDropEvent for the Transferable. (The Event forwards the Listener's getTransferable message to its DropTargetContext.)

See Also:

Serialized Form

Field Summary

private javax.swing.tree.DefaultMutableTreeNode	data
static java.awt.datatransfer.DataFlavor	DEFAULT_MUTABLE_TREENODE_FLAVOR
private static java.util.List	flavorList the types of data that we can provide expressed as a Collection
(package private) static java.awt.datatransfer.DataFlavor[]	flavors the types of data that we can provide
(package private) static int	TREE

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

TransferableTreeNode(javax.swing.tree.DefaultMutableTreeNode data)

Method Summary

java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor)
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors()
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)
java.lang.String	toString()

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

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

Field Detail

TREE

static final int TREE

See Also:

Constant Field Values

DEFAULT_MUTABLE_TREENODE_FLAVOR

public static final java.awt.datatransfer.DataFlavor DEFAULT_MUTABLE_TREENODE_FLAVOR

flavors

static java.awt.datatransfer.DataFlavor[] flavors

the types of data that we can provide

flavorList

private static final java.util.List flavorList

the types of data that we can provide expressed as a Collection

data

private javax.swing.tree.DefaultMutableTreeNode data

Constructor Detail

TransferableTreeNode

public TransferableTreeNode(javax.swing.tree.DefaultMutableTreeNode data)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class javax.swing.tree.DefaultMutableTreeNode

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

java.awt.datatransfer.UnsupportedFlavorException

java.io.IOException

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable