ビューでドラッグ&ドロップを実装する

イベントに応答することで、ビューでドラッグ&ドロップ プロセスを実装できる ドラッグ開始イベント、応答イベント、消費ドロップ イベントをトリガーする可能性がある関数です。

ドラッグを開始する

ユーザーは、通常タップまたはクリックによりドラッグを開始します。 ドラッグするアイテムを長押しします。

View でこれを処理するには、 ClipData オブジェクトと 次の ClipData.Item オブジェクト: 自動的に移動しますClipData の一部として、次のメタデータを指定します。 保存される ClipDescription オブジェクト ClipData 内。ドラッグ&ドロップ オペレーションが、 データの移動には、実際のオブジェクトの代わりに null を使用することをおすすめします。

例として、次のコード スニペットは、ImageView のタグ（ラベル）を含む ClipData オブジェクトを作成することで、ImageView 上での長押しジェスチャーに対応する方法を示しています。

Kotlin

// Create a string for the ImageView label.
val IMAGEVIEW_TAG = "icon bitmap"
...
val imageView = ImageView(context).apply {
    // Set the bitmap for the ImageView from an icon bitmap defined elsewhere.
    setImageBitmap(iconBitmap)
    tag = IMAGEVIEW_TAG
    setOnLongClickListener { v ->
        // Create a new ClipData. This is done in two steps to provide
        // clarity. The convenience method ClipData.newPlainText() can
        // create a plain text ClipData in one step.

        // Create a new ClipData.Item from the ImageView object's tag.
        val item = ClipData.Item(v.tag as? CharSequence)

        // Create a new ClipData using the tag as a label, the plain text
        // MIME type, and the already-created item. This creates a new
        // ClipDescription object within the ClipData and sets its MIME type
        // to "text/plain".
        val dragData = ClipData(
            v.tag as? CharSequence,
            arrayOf(ClipDescription.MIMETYPE_TEXT_PLAIN),
            item)

        // Instantiate the drag shadow builder. We use this imageView object
        // to create the default builder.
        val myShadow = View.DragShadowBuilder(view: this)

        // Start the drag.
        v.startDragAndDrop(dragData,  // The data to be dragged.
                            myShadow,  // The drag shadow builder.
                            null,      // No need to use local data.
                            0          // Flags. Not currently used, set to 0.
        )

        // Indicate that the long-click is handled.
        true
    }
}

Java

// Create a string for the ImageView label.
private static final String IMAGEVIEW_TAG = "icon bitmap";
...
// Create a new ImageView.
ImageView imageView = new ImageView(context);

// Set the bitmap for the ImageView from an icon bitmap defined elsewhere.
imageView.setImageBitmap(iconBitmap);

// Set the tag.
imageView.setTag(IMAGEVIEW_TAG);

// Set a long-click listener for the ImageView using an anonymous listener
// object that implements the OnLongClickListener interface.
imageView.setOnLongClickListener( v -> {

    // Create a new ClipData. This is done in two steps to provide clarity. The
    // convenience method ClipData.newPlainText() can create a plain text
    // ClipData in one step.

    // Create a new ClipData.Item from the ImageView object's tag.
    ClipData.Item item = new ClipData.Item((CharSequence) v.getTag());

    // Create a new ClipData using the tag as a label, the plain text MIME type,
    // and the already-created item. This creates a new ClipDescription object
    // within the ClipData and sets its MIME type to "text/plain".
    ClipData dragData = new ClipData(
            (CharSequence) v.getTag(),
            new String[] { ClipDescription.MIMETYPE_TEXT_PLAIN },
            item);

    // Instantiate the drag shadow builder. We use this imageView object
    // to create the default builder.
    View.DragShadowBuilder myShadow = new View.DragShadowBuilder(imageView);

    // Start the drag.
    v.startDragAndDrop(dragData,  // The data to be dragged.
                            myShadow,  // The drag shadow builder.
                            null,      // No need to use local data.
                            0          // Flags. Not currently used, set to 0.
    );

    // Indicate that the long-click is handled.
    return true;
});

ドラッグ開始に対応する

ドラッグ オペレーションの間は、現在のレイアウトにある View オブジェクトのドラッグ イベント リスナーに対して、システムからドラッグ イベントが送信されます。リスナーは DragEvent.getAction() を呼び出してアクション タイプを取得する。ドラッグを開始すると、 このメソッドは ACTION_DRAG_STARTED を返します。

