All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.datatransfer.DataFlavor

java.lang.Object
   |
   +----java.awt.datatransfer.DataFlavor

public class DataFlavor
extends Object
Each instance represents the opaque concept of a data format as would appear on a clipboard, during drag and drop, or in a file system.


Variable Index

 o plainTextFlavor
The DataFlavor representing plain text with unicode encoding, where:

representationClass = InputStream
mimeType = "text/plain; charset=unicode"

 o stringFlavor
The DataFlavor representing a Java Unicode String class, where:

representationClass = java.lang.String
mimeType = "application/x-java-serialized-object"

Constructor Index

 o DataFlavor(Class, String)
Construct a DataFlavor that represents a Java class

The returned DataFlavor will have the following characteristics

representationClass = representationClass
mimeType = application/x-java-serialized-object

 o DataFlavor(String, String)
Construct a DataFlavor that represents a MimeType

The returned DataFlavor will have the following characteristics:

If the mimeType is "application/x-java-serialized-object; class=", the result is the same as calling new DataFlavor(Class:forName() as above

otherwise:

representationClass = InputStream
mimeType = mimeType

Method Index

 o equals(DataFlavor)
 o getHumanPresentableName()
Returns the human presentable name for the data foramt that this DataFlavor represents.
 o getMimeType()
Returns the MIME type string for this DataFlavor
 o getRepresentationClass()
Returns the Class which objects supporting this DataFlavor will return when this DataFlavor is requested.
 o isMimeTypeEqual(DataFlavor)
Convenience function equivalent to calling: isMimeTypeEqual(dataFlavor.getMimeType());
 o isMimeTypeEqual(String)
Is the string representation of the MIME type passed in equivalent to the MIME type of this DataFlavor.
 o normalizeMimeType(String)
Called for each MIME type string to give DataFlavor subtypes the opportunity to change how the normalization of MIME types is accomplished.
 o normalizeMimeTypeParameter(String, String)
Called on DataFlavor for every MIME Type parameter to allow DataFlavor subclasses to handle special parameters like the text/plain charset parameters, whose values are case insensitive.
 o setHumanPresentableName(String)
Sets the human presentable name for the data format that this DataFlavor represents.

Variables

 o stringFlavor
 public static DataFlavor stringFlavor
The DataFlavor representing a Java Unicode String class, where:

representationClass = java.lang.String
mimeType = "application/x-java-serialized-object"

 o plainTextFlavor
 public static DataFlavor plainTextFlavor
The DataFlavor representing plain text with unicode encoding, where:

representationClass = InputStream
mimeType = "text/plain; charset=unicode"

Constructors

 o DataFlavor
 public DataFlavor(Class representationClass,
                   String humanPresentableName)
Construct a DataFlavor that represents a Java class

The returned DataFlavor will have the following characteristics

representationClass = representationClass
mimeType = application/x-java-serialized-object

Parameters:
representationClass - the class used to transfer data in this flavor
humanPresentableName - the human-readible string used to identify this flavor
 o DataFlavor
 public DataFlavor(String mimeType,
                   String humanPresentableName)
Construct a DataFlavor that represents a MimeType

The returned DataFlavor will have the following characteristics:

If the mimeType is "application/x-java-serialized-object; class=", the result is the same as calling new DataFlavor(Class:forName() as above

otherwise:

representationClass = InputStream
mimeType = mimeType

Parameters:
mimeType - the string used to identify the MIME type for this flavor
humanPresentableName - the human-readible string used to identify this flavor

Methods

 o getMimeType
 public String getMimeType()
Returns the MIME type string for this DataFlavor

 o getRepresentationClass
 public Class getRepresentationClass()
Returns the Class which objects supporting this DataFlavor will return when this DataFlavor is requested.

 o getHumanPresentableName
 public String getHumanPresentableName()
Returns the human presentable name for the data foramt that this DataFlavor represents. This name would be localized for different countries

 o setHumanPresentableName
 public void setHumanPresentableName(String humanPresentableName)
Sets the human presentable name for the data format that this DataFlavor represents. This name would be localized for different countries

 o equals
 public boolean equals(DataFlavor dataFlavor)
 o isMimeTypeEqual
 public boolean isMimeTypeEqual(String mimeType)
Is the string representation of the MIME type passed in equivalent to the MIME type of this DataFlavor. This may involve adding default attributes for some MIME types (like adding charset=US-ASCII to text/plain MIME types that have no charset parameter specified)

 o isMimeTypeEqual
 public final boolean isMimeTypeEqual(DataFlavor dataFlavor)
Convenience function equivalent to calling: isMimeTypeEqual(dataFlavor.getMimeType());

 o normalizeMimeTypeParameter
 protected String normalizeMimeTypeParameter(String parameterName,
                                             String parameterValue)
Called on DataFlavor for every MIME Type parameter to allow DataFlavor subclasses to handle special parameters like the text/plain charset parameters, whose values are case insensitive. (MIME type parameter values are supposed to be case sensitive.

This method is called for each parameter name/value pair and should return the normalized representation of the parameterValue

 o normalizeMimeType
 protected String normalizeMimeType(String mimeType)
Called for each MIME type string to give DataFlavor subtypes the opportunity to change how the normalization of MIME types is accomplished. One possible use would be to add default parameter/value pairs in cases where none are present in the MIME type string passed in


All Packages  Class Hierarchy  This Package  Previous  Next  Index

Submit a bug or feature