# Print output for @column tags ?>
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.
For more information about using the clipboard framework, read the Copy and Paste developer guide.
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 is deprecated.
Use |
boolean
|
hasPrimaryClip()
Returns true if there is currently a primary clip on the clipboard. |
boolean
|
hasText()
This method is deprecated.
Use |
void
|
removePrimaryClipChangedListener(ClipboardManager.OnPrimaryClipChangedListener what)
|
void
|
setPrimaryClip(ClipData clip)
Sets the current primary clip on the clipboard. |
void
|
setText(CharSequence text)
This method is deprecated.
Use |
Inherited methods | |
---|---|
public void addPrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)
Parameters | |
---|---|
what |
ClipboardManager.OnPrimaryClipChangedListener |
public void clearPrimaryClip ()
Clears any current primary clip on the clipboard.
See also:
public ClipData getPrimaryClip ()
Returns the current primary clip on the clipboard.
If the application is not the default IME or does not have input focus this return
null
.
Returns | |
---|---|
ClipData |
See also:
public ClipDescription getPrimaryClipDescription ()
Returns a description of the current primary clip on the clipboard
but not a copy of its data.
If the application is not the default IME or does not have input focus this return
null
.
Returns | |
---|---|
ClipDescription |
See also:
public CharSequence getText ()
This method is deprecated.
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 ()
Returns true if there is currently a primary clip on the clipboard.
If the application is not the default IME or the does not have input focus this will
return false
.
Returns | |
---|---|
boolean |
public boolean hasText ()
This method is deprecated.
Use hasPrimaryClip()
instead.
Returns true if the clipboard contains text; false otherwise.
Returns | |
---|---|
boolean |
public void removePrimaryClipChangedListener (ClipboardManager.OnPrimaryClipChangedListener what)
Parameters | |
---|---|
what |
ClipboardManager.OnPrimaryClipChangedListener |
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 cannot be null . |
See also:
public void setText (CharSequence text)
This method is deprecated.
Use setPrimaryClip(android.content.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 |