public class

StringSelection

extends Object
implements ClipboardOwner Transferable
java.lang.Object
   ↳ java.awt.datatransfer.StringSelection

Class Overview

A Transferable which implements the capability required to transfer a String. This Transferable properly supports DataFlavor.stringFlavor and all equivalent flavors. Support for DataFlavor.plainTextFlavor and all equivalent flavors is deprecated. No other DataFlavors are supported.

Summary

Public Constructors
StringSelection(String data)
Creates a Transferable capable of transferring the specified String.
Public Methods
Object getTransferData(DataFlavor flavor)
Returns the Transferable's data in the requested DataFlavor if possible.
DataFlavor[] getTransferDataFlavors()
Returns an array of flavors in which this Transferable can provide the data.
boolean isDataFlavorSupported(DataFlavor flavor)
Returns whether the requested flavor is supported by this Transferable.
void lostOwnership(Clipboard clipboard, Transferable contents)
Notifies this object that it is no longer the clipboard owner.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.awt.datatransfer.ClipboardOwner
From interface java.awt.datatransfer.Transferable

Public Constructors

public StringSelection (String data)

Creates a Transferable capable of transferring the specified String.

Public Methods

public Object getTransferData (DataFlavor flavor)

Returns the Transferable's data in the requested DataFlavor if possible. If the desired flavor is DataFlavor.stringFlavor, or an equivalent flavor, the String representing the selection is returned. If the desired flavor is DataFlavor.plainTextFlavor, or an equivalent flavor, a Reader is returned. Note: The behavior of this method for DataFlavor.plainTextFlavor and equivalent DataFlavors is inconsistent with the definition of DataFlavor.plainTextFlavor.

Parameters
flavor the requested flavor for the data
Returns
  • the data in the requested flavor, as outlined above
Throws
UnsupportedFlavorException if the requested data flavor is not equivalent to either DataFlavor.stringFlavor or DataFlavor.plainTextFlavor
IOException if an IOException occurs while retrieving the data. By default, StringSelection never throws this exception, but a subclass may.
NullPointerException if flavor is null
See Also

public DataFlavor[] getTransferDataFlavors ()

Returns an array of flavors in which this Transferable can provide the data. DataFlavor.stringFlavor is properly supported. Support for DataFlavor.plainTextFlavor is deprecated.

Returns
  • an array of length two, whose elements are DataFlavor. stringFlavor and DataFlavor.plainTextFlavor

public boolean isDataFlavorSupported (DataFlavor flavor)

Returns whether the requested flavor is supported by this Transferable.

Parameters
flavor the requested flavor for the data
Returns
  • true if flavor is equal to DataFlavor.stringFlavor or DataFlavor.plainTextFlavor; false if flavor is not one of the above flavors
Throws
NullPointerException if flavor is null

public void lostOwnership (Clipboard clipboard, Transferable contents)

Notifies this object that it is no longer the clipboard owner. This method will be called when another application or another object within this application asserts ownership of the clipboard.

Parameters
clipboard the clipboard that is no longer owned
contents the contents which this owner had placed on the clipboard