アクション タイプ ACTION_DRAG_STARTED のイベントに対応して、ドラッグ イベントが 次の処理を行う必要があります。

  1. 発信 DragEvent.getClipDescription() 返された ClipDescription で MIME タイプのメソッドを使用して、 ドラッグされるデータをリスナーが受け入れられるかどうか。

    ドラッグ&ドロップ オペレーションがデータの移動ではない場合は、 不要です

  2. ドラッグ イベント リスナーがドロップを受け入れることができる場合は、true を返して ドラッグ イベントが引き続きリスナーに送信されます。リスナーが ドロップを受け入れることができず、リスナーが false を返す必要があり、システムは システムから次のイベントが送信されるまで、ドラッグ イベントをリスナーに送信する ACTION_DRAG_ENDED を押して、ドラッグ&ドロップ オペレーションを終了します。

ACTION_DRAG_STARTED イベントの場合、次の DragEvent メソッドは適用されません。 有効: getClipData()、 getX(), getY() および getResult()

ドラッグ中にイベントを処理する

ドラッグ アクション中に、イベントへの応答として true を返すドラッグ イベント リスナー ACTION_DRAG_STARTED ドラッグ イベントは引き続きドラッグ イベントを受け取ります。タイプ ドラッグ中にリスナーが受信するドラッグ イベントの数は、 ドラッグ シャドウとリスナーの View の表示設定。リスナーはドラァグを使う 主に、View の外観を変更する必要があるかどうかを判断します。

ドラッグの間、DragEvent.getAction() からは以下の 3 つの値のいずれかが返されます。

  • ACTION_DRAG_ENTERED: このイベント アクション タイプをリスナーが受け取るのは、 カーソルを合わせると、 リスナーの View の境界ボックス。
  • ACTION_DRAG_LOCATION: ACTION_DRAG_ENTERED イベントを受信すると、リスナーは新しい タッチポイントが動くたびに ACTION_DRAG_LOCATION イベントが発生します。 ACTION_DRAG_EXITED イベントを受信します。getX() メソッドと getY() メソッド タッチポイントの X 座標と Y 座標を返します。
  • ACTION_DRAG_EXITED: このイベント アクション タイプは、以前に受信した ACTION_DRAG_ENTERED。このイベントは、ドラッグ シャドウのタッチポイントがリスナーの View の境界ボックス内から境界ボックスの外に移動すると送信されます。

ドラッグ イベント リスナーは、これらのアクション タイプに反応する必要はありません。条件 リスナーがシステムに値を返しても無視されます。

各アクション タイプを受信したときの対応について、以下にガイドラインを示します。

  • ACTION_DRAG_ENTERED や ACTION_DRAG_LOCATION を受信したとき、リスナーは View の外観を変更することによって、ビューが潜在的なドロップ ターゲットであることを示せます。
  • アクション タイプ ACTION_DRAG_LOCATION のイベントに、次の有効なデータが含まれています: タッチポイントの位置に対応する getX() と getY()。「 リスナーはこの情報を使用して、View の外観を変更できます。 クリック可能な場所や 正確な位置を 説明します。
  • ACTION_DRAG_EXITED に応じて、リスナーは外観をリセットする必要があります。 ACTION_DRAG_ENTERED に対応して適用される変更、または ACTION_DRAG_LOCATION。こうすることで、その View が現時点でのドロップ先ではなくなったことをユーザーに示せます。

ドロップに対応する

ユーザーが View の上でドラッグ シャドウを解放し、その前に View ドラッグされているコンテンツを受け入れられることを通知すると、システムは アクション タイプ ACTION_DROP の View にイベントをドラッグします。

ドラッグ イベント リスナーでは、次のことを行う必要があります。

  1. getClipData() を呼び出して、元の ClipData オブジェクトを取得します。 呼び出しで提供されます。 startDragAndDrop() データを処理しますドラッグ&ドロップ オペレーションがデータを表さない場合 これは不要です

  2. ドロップが正常に処理されたことを示すブール値 true を返します。 そうでない場合は false に設定します。戻り値は、Terraform によって返される 最終的な ACTION_DRAG_ENDED イベントには getResult()。システムが ACTION_DROP イベントを送信しない（getResult() によって返される値） （ACTION_DRAG_ENDED イベントの）は false です。

ACTION_DROP イベントの場合、getX() と getY() は次の座標系を使用します。 降下を受信した View は、境界の X 位置と Y 位置を返します。 瞬間のタッチポイントです

ユーザーは、ドラッグ イベントの View 上でドラッグ シャドウを解放できます。 リスナーがドラッグ イベントを受信していないこと、アプリの UI の空白の領域、 アプリ外の領域では、Android はアクションを含むイベントを送信せず、 タイプ ACTION_DROP で、ACTION_DRAG_ENDED イベントのみを送信します。

ドラッグ終了に対応する

ユーザーがドラッグ シャドウを放すとすぐに、システムからドラッグ シャドウが送信されます。 すべてのドラッグ イベント リスナーへの、アクション タイプ ACTION_DRAG_ENDED のイベント 使用できます。これは、ドラッグ オペレーションが完了したことを示します。

