Window系统一样,Android也有剪切板。Android提供了一个强大的剪切板框架,SDK API 11 之后框架主要涉及到ClipboardManager、ClipData 和 ClipData.Item这三个类。
- ClipboardManager: 表示一个剪贴板
- ClipData: 剪贴板中保存的所有剪贴数据集(剪贴板可同时复制/保存多条多种数据条目)
- ClipData.Item: 剪贴数据集中的一个数据条目
1. 主要API介绍
(1) 获取剪贴板管理器
ClipboardManager cm = (ClipboardManager)getSystemService(Context.CLIPBOARD_SERVICE);
(2) 创建能够存入剪贴板的ClipData对象
说明: 早期版本的Android剪切板只能复制文本(可以为复合文本)信息。在API 11后对ClipboardManager进行了升级,可以通过 ClipData 来复制文本(普通字符型)、Uri (URL 型)和 Intent(Intent 型)三种数据。
- 普通字符:就是普通字符串的剪切,复制,粘贴。
- URL:在复制的时候可以复制一个URL,这个URL可以是请求ContentProvider的URL,在粘贴的时候调用ContntProvider获取数据,并使用。
- Intent:如在记事本应用中长按某一个记录本条目,这时会创建删除这个记事本的Intent,并添加到剪贴板,当用户将这个记事本条目拖到垃圾桶松开时,应用会从剪贴板中获取Intent并执行,这个记事本条目就被删除了。
- 创建普通字符型ClipData:将一个字符串放到剪贴板上
ClipData clipData = ClipData.newPlainText(null, "需要copy的信息");
- 创建URL型ClipData:将一个URL放到剪贴板上
ClipData clipData = ClipData.newRawUri(null,Uri.parse("http://www.baidu.com"));
- 创建Intent型ClipData:将一个intent放到剪贴板上
ClipData clipData = ClipData.newIntent(null, intent);
存Intent:
//将一个intent放到剪贴板上
Intent intent = new Intent();
intent.setClass(this,HomeActivity.class);
ClipData clipData = ClipData.newIntent("Home",intent);
cm.setPrimaryClip(clipData );
取Intent:
ClipData clipData = cm.getPrimaryClip();
ClipData.Item item = clipData.getItemAt(0);
if(item.getIntent()!=null) {//剪贴板里是否为Intent对象
startActivity(item.getIntent());
}else {
Intent intent1 = new Intent();
intent1.setClass(this,PasteActivity.class);//跳到文字接收页面
startActivity(intent1);
}
注意:ClipData对象可包含一个或多个ClipData.Item对象。上面三种方法只在ClipData对象中创建了一个ClipData.Item对象;如果想向ClipData对象中添加多个Item,可通过ClipData对象的addItem()方法来添加。
(3) 将ClipData数据复制到剪贴板
cm.setPrimaryClip(clipData);
(4) 从剪贴板中获取ClipData数据
ClipData clipData = cm.getPrimaryClip();
String content = clipData.getItemAt(i).getText().toString();
注意:在API 11版本之后,原来利用剪切板传递数据使用的setText()和getText()方法被弃用了,只能使用ClipData对象来代替。
2. 剪贴板的主要操作
- 复制:复制信息到粘贴板
private void copyContentToClip(String content){
ClipboardManager cm = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);// 获取系统剪贴板
ClipData clipData = ClipData.newPlainText(null,content);// 创建一个剪贴数据集:通过ClipData可创建普通字符型、Uri型和Intent型
cm.setPrimaryClip(clipData);// 将ClipData数据复制到剪贴板
}
- 粘贴:从粘贴板获取信息
private void getClipContent(){
ClipboardManager cm = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);// 获取系统剪贴板
ClipData clipData = cm.getPrimaryClip();// 从剪贴板中获取ClipData数据
String content = clipData.getItemAt(0).getText().toString();// 从数据集中获取(粘贴)文本数据
Log.v("获取剪贴板文本",content);
}
- 监听粘贴板数据变化
ClipboardManager cm = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);// 获取系统剪贴板
cm.addPrimaryClipChangedListener(new ClipboardManager.OnPrimaryClipChangedListener() {
@Override
public void onPrimaryClipChanged() {
Log.v("ClipboardManager","监听到粘贴板数据改变");
}
});
- 清空粘贴板
private void clearClipboard() {
ClipboardManager cm = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);// 获取系统剪贴板
if (cm != null) {
try {
cm.setPrimaryClip(ClipData.newPlainText(null, ""));
} catch (Exception e) {
Log.e("异常",e.getMessage());
}
}
}
示例代码:
(1) ClipboardActivity.java
package comi.example.liy.mytestdemo;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.View;
import android.widget.Button;
/**
* Created by liy on 2019-12-19 16:09
*/
public class ClipboardActivity extends AppCompatActivity implements View.OnClickListener {
private ClipboardManager cm;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_clipboard);
Button btnCopy = findViewById(R.id.clip_copy);
Button btnPaste = findViewById(R.id.clip_paste);
Button btnClear = findViewById(R.id.clip_clear);
btnCopy.setOnClickListener(this);
btnPaste.setOnClickListener(this);
btnClear.setOnClickListener(this);
cm = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);// 获取系统剪贴板
cm.addPrimaryClipChangedListener(new ClipboardManager.OnPrimaryClipChangedListener() {
@Override
public void onPrimaryClipChanged() {
Log.v("ClipboardManager","监听到粘贴板数据改变");
}
});
}
/**
* 粘贴板(复制):实现文本复制功能
*/
private void copyContentToClip(String content){
ClipData clipData = ClipData.newPlainText(null,content);// 创建一个剪贴数据集:通过ClipData可创建普通字符型、Uri型和Intent型
for (int i = 0; i < 10; i++){
ClipData.Item item = new ClipData.Item("文本" + (i+1));//ClipData对象中包含一个或多个ClipData.Item对象
clipData.addItem(item);//添加多个Item
}
cm.setPrimaryClip(clipData);// 将ClipData数据复制到剪贴板
}
/**
* 粘贴板(粘贴):获取系统剪贴板内容
*/
private void getClipContent(){
ClipData clipData = cm.getPrimaryClip();// 从剪贴板中获取ClipData数据
if (clipData != null && clipData.getItemCount() > 0) {
for (int i = 0; i < clipData.getItemCount(); i++){
String content = clipData.getItemAt(i).getText().toString();// 从数据集中获取(粘贴)文本数据
Log.v("获取剪贴板第" + (i) + "条文本数据",content);
}
}
}
/**
* 清空剪贴板内容
*/
private void clearClipboard() {
if (cm != null) {
try {
cm.setPrimaryClip(ClipData.newPlainText(null, ""));
} catch (Exception e) {
Log.e("异常",e.getMessage());
}
}
}
@Override
public void onClick(View v) {
switch (v.getId()){
case R.id.clip_copy:
copyContentToClip("需被复制到粘贴板的文本");
break;
case R.id.clip_paste:
getClipContent();
break;
case R.id.clip_clear:
clearClipboard();
break;
default:
break;
}
}
@Override
protected void onDestroy() {
super.onDestroy();
// 移除监听器
//cm.removePrimaryClipChangedListener();
}
}
(2) activity_clipboard.xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<Button
android:id="@+id/clip_copy"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="设置粘贴板内容"/>
<Button
android:id="@+id/clip_paste"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="获取粘贴板内容"/>
<Button
android:id="@+id/clip_clear"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="清空粘贴板内容"/>
</LinearLayout>
3. 剪贴板的简单应用示例
(1) 实现应用内的数据共享(应用内传递数据)
在Android开发中我们经常要遇到的一个问题就是数据在不同的Activity之间的共享。在Android开发中有很多种方法可以达到这个目地。这里介绍一种比较常见、又常用的一种方法就是使用剪切板来实现Activity间的数据传递,关键在于将数据复制到粘贴板和从粘贴板中取出数据。
- 存数据:Activity1 把数据复制到剪切板
String content = "需要copy的信息";
ClipboarManager cm =(ClipboarManager)getSystemService(Context.CLIPBOARD_SERVICE);
ClipData mClipData = ClipData.newPlainText(null, content);
cm.setPrimaryClip(mClipData);
- 取数据:Activity2 从粘贴板中取出数据
ClipboarManager clipboarManager=(ClipboarManager)getSystemService(Context.CLIPBOARD_SERVICE);
String content = clipData.getItemAt(0).getText().toString();
(2) 实现应用间的数据共享(应用内传递数据)
原理:Android所用应用公用一个粘贴板,在其他应用中复制文字,就是将复制的信息放到了系统粘贴板,所以我们可以在自己的应用内直接读取系统粘贴板上的信息。
如:复制百度或短信应用中的一段文字,然后打开PasteActivity页面,就能得到的你复制的内容。
- PasteActivity.java
package comi.example.liy.mytestdemo;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.TextView;
/**
* Created by liy on 2019-12-20 13:59
*/
public class PasteActivity extends AppCompatActivity{
private TextView tvContent;
private ClipboardManager mClipboardManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_paste);
tvContent = (TextView)findViewById(R.id.tv_content);
mClipboardManager = (ClipboardManager)getSystemService(CLIPBOARD_SERVICE);
getClipContent();
}
/**
* 获取粘贴板上存放的内容并显示
*/
private void getClipContent() {
if(mClipboardManager.hasPrimaryClip()) {//判断当前剪贴板上存在Copy
//获取粘贴板上存放的内容
ClipData mClipData = mClipboardManager.getPrimaryClip();
ClipData.Item item = mClipData.getItemAt(0);
String content = item.getText().toString();
//将剪贴板上的文字信息取出来放到文本框中
tvContent.setText(content);
}
}
}
- activity_paste.java
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="horizontal">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="粘贴板上存放的内容为:"/>
<TextView
android:id="@+id/tv_content"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:textColor="#FF0000"/>
</LinearLayout>
拓展:淘宝宝贝分享到微信,在微信中复制链接(将一个URL放到剪贴板上),然后打开淘宝可跳转到该宝贝(从粘贴板上读取URL),该业务逻辑的实现可能就是使用了剪贴板来实现应用间的数据共享。尚未深入研究,这里仅做猜想,如猜想有误,还请多多指教。
(3) 实现自由复制TextView等控件的文字
只需在该控件上加上
android:textIsSelectable="true"
,或者在java代码加setTextIsSelectable(true)
即可实现。
- PasteActivity.java
package comi.example.liy.mytestdemo;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
/**
* Created by liy on 2019-12-20 13:59
*/
public class PasteActivity extends AppCompatActivity implements View.OnClickListener {
private Button btnGetContent;
private TextView tvContent;
private ClipboardManager mClipboardManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_paste);
initViews();
mClipboardManager = (ClipboardManager)getSystemService(CLIPBOARD_SERVICE);
}
private void initViews(){
/*TextView tvCopy = findViewById(R.id.tv_copy);
tvCopy.setTextIsSelectable(true);//设置文本可被选中进行复制*/
btnGetContent = findViewById(R.id.get_content);
btnGetContent.setOnClickListener(this);
tvContent = (TextView)findViewById(R.id.tv_content);
}
@Override
public void onClick(View v) {
switch (v.getId()){
case R.id.get_content:
getClipContent();
break;
default:
break;
}
}
/**
* 获取粘贴板上存放的内容并显示
*/
private void getClipContent() {
if(mClipboardManager.hasPrimaryClip()) {//判断当前剪贴板上存在Copy
//获取粘贴板上存放的内容
ClipData mClipData = mClipboardManager.getPrimaryClip();
ClipData.Item item = mClipData.getItemAt(0);
String content = item.getText().toString();
//将剪贴板上的文字信息取出来放到文本框中
tvContent.setText(content);
}
}
}
- activity_paste.xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
android:layout_margin="10dp">
<TextView
android:id="@+id/tv_copy"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="可以复制我哦"
android:textSize="30sp"
android:textIsSelectable="true"/>
<Button
android:id="@+id/get_content"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="点击获取粘贴板内容"
android:layout_marginTop="20dp"
android:layout_marginBottom="20dp"/>
<TextView
android:id="@+id/tv_content"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:textColor="#FF0000"/>
</LinearLayout>