Skip to content

Most visited

Recently visited

navigation

ClipboardManager

public class ClipboardManager
extends ClipboardManager

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


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.

See also:

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.

Inherited methods

From class android.text.ClipboardManager
From class java.lang.Object

Public methods

addPrimaryClipChangedListener

Added in API level 11
void addPrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)

Parameters
what ClipboardManager.OnPrimaryClipChangedListener

getPrimaryClip

Added in API level 11
ClipData getPrimaryClip ()

Returns the current primary clip on the clipboard.

Returns
ClipData

getPrimaryClipDescription

Added in API level 11
ClipDescription getPrimaryClipDescription ()

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

Returns
ClipDescription

getText

Added in API level 11
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.

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

hasPrimaryClip

Added in API level 11
boolean hasPrimaryClip ()

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

Returns
boolean

hasText

Added in API level 11
boolean hasText ()

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

Returns true if the clipboard contains text; false otherwise.

Returns
boolean

removePrimaryClipChangedListener

Added in API level 11
void removePrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)

Parameters
what ClipboardManager.OnPrimaryClipChangedListener

setPrimaryClip

Added in API level 11
void setPrimaryClip (ClipData clip)

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.

setText

Added in API level 11
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.

Sets the contents of the clipboard to the specified text.

Parameters
text CharSequence
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.

Take a one-minute survey?
Help us improve Android tools and documentation.