org.jdesktop.swingx.plaf.basic.core
Class BasicTransferable

java.lang.Object
  extended by org.jdesktop.swingx.plaf.basic.core.BasicTransferable
All Implemented Interfaces:
Transferable, UIResource

public class BasicTransferable
extends Object
implements Transferable, UIResource

A transferable implementation for the default data transfer of some Swing components.


Field Summary
protected  String htmlData
           
protected  String plainData
           
 
Constructor Summary
BasicTransferable(String plainData, String htmlData)
           
 
Method Summary
protected  String getHTMLData()
          Fetch the data in a text/html format
protected  String getPlainData()
          Fetch the data in a text/plain format.
protected  Object getRicherData(DataFlavor flavor)
           
protected  DataFlavor[] getRicherFlavors()
          Some subclasses will have flavors that are more descriptive than HTML or plain text.
 Object getTransferData(DataFlavor flavor)
          Returns an object which represents the data to be transferred.
 DataFlavor[] getTransferDataFlavors()
          Returns an array of DataFlavor objects indicating the flavors the data can be provided in.
 boolean isDataFlavorSupported(DataFlavor flavor)
          Returns whether or not the specified data flavor is supported for this object.
protected  boolean isHTMLFlavor(DataFlavor flavor)
          Returns whether or not the specified data flavor is an HTML flavor that is supported.
protected  boolean isHTMLSupported()
          Should the HTML flavors be offered? If so, the method getHTMLData should be implemented to provide something reasonable.
protected  boolean isPlainFlavor(DataFlavor flavor)
          Returns whether or not the specified data flavor is an plain flavor that is supported.
protected  boolean isPlainSupported()
          Should the plain text flavors be offered? If so, the method getPlainData should be implemented to provide something reasonable.
protected  boolean isRicherFlavor(DataFlavor flavor)
           
protected  boolean isStringFlavor(DataFlavor flavor)
          Returns whether or not the specified data flavor is a String flavor that is supported.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

plainData

protected String plainData

htmlData

protected String htmlData
Constructor Detail

BasicTransferable

public BasicTransferable(String plainData,
                         String htmlData)
Method Detail

getTransferDataFlavors

public DataFlavor[] getTransferDataFlavors()
Returns an array of DataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

Specified by:
getTransferDataFlavors in interface Transferable
Returns:
an array of data flavors in which this data can be transferred

isDataFlavorSupported

public boolean isDataFlavorSupported(DataFlavor flavor)
Returns whether or not the specified data flavor is supported for this object.

Specified by:
isDataFlavorSupported in interface Transferable
Parameters:
flavor - the requested flavor for the data
Returns:
boolean indicating whether or not the data flavor is supported

getTransferData

public Object getTransferData(DataFlavor flavor)
                       throws UnsupportedFlavorException,
                              IOException
Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Specified by:
getTransferData in interface Transferable
Parameters:
flavor - the requested flavor for the data
Throws:
IOException - if the data is no longer available in the requested flavor.
UnsupportedFlavorException - if the requested data flavor is not supported.
See Also:
DataFlavor.getRepresentationClass()

isRicherFlavor

protected boolean isRicherFlavor(DataFlavor flavor)

getRicherFlavors

protected DataFlavor[] getRicherFlavors()
Some subclasses will have flavors that are more descriptive than HTML or plain text. If this method returns a non-null value, it will be placed at the start of the array of supported flavors.


getRicherData

protected Object getRicherData(DataFlavor flavor)
                        throws UnsupportedFlavorException
Throws:
UnsupportedFlavorException

isHTMLFlavor

protected boolean isHTMLFlavor(DataFlavor flavor)
Returns whether or not the specified data flavor is an HTML flavor that is supported.

Parameters:
flavor - the requested flavor for the data
Returns:
boolean indicating whether or not the data flavor is supported

isHTMLSupported

protected boolean isHTMLSupported()
Should the HTML flavors be offered? If so, the method getHTMLData should be implemented to provide something reasonable.


getHTMLData

protected String getHTMLData()
Fetch the data in a text/html format


isPlainFlavor

protected boolean isPlainFlavor(DataFlavor flavor)
Returns whether or not the specified data flavor is an plain flavor that is supported.

Parameters:
flavor - the requested flavor for the data
Returns:
boolean indicating whether or not the data flavor is supported

isPlainSupported

protected boolean isPlainSupported()
Should the plain text flavors be offered? If so, the method getPlainData should be implemented to provide something reasonable.


getPlainData

protected String getPlainData()
Fetch the data in a text/plain format.


isStringFlavor

protected boolean isStringFlavor(DataFlavor flavor)
Returns whether or not the specified data flavor is a String flavor that is supported.

Parameters:
flavor - the requested flavor for the data
Returns:
boolean indicating whether or not the data flavor is supported