Android 3.0の新APIで簡単ドラッグ＆ドロップ実装：Androidで動く携帯Javaアプリ作成入門（23）（3/3 ページ）

ドラッグ開始部分の実装

　ドラッグは、startDrag()メソッドを呼び出すことで、任意のタイミングで開始できますが、OnTouchListenerやOnClickListenerなど、そのままドラッグ操作が行えるイベント内で開始するのが自然です。

　今回のサンプルは、OnTouchListener内で開始しています。

setOnTouchListener(new View.OnTouchListener() {
    @Override
    public boolean onTouch(View v, MotionEvent event) {
        if (event.getAction() == MotionEvent.ACTION_MOVE) {
            ClipData data = ClipData.newPlainText(
                "msg","Please drop to robot."); // 【1】
            v.startDrag(data, new DragShadowBuilder(v), null, 0); // 【2】
            return true;
        }
        return false;
    }
});

　onTouch()内でイベントがMotionEvent.ACTION_MOVEだった場合、ドラッグを開始しています。【1】でClipDataオブジェクトを作成しています。今回は、データを受け渡すのが目的ではないので、適当なテキストでClipDataを作成しています。

　【2】でドラッグを開始しています。第2引数のDragShadowBuilderはドラッグ中の表示が半透明になる実装になっていますが、このクラスを継承してonDragShadow()メソッドをオーバーライドすることで、ドラッグ中の表示をカスタマイズできます。第3引数はgetLocalState()でドロップ先に通知する情報を指定します。第4引数はフラグを指定しますが、Android 3.0時点では、指定すべきフラグがまだないため、0を指定します。

onDragEvent()でドラッグ＆ドロップ中の“状態”を判定

　ドロップされる側のロボットには、状態が3つ用意してあります。

図3　ドロップされる側のロボットの3つ状態

　この3つの状態を切り替えて描画するための処理は、すべてonDragEvent()で行われています。

private boolean isDragging; // ドラッグ中であるかどうか
private boolean isHovering; // ホバー中であるかどうか
 
@Override
public boolean onDragEvent(DragEvent event) {
    switch (event.getAction()) {
    case DragEvent.ACTION_DRAG_STARTED: // 【1】
        isDragging = true;
        invalidate();
        break;
 
    case DragEvent.ACTION_DRAG_ENDED: // 【2】
        isDragging = false;
        isHovering = false;
        invalidate();
        break;
 
    case DragEvent.ACTION_DRAG_LOCATION: // 【3】
        break;
 
    case DragEvent.ACTION_DROP: // 【4】
        resultText.setText("Dropped on Robot");
        break;
 
    case DragEvent.ACTION_DRAG_ENTERED: // 【5】
        isHovering = true;
        invalidate();
        break;
 
    case DragEvent.ACTION_DRAG_EXITED: // 【6】
         isHovering = false;
         invalidate();
         break;
    }
    return true; // 【7】
}

　【1】でドラッグが開始したことが通知されたら、ドラッグ中フラグをtrueにして、再描画を行います。

　【2】でドラッグ＆ドロップが終了したことが通知されたら、ドラッグ中フラグとホバー中グラフをfalseにして再描画します。

　【3】では、ホバー中の移動イベントを受け取っても何も行っていません。

　【4】でドロップされた場合、別に用意されているTextViewにメッセージを出力しています。必要に応じてここでClipDataからデータを取得し、データの内容に応じて処理を行います。ClipDataからのデータの取り出しは後述するonDrag()で説明します。

　【5】でドラッグがView内に入ったら、ホバー中フラグをtrueにして再描画します。

　【6】でドラッグがViewの外に出たら、ホバー中フラグをfalseにして再描画します。

　【7】でドラッグ＆ドロップイベントを処理したことを、trueを返して通知します。この結果は、getResult()で取得される値になります。特にイベントのアクションがACTION_DROPの際に、ドロップされたデータが期待にそぐわない場合はfalseを返して、処理しなかった旨をユーザーに通知します。

　「onDragEvent()内でフラグを更新し、invalidate()で再描画を行う」というこのパターンは汎用的なので、ぜひ覚えておいてください。

onDrag()でClipDataからデータを取り出す

　ドラッグイベントの通知は、ViewのonDragEvent()をオーバーライドする以外に、OnDragEventListenerを実装することでも受け取れることは前述しました。

　イベント自体の捌き方は同じなので、ここではClipDataからのデータの取り出し方法を見てみましょう。

setOnDragListener(new View.OnDragListener() {
    @Override
    public boolean onDrag(View v, DragEvent event) {
        if (event.getAction() == DragEvent.ACTION_DROP) {
            ClipData data = event.getClipData(); // 【1】
            for (int i = 0; i < data.getItemCount(); i++) { // 【2】
                ClipData.Item item = data.getItemAt(i); // 【3】
                Toast.makeText(getContext(),
                    item.coerceToText(getContext()), // 【4】
                    Toast.LENGTH_SHORT).show();
            }
        } else if (event.getAction() == DragEvent.ACTION_DRAG_ENDED) {
            if (!event.getResult()) {
                resultText.setText("No drop");
            }
        }
        return false;
    }
});

　ClipDataはドロップ時にしか取り出せないので、DragEvent#getAction()がDragEvent.ACTION_DROPであるかどうかを判定してから、【1】で取得しています。

　ClipDataには複数のClipData.Itemを格納できるので、【2】でgetItemCount()を使用して数を取得しています。

　【3】でgetItemAt()でClipData.Itemを取り出し、【4】でcoerceToText()でテキストデータを取り出しています。

　今回のサンプルでは、受け渡すデータは重要ではないため、簡単で分かりやすく実装していますが、実践ではアプリの提供したい機能に応じて、受け渡しのデータと受け取り方法を設計する必要があります。特に、複数のドラッグ元や複数のデータ種別がある場合は、この部分は複雑になります。

ドラッグ＆ドロップがAPIで簡単に

　Android 3.0からサポートされたドラッグ＆ドロップはいかがだったでしょうか。Canvasとイベントを駆使すれば、独自にドラッグ＆ドロップの機能を実現できるかもしれませんが、APIとしてサポートされたことによって、既存のロジックへの影響を最小限に抑えつつ、簡単にアプリにドラッグ＆ドロップ機能を追加できるようになりました。

　最近のAndroidのバージョンアップはめまぐるしく、紹介していない新機能がまだまだ、たくさんあります。次回も、そんな新機能の中から1つをピックアップして紹介する予定です。