آموزش Clipboard در اندروید - کپی و پیست کردن

اندروید فریم ورک کلیپبورد را برای کپی و پیست کردن انواع مختلف داده ارائه می دهد. داده می تواند متن (text) ، تصویر (images) ، داده های دوتایی (binary stream data) و یا انواع داده های پیچیده ی دیگر باشد.

اندروید کتابخانه ی ClipboardManager و ClipData و ClipData.item را برای استفاده از فریمورک کپی و پیست ارائه می دهد. برای استفاده از این آبجکت لازم است داده (data ) را در یک clip object قرار داده و سپس آن آبجکت را در سیستم کلیپبورد جامع (system wide clipboard) قرار دهید.

برای به کار گیری کلیپبورد لازم است که یک آبجکت از ClipboardManager را با فراخوانی متد ()getSystemService به عنوان نمونه بیاورید. سینتکس آن در زیر ارائه شده است :

ClipboardManager myClipboard;
myClipboard = (ClipboardManager)getSystemService(CLIPBOARD_SERVICE);

کپی کردن داده ها :

کار بعدی که لازم است انجام دهید آوردن  آبجکت ClipData با فراخوانی نوع مربوط به متد داده از گروه ClipData می باشد. در مورد داده ی متن ، روش newPlainText فراخوانده خواهد شد. پس از آن باید داده را به عنوان قطعه ای (clip ) از آبجکت Clipbaoard Manager قرار دهید. سینتکس آن مانند زیر می باشد :

ClipData myClip;
String text = "hello world";
myClip = ClipData.newPlainText("text", text);
myClipboard.setPrimaryClip(myClip);

آبجکت ClipData می تواند این سه شکل را به خود بگیرد و توابع زیر برای ایجاد این اشکال استفاده می شوند :