各ドラッグ イベント リスナーでは、次のことを行う必要があります。

  1. オペレーション中にリスナーの外観が変更された場合は、リセットする必要があります。 デフォルトの表示に戻されて、 終了します。
  2. 必要であれば、getResult() を呼び出すことで、ドラッグ＆ドロップ オペレーションについてのより詳しい情報を取得できます。アクションのイベントに対してリスナーが true を返す場合 ACTION_DROP 型の場合、getResult() はブール値 true を返します。その他すべての getResult() はブール値 false を返します。これにはシステムが ACTION_DROP イベントを送信しない。
  3. ドロップ操作が正常に完了したことを示すために、 ブール値 true をシステムに返します。false を返さないと、 ドロップ シャドウがソースに戻るので、 オペレーションが失敗したことをユーザーに通知します。

ドラッグ イベントへの対応例

ドラッグ イベントはすべて、ドラッグ イベント メソッドかリスナーが受信します。「 次のコード スニペットは、ドラッグ イベントへの応答の例です。

Kotlin

val imageView = ImageView(this)

// Set the drag event listener for the View.
imageView.setOnDragListener { v, e ->

    // Handle each of the expected events.
    when (e.action) {
        DragEvent.ACTION_DRAG_STARTED -> {
            // Determine whether this View can accept the dragged data.
            if (e.clipDescription.hasMimeType(ClipDescription.MIMETYPE_TEXT_PLAIN)) {
                // As an example, apply a blue color tint to the View to
                // indicate that it can accept data.
                (v as? ImageView)?.setColorFilter(Color.BLUE)

                // Invalidate the view to force a redraw in the new tint.
                v.invalidate()

                // Return true to indicate that the View can accept the dragged
                // data.
                true
            } else {
                // Return false to indicate that, during the current drag and
                // drop operation, this View doesn't receive events again until
                // ACTION_DRAG_ENDED is sent.
                false
            }
        }
        DragEvent.ACTION_DRAG_ENTERED -> {
            // Apply a green tint to the View.
            (v as? ImageView)?.setColorFilter(Color.GREEN)

            // Invalidate the view to force a redraw in the new tint.
            v.invalidate()

            // Return true. The value is ignored.
            true
        }

        DragEvent.ACTION_DRAG_LOCATION ->
            // Ignore the event.
            true
        DragEvent.ACTION_DRAG_EXITED -> {
            // Reset the color tint to blue.
            (v as? ImageView)?.setColorFilter(Color.BLUE)

            // Invalidate the view to force a redraw in the new tint.
            v.invalidate()

            // Return true. The value is ignored.
            true
        }
        DragEvent.ACTION_DROP -> {
            // Get the item containing the dragged data.
            val item: ClipData.Item = e.clipData.getItemAt(0)

            // Get the text data from the item.
            val dragData = item.text

            // Display a message containing the dragged data.
            Toast.makeText(this, "Dragged data is $dragData", Toast.LENGTH_LONG).show()

            // Turn off color tints.
            (v as? ImageView)?.clearColorFilter()

            // Invalidate the view to force a redraw.
            v.invalidate()

            // Return true. DragEvent.getResult() returns true.
            true
        }

        DragEvent.ACTION_DRAG_ENDED -> {
            // Turn off color tinting.
            (v as? ImageView)?.clearColorFilter()

            // Invalidate the view to force a redraw.
            v.invalidate()

            // Do a getResult() and display what happens.
            when(e.result) {
                true ->
                    Toast.makeText(this, "The drop was handled.", Toast.LENGTH_LONG)
                else ->
                    Toast.makeText(this, "The drop didn't work.", Toast.LENGTH_LONG)
            }.show()

            // Return true. The value is ignored.
            true
        }
        else -> {
            // An unknown action type is received.
            Log.e("DragDrop Example", "Unknown action type received by View.OnDragListener.")
            false
        }
    }
}

Java

View imageView = new ImageView(this);

