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.

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.

Instances of this class must be obtained using Context.getSystemService(Class) with the argument ClipboardManager.class or Context.getSystemService(String) with the argument Context.CLIPBOARD_SERVICE.

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)
void clearPrimaryClip()

Clears any current primary clip on the clipboard.

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

Public methods

addPrimaryClipChangedListener

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

Parameters
what ClipboardManager.OnPrimaryClipChangedListener

clearPrimaryClip

added in API level 28
public void clearPrimaryClip ()

Clears any current primary clip on the clipboard.

getPrimaryClip

added in API level 11
public ClipData getPrimaryClip ()

Returns the current primary clip on the clipboard.

Returns
ClipData

This value may be null.

getPrimaryClipDescription

added in API level 11
public ClipDescription getPrimaryClipDescription ()

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

Returns
ClipDescription

This value may be null.

getText

added in API level 11
public 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
public boolean hasPrimaryClip ()

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

Returns
boolean

hasText

added in API level 11
public 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
public void removePrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)

Parameters
what ClipboardManager.OnPrimaryClipChangedListener

setPrimaryClip

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

This value must never be null.

setText

added in API level 11
public 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