java.lang.Object
java.awt.datatransfer.StringSelection
- All Implemented Interfaces:
ClipboardOwner
,Transferable
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 DataFlavor
s
are supported.
- Since:
- 1.1
- See Also:
-
Constructor Summary
ConstructorDescriptionStringSelection
(String data) Creates aTransferable
capable of transferring the specifiedString
. -
Method Summary
Modifier and TypeMethodDescriptiongetTransferData
(DataFlavor flavor) Returns theTransferable
's data in the requestedDataFlavor
if possible.Returns an array of flavors in which thisTransferable
can provide the data.boolean
isDataFlavorSupported
(DataFlavor flavor) Returns whether the requested flavor is supported by thisTransferable
.void
lostOwnership
(Clipboard clipboard, Transferable contents) Notifies this object that it is no longer the clipboard owner.
-
Constructor Details
-
StringSelection
Creates aTransferable
capable of transferring the specifiedString
.- Parameters:
data
- the string to be transferred
-
-
Method Details
-
getTransferDataFlavors
Returns an array of flavors in which thisTransferable
can provide the data.DataFlavor.stringFlavor
is properly supported. Support forDataFlavor.plainTextFlavor
is deprecated.- Specified by:
getTransferDataFlavors
in interfaceTransferable
- Returns:
- an array of length two, whose elements are
DataFlavor.stringFlavor
andDataFlavor.plainTextFlavor
-
isDataFlavorSupported
Returns whether the requested flavor is supported by thisTransferable
.- Specified by:
isDataFlavorSupported
in interfaceTransferable
- Parameters:
flavor
- the requested flavor for the data- Returns:
true
ifflavor
is equal toDataFlavor.stringFlavor
orDataFlavor.plainTextFlavor
;false
ifflavor
is not one of the above flavors- Throws:
NullPointerException
- ifflavor
isnull
-
getTransferData
Returns theTransferable
's data in the requestedDataFlavor
if possible. If the desired flavor isDataFlavor.stringFlavor
, or an equivalent flavor, theString
representing the selection is returned. If the desired flavor isDataFlavor.plainTextFlavor
, or an equivalent flavor, aReader
is returned.
Note: The behavior of this method forDataFlavor.plainTextFlavor
and equivalentDataFlavor
s is inconsistent with the definition ofDataFlavor.plainTextFlavor
.- Specified by:
getTransferData
in interfaceTransferable
- 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 eitherDataFlavor.stringFlavor
orDataFlavor.plainTextFlavor
IOException
- if an IOException occurs while retrieving the data. By default, StringSelection never throws this exception, but a subclass may.NullPointerException
- ifflavor
isnull
- See Also:
-
lostOwnership
Description copied from interface:ClipboardOwner
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.- Specified by:
lostOwnership
in interfaceClipboardOwner
- Parameters:
clipboard
- the clipboard that is no longer ownedcontents
- the contents which this owner had placed on theclipboard
-