com.jgraph.graph
Class GraphTransferable

java.lang.Object
  extended bycom.jgraph.plaf.basic.BasicTransferable
      extended bycom.jgraph.graph.GraphTransferable
All Implemented Interfaces:
java.awt.datatransfer.ClipboardOwner, java.io.Serializable, java.awt.datatransfer.Transferable, javax.swing.plaf.UIResource

public class GraphTransferable
extends BasicTransferable
implements java.io.Serializable, java.awt.datatransfer.ClipboardOwner

An object that represents the clipboard contents for a graph selection. The object has three representations:

1. Richer: The cells, view attributes and connections for this selection are stored as separate datastructures, which can be inserted using the GraphModel.insert() method. 2. HTML: If one cell is selected, the userObject is returned as HTML. 3. Plain: The userObject of the selected cell is returned as plain text.

See Also:
Serialized Form

Field Summary
protected  java.util.Map attributeMap
          (Cell, Map) entries that hold the view attributes for the cells.
protected  java.awt.Rectangle bounds
          Rectangle that defines the former bounds of the views.
protected  java.lang.Object[] cells
          Selected cells.
protected  ConnectionSet cs
          Object that describes the connection between cells.
static java.awt.datatransfer.DataFlavor dataFlavor
          Local Machine Reference Data Flavor.
 
Constructor Summary
GraphTransferable(java.lang.Object[] cells, ConnectionSet cs, java.util.Map attrMap, java.awt.Rectangle bounds)
          Constructs a new transferable selection for cells, csand attrMap.
 
Method Summary
 java.util.Map getAttributeMap()
          Returns a map of (GraphCell, Map)-pairs that represent the view attributes for the respecive cells.
 java.awt.Rectangle getBounds()
           
 java.lang.Object[] getCells()
          Returns the cells that represent the selection.
 ConnectionSet getConnectionSet()
          Returns the connections between cells (and possibly other, unselected cells).
 java.lang.String getHTMLData()
          Fetch the data in a text/html format.
 java.lang.String getPlainData()
          Fetch the data in a text/plain format.
 java.lang.Object getRicherData(java.awt.datatransfer.DataFlavor flavor)
          Fetch the data in a jvm-localreference format.
 java.awt.datatransfer.DataFlavor[] getRicherFlavors()
          Returns the jvm-localreference flavors of the transferable.
 boolean isHTMLSupported()
          Returns true if the transferable support a text/html format.
 boolean isPlainSupported()
          Returns true if the transferable support a text/plain format.
 void lostOwnership(java.awt.datatransfer.Clipboard clip, java.awt.datatransfer.Transferable contents)
           
 
Methods inherited from class com.jgraph.plaf.basic.BasicTransferable
getTransferData, getTransferDataFlavors, isDataFlavorSupported, isHTMLFlavor, isPlainFlavor, isRicherFlavor, isStringFlavor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dataFlavor

public static java.awt.datatransfer.DataFlavor dataFlavor
Local Machine Reference Data Flavor.


cells

protected java.lang.Object[] cells
Selected cells.


cs

protected ConnectionSet cs
Object that describes the connection between cells.


attributeMap

protected java.util.Map attributeMap
(Cell, Map) entries that hold the view attributes for the cells.


bounds

protected java.awt.Rectangle bounds
Rectangle that defines the former bounds of the views.

Constructor Detail

GraphTransferable

public GraphTransferable(java.lang.Object[] cells,
                         ConnectionSet cs,
                         java.util.Map attrMap,
                         java.awt.Rectangle bounds)
Constructs a new transferable selection for cells, csand attrMap.

Method Detail

getCells

public java.lang.Object[] getCells()
Returns the cells that represent the selection.


getConnectionSet

public ConnectionSet getConnectionSet()
Returns the connections between cells (and possibly other, unselected cells).


getAttributeMap

public java.util.Map getAttributeMap()
Returns a map of (GraphCell, Map)-pairs that represent the view attributes for the respecive cells.


getBounds

public java.awt.Rectangle getBounds()

lostOwnership

public void lostOwnership(java.awt.datatransfer.Clipboard clip,
                          java.awt.datatransfer.Transferable contents)
Specified by:
lostOwnership in interface java.awt.datatransfer.ClipboardOwner

getRicherFlavors

public java.awt.datatransfer.DataFlavor[] getRicherFlavors()
Returns the jvm-localreference flavors of the transferable.

Overrides:
getRicherFlavors in class BasicTransferable

getRicherData

public java.lang.Object getRicherData(java.awt.datatransfer.DataFlavor flavor)
                               throws java.awt.datatransfer.UnsupportedFlavorException
Fetch the data in a jvm-localreference format.

Overrides:
getRicherData in class BasicTransferable
Throws:
java.awt.datatransfer.UnsupportedFlavorException

isPlainSupported

public boolean isPlainSupported()
Returns true if the transferable support a text/plain format.

Overrides:
isPlainSupported in class BasicTransferable

getPlainData

public java.lang.String getPlainData()
Fetch the data in a text/plain format.

Overrides:
getPlainData in class BasicTransferable

isHTMLSupported

public boolean isHTMLSupported()
Returns true if the transferable support a text/html format.

Overrides:
isHTMLSupported in class BasicTransferable

getHTMLData

public java.lang.String getHTMLData()
Fetch the data in a text/html format.

Overrides:
getHTMLData in class BasicTransferable