Skip to content

Most visited

Recently visited

navigation

ClipData.Item

public static class ClipData.Item
extends Object

java.lang.Object
   ↳ android.content.ClipData.Item


Description of a single item in a ClipData.

The types than an individual item can currently contain are:

  • Text: a basic string of text. This is actually a CharSequence, so it can be formatted text supported by corresponding Android built-in style spans. (Custom application spans are not supported and will be stripped when transporting through the clipboard.)
  • Intent: an arbitrary Intent object. A typical use is the shortcut to create when pasting a clipped item on to the home screen.
  • Uri: a URI reference. This may be any URI (such as an http: URI representing a bookmark), however it is often a content: URI. Using content provider references as clips like this allows an application to share complex or large clips through the standard content provider facilities.

Summary

Public constructors

ClipData.Item(CharSequence text)

Create an Item consisting of a single block of (possibly styled) text.

ClipData.Item(CharSequence text, String htmlText)

Create an Item consisting of a single block of (possibly styled) text, with an alternative HTML formatted representation.

ClipData.Item(Intent intent)

Create an Item consisting of an arbitrary Intent.

ClipData.Item(Uri uri)

Create an Item consisting of an arbitrary URI.

ClipData.Item(CharSequence text, Intent intent, Uri uri)

Create a complex Item, containing multiple representations of text, Intent, and/or URI.

ClipData.Item(CharSequence text, String htmlText, Intent intent, Uri uri)

Create a complex Item, containing multiple representations of text, HTML text, Intent, and/or URI.

Public methods

String coerceToHtmlText(Context context)

Turn this item into HTML text, regardless of the type of data it actually contains.

CharSequence coerceToStyledText(Context context)

Like coerceToHtmlText(Context), but any text that would be returned as HTML formatting will be returned as text with style spans.

CharSequence coerceToText(Context context)

Turn this item into text, regardless of the type of data it actually contains.

String getHtmlText()

Retrieve the raw HTML text contained in this Item.

Intent getIntent()

Retrieve the raw Intent contained in this Item.

CharSequence getText()

Retrieve the raw text contained in this Item.

Uri getUri()

Retrieve the raw URI contained in this Item.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Public constructors

ClipData.Item

Added in API level 11
ClipData.Item (CharSequence text)

Create an Item consisting of a single block of (possibly styled) text.

Parameters
text CharSequence

ClipData.Item

Added in API level 16
ClipData.Item (CharSequence text, 
                String htmlText)

Create an Item consisting of a single block of (possibly styled) text, with an alternative HTML formatted representation. You must supply a plain text representation in addition to HTML text; coercion will not be done from HTML formated text into plain text.

Parameters
text CharSequence
htmlText String

ClipData.Item

Added in API level 11
ClipData.Item (Intent intent)

Create an Item consisting of an arbitrary Intent.

Parameters
intent Intent

ClipData.Item

Added in API level 11
ClipData.Item (Uri uri)

Create an Item consisting of an arbitrary URI.

Parameters
uri Uri

ClipData.Item

Added in API level 11
ClipData.Item (CharSequence text, 
                Intent intent, 
                Uri uri)

Create a complex Item, containing multiple representations of text, Intent, and/or URI.

Parameters
text CharSequence
intent Intent
uri Uri

ClipData.Item

Added in API level 16
ClipData.Item (CharSequence text, 
                String htmlText, 
                Intent intent, 
                Uri uri)

Create a complex Item, containing multiple representations of text, HTML text, Intent, and/or URI. If providing HTML text, you must supply a plain text representation as well; coercion will not be done from HTML formated text into plain text.

Parameters
text CharSequence
htmlText String
intent Intent
uri Uri

Public methods

coerceToHtmlText

Added in API level 16
String coerceToHtmlText (Context context)

Turn this item into HTML text, regardless of the type of data it actually contains.

The algorithm for deciding what text to return is:

  • If getHtmlText() is non-null, return that.
  • If getText() is non-null, return that, converting to valid HTML text. If this text contains style spans, Html.toHtml(Spanned) is used to convert them to HTML formatting.
  • If getUri() is non-null, try to retrieve its data as a text stream from its content provider. If the provider can supply text/html data, that will be preferred and returned as-is. Otherwise, any text/* data will be returned and escaped to HTML. If it is not a content: URI or the content provider does not supply a text representation, HTML text containing a link to the URI will be returned.
  • If getIntent() is non-null, convert that to an intent: URI and return as an HTML link.
  • Otherwise, return an empty string.

Parameters
context Context: The caller's Context, from which its ContentResolver and other things can be retrieved.
Returns
String Returns the item's representation as HTML text.

coerceToStyledText

Added in API level 16
CharSequence coerceToStyledText (Context context)

Like coerceToHtmlText(Context), but any text that would be returned as HTML formatting will be returned as text with style spans.

Parameters
context Context: The caller's Context, from which its ContentResolver and other things can be retrieved.
Returns
CharSequence Returns the item's textual representation.

coerceToText

Added in API level 11
CharSequence coerceToText (Context context)

Turn this item into text, regardless of the type of data it actually contains.

The algorithm for deciding what text to return is:

  • If getText() is non-null, return that.
  • If getUri() is non-null, try to retrieve its data as a text stream from its content provider. If this succeeds, copy the text into a String and return it. If it is not a content: URI or the content provider does not supply a text representation, return the raw URI as a string.
  • If getIntent() is non-null, convert that to an intent: URI and return it.
  • Otherwise, return an empty string.

Parameters
context Context: The caller's Context, from which its ContentResolver and other things can be retrieved.
Returns
CharSequence Returns the item's textual representation.

getHtmlText

Added in API level 16
String getHtmlText ()

Retrieve the raw HTML text contained in this Item.

Returns
String

getIntent

Added in API level 11
Intent getIntent ()

Retrieve the raw Intent contained in this Item.

Returns
Intent

getText

Added in API level 11
CharSequence getText ()

Retrieve the raw text contained in this Item.

Returns
CharSequence

getUri

Added in API level 11
Uri getUri ()

Retrieve the raw URI contained in this Item.

Returns
Uri

toString

Added in API level 11
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.