- 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
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 ownedcontents
- the contents which this owner had placed on the clipboard
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/datatransfer/stringselection.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.