StringSelection (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt.datatransfer
class StringSelection

java.lang.Object
  java.awt.datatransfer.StringSelection

All Implemented Interfaces:: ClipboardOwner, Transferable

Most common way to construct:

String selection = …;

StringSelection contents = new StringSelection(selection);

Based on 103 examples

public class StringSelection
extends Object
implements Transferable, ClipboardOwner

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.

Constructor Summary
`StringSelection(String data)` Creates a `Transferable` capable of transferring the specified `String`.

Method Summary
`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)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

StringSelection

public StringSelection(String data)

Creates a Transferable capable of transferring the specified String.

Parameters:: data

Method Detail

getTransferData

public Object getTransferData(DataFlavor flavor)
                       throws UnsupportedFlavorException,
                              IOException

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.

getTransferDataFlavors

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

isDataFlavorSupported

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

lostOwnership

public void lostOwnership(Clipboard clipboard,
                          Transferable contents)

Parameters:: clipboard; contents