// Set the drag event listener for the View.
imageView.setOnDragListener( (v, e) -> {

    // Handle each of the expected events.
    switch(e.getAction()) {

        case DragEvent.ACTION_DRAG_STARTED:

            // Determine whether this View can accept the dragged data.
            if (e.getClipDescription().hasMimeType(ClipDescription.MIMETYPE_TEXT_PLAIN)) {

                // As an example, apply a blue color tint to the View to
                // indicate that it can accept data.
                ((ImageView)v).setColorFilter(Color.BLUE);

                // Invalidate the view to force a redraw in the new tint.
                v.invalidate();

                // Return true to indicate that the View can accept the dragged
                // data.
                return true;

            }

            // Return false to indicate that, during the current drag-and-drop
            // operation, this View doesn't receive events again until
            // ACTION_DRAG_ENDED is sent.
            return false;

        case DragEvent.ACTION_DRAG_ENTERED:

            // Apply a green tint to the View.
            ((ImageView)v).setColorFilter(Color.GREEN);

            // Invalidate the view to force a redraw in the new tint.
            v.invalidate();

            // Return true. The value is ignored.
            return true;

        case DragEvent.ACTION_DRAG_LOCATION:

            // Ignore the event.
            return true;

        case DragEvent.ACTION_DRAG_EXITED:

            // Reset the color tint to blue.
            ((ImageView)v).setColorFilter(Color.BLUE);

            // Invalidate the view to force a redraw in the new tint.
            v.invalidate();

            // Return true. The value is ignored.
            return true;

        case DragEvent.ACTION_DROP:

            // Get the item containing the dragged data.
            ClipData.Item item = e.getClipData().getItemAt(0);

            // Get the text data from the item.
            CharSequence dragData = item.getText();

            // Display a message containing the dragged data.
            Toast.makeText(this, "Dragged data is " + dragData, Toast.LENGTH_LONG).show();

            // Turn off color tints.
            ((ImageView)v).clearColorFilter();

            // Invalidate the view to force a redraw.
            v.invalidate();

            // Return true. DragEvent.getResult() returns true.
            return true;

        case DragEvent.ACTION_DRAG_ENDED:

            // Turn off color tinting.
            ((ImageView)v).clearColorFilter();

            // Invalidate the view to force a redraw.
            v.invalidate();

            // Do a getResult() and displays what happens.
            if (e.getResult()) {
                Toast.makeText(this, "The drop was handled.", Toast.LENGTH_LONG).show();
            } else {
                Toast.makeText(this, "The drop didn't work.", Toast.LENGTH_LONG).show();
            }

            // Return true. The value is ignored.
            return true;

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

    return false;

});

ドラッグ シャドウをカスタマイズする

カスタマイズした myDragShadowBuilder を定義するには、 View.DragShadowBuilder。次のコード スニペットは、小さい TextView の長方形のグレーのドラッグ シャドウ:

Kotlin

private class MyDragShadowBuilder(view: View) : View.DragShadowBuilder(view) {

    private val shadow = ColorDrawable(Color.LTGRAY)

    // Define a callback that sends the drag shadow dimensions and touch point
    // back to the system.
    override fun onProvideShadowMetrics(size: Point, touch: Point) {

            // Set the width of the shadow to half the width of the original
            // View.
            val width: Int = view.width / 2

            // Set the height of the shadow to half the height of the original
            // View.
            val height: Int = view.height / 2

            // The drag shadow is a ColorDrawable. Set its dimensions to
            // be the same as the Canvas that the system provides. As a result,
            // the drag shadow fills the Canvas.
            shadow.setBounds(0, 0, width, height)

            // Set the size parameter's width and height values. These get back
            // to the system through the size parameter.
            size.set(width, height)

            // Set the touch point's position to be in the middle of the drag
            // shadow.
            touch.set(width / 2, height / 2)
    }

    // Define a callback that draws the drag shadow in a Canvas that the system
    // constructs from the dimensions passed to onProvideShadowMetrics().
    override fun onDrawShadow(canvas: Canvas) {

            // Draw the ColorDrawable on the Canvas passed in from the system.
            shadow.draw(canvas)
    }
}

Java

private static class MyDragShadowBuilder extends View.DragShadowBuilder {

    // The drag shadow image, defined as a drawable object.
    private static Drawable shadow;

    // Constructor.
    public MyDragShadowBuilder(View view) {

            // Store the View parameter.
            super(view);

            // Create a draggable image that fills the Canvas provided by the
            // system.
            shadow = new ColorDrawable(Color.LTGRAY);
    }

    // Define a callback that sends the drag shadow dimensions and touch point
    // back to the system.
    @Override
    public void onProvideShadowMetrics (Point size, Point touch) {

            // Define local variables.
            int width, height;

            // Set the width of the shadow to half the width of the original
            // View.
            width = getView().getWidth() / 2;

            // Set the height of the shadow to half the height of the original
            // View.
            height = getView().getHeight() / 2;

            // The drag shadow is a ColorDrawable. Set its dimensions to
            // be the same as the Canvas that the system provides. As a result,
            // the drag shadow fills the Canvas.
            shadow.setBounds(0, 0, width, height);

            // Set the size parameter's width and height values. These get back
            // to the system through the size parameter.
            size.set(width, height);

            // Set the touch point's position to be in the middle of the drag
            // shadow.
            touch.set(width / 2, height / 2);
    }

    // Define a callback that draws the drag shadow in a Canvas that the system
    // constructs from the dimensions passed to onProvideShadowMetrics().
    @Override
    public void onDrawShadow(Canvas canvas) {

            // Draw the ColorDrawable on the Canvas passed in from the system.
            shadow.draw(canvas);
    }
}