このページは Cloud Translation API によって翻訳されました。

ドラッグ＆ドロップ

Jetpack Compose は、次の 2 つの修飾子によるドラッグ＆ドロップをサポートしています。

dragAndDropSource: ドラッグジェスチャーの開始点としてコンポーザブルを指定します。
dragAndDropTarget: ドロップされたデータを受け入れるコンポーザブルを指定します。

たとえば、ユーザーがアプリ内で画像をドラッグできるようにするには、画像コンポーザブルを作成し、dragAndDropSource 修飾子を追加します。ドロップターゲットを設定するには、別の画像コンポーザブルを作成し、dragAndDropTarget 修飾子を追加します。

修飾子は、複数のドラッグソースと複数のドロップターゲットに適用できます。

修飾子を使用すると、アプリは ClipData を使用して 2 つ以上のコンポーザブル間でデータを共有できます。これは View 実装と相互運用可能です。

ドラッグソースを指定する

コンポーネント内のドラッグイベントを有効にするには、dragAndDropSource 修飾子を追加します。これは、関数をパラメータとして受け取ります。この関数内で、DragAndDropTransferData を使用して転送可能なデータを表します。データには、リモート URI、クリップボード上のリッチテキストデータ、ローカルファイルなどがありますが、すべて ClipData オブジェクトでラップする必要があります。次のように書式なしテキストを指定します。

Modifier.dragAndDropSource { _ ->
    DragAndDropTransferData(
        ClipData.newPlainText(
            "image Url", url
        )
    )
}DragAndDropSnippets.kt

ドラッグアクションでアプリの境界を越えることができるようにするには、DragAndDropTransferData コンストラクタで flags 引数を受け取るようにします。次の例では、DRAG_FLAG_GLOBAL 定数で、データをあるアプリから別のアプリにドラッグできることを指定しています。

Modifier.dragAndDropSource { _ ->
    DragAndDropTransferData(
        ClipData.newPlainText(
            "image Url", url
        ),
        flags = View.DRAG_FLAG_GLOBAL
    )
}DragAndDropSnippets.kt

DragAndDropTransferData は、Android ビューシステムでサポートされているフラグを受け入れます。使用可能なフラグの一覧については、View 定数のリストをご覧ください。

ドロップデータを受信する

コンポーザブルに dragAndDropTarget 修飾子を割り当てることで、コンポーザブルがドラッグ＆ドロップイベントを受信できるようにします。修飾子には 2 つのパラメータがあります。1 つ目はフィルタとして機能し、修飾子が受け入れることができるデータの種類を指定します。2 つ目は、コールバックでデータを配信します。

コールバックインスタンスは保持する必要があります。次のスニペットは、コールバックを記憶する方法を示しています。

val callback = remember {
    object : DragAndDropTarget {
        override fun onDrop(event: DragAndDropEvent): Boolean {
            // Parse received data
            return true
        }
    }
}DragAndDropSnippets.kt

他のアプリからデータを受信するには、requestDragAndDropPermission を使用して受信を有効にし、完了したら解放します。

val externalAppCallback = remember {
    object : DragAndDropTarget {
        override fun onDrop(event: DragAndDropEvent): Boolean {
            val permission =
                activity.requestDragAndDropPermissions(event.toAndroidDragEvent())
            // Parse received data
            permission?.release()
            return true
        }
    }
}DragAndDropSnippets.kt

Compose コールバックから返される DragAndDropEvent は、requestDragAndDropPermission メソッドで想定される DragAndDropEvent とは異なるため、権限リクエストに渡す前に、パラメータで toAndroidDragEvent() 拡張関数を呼び出す必要があります。

次のスニペットは、ドロップされたプレーンテキストを処理する方法を示しています。

Modifier.dragAndDropTarget(
    shouldStartDragAndDrop = { event ->
        event.mimeTypes().contains(ClipDescription.MIMETYPE_TEXT_PLAIN)
    }, target = callback // or externalAppCallback
)DragAndDropSnippets.kt

コールバック関数は、イベントが消費された場合は true を返し、イベントが拒否され親コンポーネントに伝播されない場合は false を返す必要があります。