(Text newPlainText(label, text : یک آبجکت ClipData را (که single ClipData می باشد) بازمی گرداند. این آبجکت دارای یک آیتم با محتوای  رشته متن می باشد.

(URI newUri(resolver, label, URI : یک آبجکت ClipData را ( که single ClipData می باشد) بازمی گرداند.یکی از آیتم های آبجکت  URI می باشد.

(Intent newIntent(label, intent : یک آبجکت ClipData را ( که single ClipData می باشد) بازمی گرداند. این آبجکت دارای یک آیتم Intent می باشد.

پیست کردن داده (Pasting Data):

برای پیست کردن داده، ابتدا قطعه را با فراخوانی متد ()getPrimaryClip به دست می آوریم. بعد از آن ، آیتم در آبجکت ClipData.Item خواهد گرفت.  سینتکس آن مانند زیر می باشد :

ClipData abc = myClipboard.getPrimaryClip();
ClipData.Item item = abc.getItemAt(0);
String text = item.getText().toString();

علاوه براین متد ها، متد های دیگری وجود دارند که توسط کلاس ClipboardManager برای مدیریت فریک ورک کلیپبورد ارائه می شوند. این متد ها در زیر ارائه شده اند :

()getPrimaryClip : این متد کلیپ اولیه ی (primary clip) موجود را روی کلیپبورد باز می گرداند.

()getPrimaryClipDescription : این متد توصیفی از کلیپ اولیه (نه یک کپی از داده ی آن) را روی کلیپبورد باز می گرداند.

()hasPrimaryClip : اگر روی کلیپبورد کلیپ اولیه (primary clip) وجود داشته باشد، این متد true را باز می گرداند.

(setPrimaryClip(ClipData clip : این متد کلیپ اولیه (primary clip) را روی کلیپ بورد تنظیم می کند.

(setText(CharSequence text : این متد می تواند مستقیما برای کپی متن روی کلیپ بورد استفاده شود.

()getText : این متد می تواند مستقیما برای گرفتن متن کپی شده از کلیپ بورد استفاده شود.

مثال :

در اینجا مثالی را میبینید که نحوه ی استفاده از ClipboardManager را توضیح می دهد.
این مثال یک برنامه ی کپی پیست پایه ایجاد می کند که به شما اجازه می دهد تا متن را کپی کرده و سپس از طریق کلیپبورد آن را پیست کنید.برای آزمایش با این مثال می توانید آن را روی یک دستگاه واقعی یا یک امولاتور اجرا کنید.

1) برای ایجاد یک اپلیکیشن  اندروید از Android studio IDE  تحت پکیج com.example.sairamkrishna.myapplication استفاده خواهید کرد 

2) فایل src/MainActivity.java را برای افزودن کد لازم تغییر دهید.

3) res/layout/activity_main را برای افزودن مولفه های XML مربوطه تغییر دهید.

4) برنامه را اجرا کرده و یک دستگاه اجرایی اندروید انتخاب کنید و برنامه را روی آن نصب کرده و نتیجه را بررسی کنید.

محتوای فایل اکتیویتی اصلی src/MainActivity.java :

package com.example.sairamkrishna.myapplication;

import android.content.ClipData;
import android.content.ClipboardManager;
import android.os.Bundle;

import android.support.v7.app.ActionBarActivity;
import android.view.View;

import android.widget.Button;
import android.widget.EditText;
import android.widget.Toast;


public class MainActivity extends ActionBarActivity {
   EditText ed1, ed2;
   Button b1, b2;

   private ClipboardManager myClipboard;
   private ClipData myClip;

   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);

      ed1 = (EditText) findViewById(R.id.editText);
      ed2 = (EditText) findViewById(R.id.editText2);

      b1 = (Button) findViewById(R.id.button);
      b2 = (Button) findViewById(R.id.button2);

      myClipboard = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);

      b1.setOnClickListener(new View.OnClickListener() {
         
         @Override
         public void onClick(View v) {
            String text;
            text = ed1.getText().toString();

            myClip = ClipData.newPlainText("text", text);
            myClipboard.setPrimaryClip(myClip);

            Toast.makeText(getApplicationContext(), "Text Copied", 
               Toast.LENGTH_SHORT).show();
         }
      });

      b2.setOnClickListener(new View.OnClickListener() {
         
         @Override
         public void onClick(View v) {
            ClipData abc = myClipboard.getPrimaryClip();
            ClipData.Item item = abc.getItemAt(0);

            String text = item.getText().toString();
            ed2.setText(text);

            Toast.makeText(getApplicationContext(), "Text Pasted", 
               Toast.LENGTH_SHORT).show();
         }
      });
   }

}

محتوای فایل res/layout/activity_main.xml :

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout 
   xmlns:android="http://schemas.android.com/apk/res/android"
   xmlns:tools="http://schemas.android.com/tools" 
   android:layout_width="match_parent"
   android:layout_height="match_parent" 
   android:paddingLeft="@dimen/activity_horizontal_margin"
   android:paddingRight="@dimen/activity_horizontal_margin"
   android:paddingTop="@dimen/activity_vertical_margin"
   android:paddingBottom="@dimen/activity_vertical_margin" 
   tools:context=".MainActivity">
   
   <TextView android:text="Example" android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:id="@+id/textview"
      android:textSize="35dp"
      android:layout_alignParentTop="true"
      android:layout_centerHorizontal="true" />
      
   <TextView
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="Tutorials point"
      android:id="@+id/textView"
      android:layout_below="@+id/textview"
      android:layout_centerHorizontal="true"
      android:textColor="#ff7aff24"
      android:textSize="35dp" />
      
   <ImageView
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:id="@+id/imageView"
      android:src="@drawable/abc"
      android:layout_below="@+id/textView"
      android:layout_centerHorizontal="true" />
      
   <EditText
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:id="@+id/editText"
      android:layout_alignParentRight="true"
      android:layout_alignParentEnd="true"
      android:hint="Copy text"
      android:layout_below="@+id/imageView"
      android:layout_alignLeft="@+id/imageView"
      android:layout_alignStart="@+id/imageView" />
      
   <EditText
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:id="@+id/editText2"
      android:layout_alignLeft="@+id/editText"
      android:layout_alignStart="@+id/editText"
      android:hint="paste text"
      android:layout_below="@+id/editText"
      android:layout_alignRight="@+id/editText"
      android:layout_alignEnd="@+id/editText" />
      
   <Button
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="Copy text"
      android:id="@+id/button"
      android:layout_below="@+id/editText2"
      android:layout_alignLeft="@+id/editText2"
      android:layout_alignStart="@+id/editText2" />
      
   <Button
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="Paste text"
      android:id="@+id/button2"
      android:layout_below="@+id/editText2"
      android:layout_alignRight="@+id/editText2"
      android:layout_alignEnd="@+id/editText2" />
      
</RelativeLayout>

محتوای res/values/string.xml. :

<resources>
   <string name="app_name">My Application</string>
</resources>

محتوای AndroidManifest.xml :

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="com.example.sairamkrishna.myapplication" >

   <application
      android:allowBackup="true"
      android:icon="@drawable/ic_launcher"
      android:label="@string/app_name"
      android:theme="@style/AppTheme" >
      
      <activity
         android:name="com.example.sairamkrishna.myapplication.MainActivity"
         android:label="@string/app_name" >
         
         <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <category android:name="android.intent.category.LAUNCHER" />
         </intent-filter>
      
      </activity>
   </application>

</manifest>

اجازه بدهید برنامه را اجرا کنیم. فرض می کنیم که شما AVD خود را در هنگام انجام تنظیمات محیط ایجاد کرده اید. برای اجرای برنامه از Android studio ، یکی از فایل های اکتیویتی پروژه را باز کرده و روی آیکون Run از نوار ابزار (تولبار) کلیک کنید. Android studio برنامه را روی AVD شما نصب می کند و آن را شروع می کند و اگر همه چیز در رابطه با تنظیمات و برنامه ی شما درست باشد، پنجره ی Emulator زیر را نمایش خواهد داد.