added in API level 11

Summary: Nested Classes | Methods | Inherited Methods | [Expand All]

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:

getSystemService(Class)

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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this 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`

Most visited

Recently visited

Results for

ClipboardManager

Developer Guides

Summary

Nested classes

Public methods

Inherited methods

Public methods

addPrimaryClipChangedListener

getPrimaryClip

getPrimaryClipDescription

getText

hasPrimaryClip

hasText

removePrimaryClipChangedListener

setPrimaryClip

setText

Interfaces

Classes

Exceptions