Android APIs
public class

ClipboardManager

extends ClipboardManager
java.lang.Object
   ↳ android.text.ClipboardManager
     ↳ android.content.ClipboardManager

Class Overview

Interface to the clipboard service, for placing and retrieving text in the global clipboard.

You do not instantiate this class directly; instead, retrieve it through getSystemService(Class).

The ClipboardManager API itself is very simple: it consists of methods to atomically get and set the current primary clipboard data. That data is expressed as a ClipData object, which defines the protocol for data exchange between applications.

Developer Guides

For more information about using the clipboard framework, read the Copy and Paste developer guide.

Summary

Nested Classes
interface ClipboardManager.OnPrimaryClipChangedListener Defines a listener callback that is invoked when the primary clip on the clipboard changes. 
Public Methods
void addPrimaryClipChangedListener(ClipboardManager.OnPrimaryClipChangedListener what)
ClipData getPrimaryClip()
Returns the current primary clip on the clipboard.
ClipDescription getPrimaryClipDescription()
Returns a description of the current primary clip on the clipboard but not a copy of its data.
CharSequence getText()
This method was deprecated in API level 11. Use getPrimaryClip() instead. This retrieves the primary clip and tries to coerce it to a string.
boolean hasPrimaryClip()
Returns true if there is currently a primary clip on the clipboard.
boolean hasText()
This method was deprecated in API level 11. Use hasPrimaryClip() instead.
void removePrimaryClipChangedListener(ClipboardManager.OnPrimaryClipChangedListener what)
void setPrimaryClip(ClipData clip)
Sets the current primary clip on the clipboard.
void setText(CharSequence text)
This method was deprecated in API level 11. Use setPrimaryClip(ClipData) instead. This creates a ClippedItem holding the given text and sets it as the primary clip. It has no label or icon.
[Expand]
Inherited Methods
From class android.text.ClipboardManager
From class java.lang.Object

Public Methods

public void addPrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)

Added in API level 11

Parameters
what ClipboardManager.OnPrimaryClipChangedListener

public ClipData getPrimaryClip ()

Added in API level 11

Returns the current primary clip on the clipboard.

Returns
ClipData

public ClipDescription getPrimaryClipDescription ()

Added in API level 11

Returns a description of the current primary clip on the clipboard but not a copy of its data.

Returns
ClipDescription

public CharSequence getText ()

Added in API level 11

This method was deprecated in API level 11.
Use getPrimaryClip() instead. This retrieves the primary clip and tries to coerce it to a string.

Returns the text on the clipboard. It will eventually be possible to store types other than text too, in which case this will return null if the type cannot be coerced to text.

Returns
CharSequence

public boolean hasPrimaryClip ()

Added in API level 11

Returns true if there is currently a primary clip on the clipboard.

Returns
boolean

public boolean hasText ()

Added in API level 11

This method was deprecated in API level 11.
Use hasPrimaryClip() instead.

Returns true if the clipboard contains text; false otherwise.

Returns
boolean

public void removePrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)

Added in API level 11

Parameters
what ClipboardManager.OnPrimaryClipChangedListener

public void setPrimaryClip (ClipData clip)

Added in API level 11

Sets the current primary clip on the clipboard. This is the clip that is involved in normal cut and paste operations.

Parameters
clip ClipData: The clipped data item to set.

public void setText (CharSequence text)

Added in API level 11

This method was deprecated in API level 11.
Use setPrimaryClip(ClipData) instead. This creates a ClippedItem holding the given text and sets it as the primary clip. It has no label or icon.

Sets the contents of the clipboard to the specified text.

Parameters
text CharSequence