マルチ ウィンドウ モードでのドラッグ&ドロップ

Android 7.0（API レベル 24）以降を搭載したデバイスは、マルチウィンドウ モードをサポートしています。マルチウィンドウ モードでは、ユーザーはドラッグ&ドロップでアプリ間でデータを移動できます。

オペレーションが開始されるソースアプリがデータを提供します。オペレーションが終了したターゲット アプリがデータを受け取ります。

ユーザーがコンテンツのドラッグを開始したら、ソースアプリで DRAG_FLAG_GLOBAL フラグを設定して、ユーザーがデータを別のアプリにドラッグできることを示す必要があります。

データはアプリの境界を越えて移動するため、アプリはコンテンツ URI を使用してデータへのアクセスを共有します。これには、以下が必要です。

  • ソースアプリは、ターゲット アプリに付与するデータに対する読み取りまたは書き込みのアクセス権に応じて、DRAG_FLAG_GLOBAL_URI_READ フラグと DRAG_FLAG_GLOBAL_URI_WRITE フラグのいずれかまたは両方を設定する必要があります。
  • ターゲット アプリは、ユーザーがアプリにドラッグしたデータを処理する直前に requestDragAndDropPermissions() を呼び出す必要があります。ターゲット アプリがドラッグされたデータにアクセスする必要がなくなった場合、アプリは requestDragAndDropPermissions() から返されたオブジェクトの release() を呼び出すことができます。それ以外の場合、権限を含むアクティビティが破棄されると、権限が解放されます。 実装において、ドロップされた URI を処理するために新しいアクティビティを開始する場合は、新しいアクティビティに同じ権限を付与する必要があります。クリップデータとフラグを設定する必要があります。

    Kotlin

    intent.setClipData(clipData)
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION)

    Java

    intent.setClipData(clipData);
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

次のコード スニペットは、ユーザーがドロップ オペレーションを行った直後に、ドラッグされたデータへの読み取り専用アクセス権を解放する方法を示しています。より詳細な例については、GitHub のドラッグ&ドロップのサンプルをご覧ください。

ソース アクティビティ

Kotlin

// Drag a file stored in an images/ directory in internal storage.
val internalImagesDir = File(context.filesDir, "images")
val imageFile = File(internalImagesDir, imageFilename)
val uri = FileProvider.getUriForFile(context, contentAuthority, imageFile)

val listener = OnDragStartListener@{ view: View, _: DragStartHelper ->
    val clipData = ClipData(ClipDescription("Image Description",
                                            arrayOf("image/*")),
                            ClipData.Item(uri))
    // Must include DRAG_FLAG_GLOBAL to permit dragging data between apps.
    // This example provides read-only access to the data.
    val flags = View.DRAG_FLAG_GLOBAL or View.DRAG_FLAG_GLOBAL_URI_READ
    return@OnDragStartListener view.startDragAndDrop(clipData,
                                                     View.DragShadowBuilder(view),
                                                     null,
                                                     flags)
}

// Container where the image originally appears in the source app.
val srcImageView = findViewById<ImageView>(R.id.imageView)

// Detect and start the drag event.
DragStartHelper(srcImageView, listener).apply {
    attach()
}

Java

// Drag a file stored in an images/ directory in internal storage.
File internalImagesDir = new File(context.getFilesDir(), "images");
File imageFile = new File(internalImagesDir, imageFilename);
final Uri uri = FileProvider.getUriForFile(context, contentAuthority, imageFile);

// Container where the image originally appears in the source app.
ImageView srcImageView = findViewById(R.id.imageView);

// Enable the view to detect and start the drag event.
new DragStartHelper(srcImageView, (view, helper) -> {
    ClipData clipData = new ClipData(new ClipDescription("Image Description",
                                                          new String[] {"image/*"}),
                                     new ClipData.Item(uri));
    // Must include DRAG_FLAG_GLOBAL to permit dragging data between apps.
    // This example provides read-only access to the data.
    int flags = View.DRAG_FLAG_GLOBAL | View.DRAG_FLAG_GLOBAL_URI_READ;
    return view.startDragAndDrop(clipData,
                                 new View.DragShadowBuilder(view),
                                 null,
                                 flags);
}).attach();

ターゲット アクティビティ

Kotlin

// Container where the image is to be dropped in the target app.
val targetImageView = findViewById<ImageView>(R.id.imageView)

targetImageView.setOnDragListener { view, event ->

    when (event.action) {

        ACTION_DROP -> {
            val imageItem: ClipData.Item = event.clipData.getItemAt(0)
            val uri = imageItem.uri

            // Request permission to access the image data being dragged into
            // the target activity's ImageView element.
            val dropPermissions = requestDragAndDropPermissions(event)
            (view as ImageView).setImageURI(uri)

            // Release the permission immediately afterward because it's no
            // longer needed.
            dropPermissions.release()
            return@setOnDragListener true
        }

        // Implement logic for other DragEvent cases here.

        // An unknown action type is received.
        else -> {
            Log.e("DragDrop Example", "Unknown action type received by View.OnDragListener.")
            return@setOnDragListener false
        }

    }
}

Java

// Container where the image is to be dropped in the target app.
ImageView targetImageView = findViewById(R.id.imageView);

targetImageView.setOnDragListener( (view, event) -> {

    switch (event.getAction()) {

        case ACTION_DROP:
            ClipData.Item imageItem = event.getClipData().getItemAt(0);
            Uri uri = imageItem.getUri();

            // Request permission to access the image data being dragged into
            // the target activity's ImageView element.
            DragAndDropPermissions dropPermissions =
                requestDragAndDropPermissions(event);

            ((ImageView)view).setImageURI(uri);

            // Release the permission immediately afterward because it's no
            // longer needed.
            dropPermissions.release();

            return true;

        // Implement logic for other DragEvent cases here.

        // An unknown action type was received.
        default:
            Log.e("DragDrop Example","Unknown action type received by View.OnDragListener.");
            break;
    }

    return false;
});