java.awt.datatransfer
Class StringSelection
- java.lang.Object
-
- java.awt.datatransfer.StringSelection
-
- All Implemented Interfaces:
- ClipboardOwner, Transferable
public class StringSelection extends Object implements Transferable, ClipboardOwner
ATransferable
which implements the capability required to transfer aString
. ThisTransferable
properly supportsDataFlavor.stringFlavor
and all equivalent flavors. Support forDataFlavor.plainTextFlavor
and all equivalent flavors is deprecated. No otherDataFlavor
s are supported.
-
-
Constructor Summary
Constructors Constructor and Description StringSelection(String data)
Creates aTransferable
capable of transferring the specifiedString
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Object
getTransferData(DataFlavor flavor)
Returns theTransferable
's data in the requestedDataFlavor
if possible.DataFlavor[]
getTransferDataFlavors()
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 Detail
StringSelection
public StringSelection(String data)
Creates aTransferable
capable of transferring the specifiedString
.
-
Method Detail
getTransferDataFlavors
public DataFlavor[] 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
public boolean isDataFlavorSupported(DataFlavor flavor)
Returns whether the requested flavor is supported by thisTransferable
.- Specified by:
-
isDataFlavorSupported
in interfaceTransferable
- Parameters:
-
flavor
- the requested flavor for the data - Returns:
-
true if
flavor
is equal toDataFlavor.stringFlavor
orDataFlavor.plainTextFlavor
; false ifflavor
is not one of the above flavors - Throws:
-
NullPointerException
- if flavor isnull
getTransferData
public Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException, IOException
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
- if flavor isnull
- See Also:
-
Reader
lostOwnership
public void lostOwnership(Clipboard clipboard, Transferable contents)
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 owned -
contents
- the contents which this owner had placed on the clipboard
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.