XamarinでPickerのDone/OKボタンが押下された際に特定の処理を呼び出す方法

Question

前提・実現したいこと

Xamarinを使用してC#でiOS/Android向けのアプリを開発しております。実現したいのは、XAMLのPickerで入力完了を意味するDone/OKボタンが押された際に、特定の処理を走らせることです。（Pickerの入力完了のボタンはiOSではDoneボタン、AndroidではOKボタンです。）

iOS側で実現することはできたため、今回の質問はAndroid側での実現方法についてです。

iOS側の実装

iOS側の実装については、PickerRendererクラスを継承して実現することができました。XAMLにて以下のBasePickerタグを記述することで、Doneボタン押下にて★印のついたコメント行の処理を呼び出すことができています。

BasePicker.cs

using Xamarin.Forms;

namespace AppName.Controls
{
    public class BasePicker : Picker
    {
        public BasePicker() : base()
        {
        }

        string _someProperty = null;
        public string SomeProperty
        {
            get { return _someProperty ; }
            set { _someProperty = value; }
        }
    }
}

MyPickerRenderer.cs（AppName.iOS側に存在）

using System;
using Xamarin.Forms;
using Xamarin.Forms.Platform.iOS;
using UIKit;
using AppName.Controls;
using AppName.iOS.Renderer;

[assembly: ExportRenderer(typeof(BasePicker), typeof(MyPickerRenderer))]
namespace AppName.iOS.Renderer
{
    public class MyPickerRenderer : PickerRenderer
    {
        protected override void OnElementChanged(ElementChangedEventArgs<Picker> e)
        {
            base.OnElementChanged(e);

            if (e.OldElement != null)
            {
                if (Control != null)
                {
                    var toolbar = (UIToolbar)Control.InputAccessoryView;
                    var doneBtn = toolbar.Items[1];

                    doneBtn.Clicked -= DoneBtn_Clicked;
                }
            }

            if (e.NewElement != null)
            {
                var toolbar = (UIToolbar)Control.InputAccessoryView;
                var doneBtn = toolbar.Items[1];

                doneBtn.Clicked += DoneBtn_Clicked;
            }
        }
        
        void DoneBtn_Clicked(object sender, EventArgs e)
        {
            // ★ここに何か実行したい処理を書く★
        }
    }
}

Android側の実装（試したこと）

今回質問したいのは、Android側の実装をどうすべきかというという点です。最初に、AppName.iOS側に存在するMyPickerRenderer.csをAppName.Android側にコピーし、usingやnamespaceの「iOS」の部分を「Android」等に書き換えました。

次に、元々のiOS向けのコードにはUIToolbarを取得したのち、(UIBarButtonItem)doneBtnを取得している部分がありますので、この部分をAndroid向けに書き換える必要があると考えています。しかしこのdoneBtnの取得方法について、さまざまなキーワードで検索を試みましたが、情報を見つけることができませんでした。ここで調査が行き詰っています。

Visual Studioの入力補完機能を使用すると、OnElementChanged内で得られるControlにはSetOn○○○Listenerというメソッドが複数存在しているようで、これを利用すればOKボタンを押した際に呼び出されるメソッドを指定できるのかもしれないとも推測しています。しかしこれについても、検索を試みても詳しい使用方法がヒットせず、単なる推測のままです。

Android側でPickerのOKボタンが押された際に特定の処理を呼び出すにはどうすればいいのでしょうか。どうぞよろしくお願いいたします。

その他の試したこと

XAMLのPickerで指定できるSelectedIndexChangedについては、選択項目を変更せずにDone/OKした場合に動作してくれないため、今回の使用目的には合いませんでした。同様にPropertyChanged、Unfocusedについても今回の使用目的には合いませんでした。

補足情報（FW/ツールのバージョンなど）

C#、Xamarin.Forms等のバージョンは最新のものを使用しています。

Answer 1

AndroidのPickerは、内部でAlertDialogを作成して表示している形なので、簡単にカスタマイズすることができません。仕方ないので、クリック時に独自のダイアログを表示するようにします。
SetPositiveButtonがOKボタンを押された処理なのでそこに処理を追加することになります。
また、フォーカス時に表示されるピッカーでも動作するように、OnFocusChangeRequestedにも修正を加えています。（OnClickやOnFocusChangeRequestedはほぼ元コードのコピペです。）

public class MyPickerRenderer : PickerRenderer
{
    AlertDialog _dialog;

    public MyPickerRenderer(Context context) : base(context)
    {
    }

    IElementController ElementController => Element as IElementController;

    protected override void OnElementChanged(ElementChangedEventArgs<Picker> e)
    {
        base.OnElementChanged(e);

        if (e.OldElement != null)
        {
            if (Control != null)
            {
                Control.Click -= Control_Click;
                Control.FocusChange -= Control_FocusChange;
            }
        }

        if (e.NewElement != null)
        {
            Control.Click += Control_Click;
            Control.FocusChange += Control_FocusChange;
        }
    }

    protected override void OnFocusChangeRequested(object sender, VisualElement.FocusRequestArgs e)
    {
        if (Control == null)
            return;

        e.Result = true;

        if (e.Focus)
        {
            // Android does the actual focus/unfocus work on the main looper
            // So in case we're setting the focus in response to another control's un-focusing,
            // we need to post the handling of it to the main looper so that it happens _after_ all the other focus
            // work is done; otherwise, a call to ClearFocus on another control will kill the focus we set here
            Device.BeginInvokeOnMainThread(() =>
            {
                if (Control == null || Control.Handle == IntPtr.Zero)
                    return;
                if (Control is IPopupTrigger popupElement)
                    popupElement.ShowPopupOnFocus = true;

                Control?.RequestFocus();
            });
        }
        else
        {
            Control.ClearFocus();
        }
    }

    protected override void OnFocusChanged(bool gainFocus, [GeneratedEnum] FocusSearchDirection direction, Android.Graphics.Rect previouslyFocusedRect)
    {
        base.OnFocusChanged(gainFocus, direction, previouslyFocusedRect);
    }

    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            if (Control != null)
            {
                Control.Click -= Control_Click;
                Control.FocusChange -= Control_FocusChange;
            }
        }

        base.Dispose(disposing);
    }

    private void Control_Click(object sender, EventArgs e)
    {
        OnClick();
    }

    private void OnClick()
    {
        Picker model = Element;

        if (_dialog != null)
            return;

        var picker = new NumberPicker(Context);
        if (model.Items != null && model.Items.Any())
        {
            picker.MaxValue = model.Items.Count - 1;
            picker.MinValue = 0;
            picker.SetDisplayedValues(model.Items.ToArray());
            picker.WrapSelectorWheel = false;
            picker.DescendantFocusability = Android.Views.DescendantFocusability.BlockDescendants;
            picker.Value = model.SelectedIndex;
        }

        var layout = new LinearLayout(Context) { Orientation = Orientation.Vertical };
        layout.AddView(picker);

        ElementController.SetValueFromRenderer(VisualElement.IsFocusedPropertyKey, true);

        var builder = new AlertDialog.Builder(Context);
        builder.SetView(layout);

        if (!Element.IsSet(Picker.TitleColorProperty))
        {
            builder.SetTitle(model.Title ?? "");
        }
        else
        {
            var title = new SpannableString(model.Title ?? "");
            title.SetSpan(new ForegroundColorSpan(model.TitleColor.ToAndroid()), 0, title.Length(), SpanTypes.ExclusiveExclusive);

            builder.SetTitle(title);
        }

        builder.SetNegativeButton(global::Android.Resource.String.Cancel, (s, a) =>
        {
            ElementController.SetValueFromRenderer(VisualElement.IsFocusedPropertyKey, false);
            _dialog = null;
        });
        builder.SetPositiveButton(global::Android.Resource.String.Ok, (s, a) =>
        {
            ElementController.SetValueFromRenderer(Picker.SelectedIndexProperty, picker.Value);
            // It is possible for the Content of the Page to be changed on SelectedIndexChanged. 
            // In this case, the Element & Control will no longer exist.
            if (Element != null)
            {
                if (model.Items.Count > 0 && Element.SelectedIndex >= 0)
                    Control.Text = model.Items[Element.SelectedIndex];
                ElementController.SetValueFromRenderer(VisualElement.IsFocusedPropertyKey, false);
            }
            _dialog = null;

            // ★ここに何か実行したい処理を書く★
        });

        _dialog = builder.Create();
        _dialog.DismissEvent += (sender, args) =>
        {
            ElementController?.SetValueFromRenderer(VisualElement.IsFocusedPropertyKey, false);
            _dialog?.Dispose();
            _dialog = null;
        };
        _dialog.Show();
    }

    private void Control_FocusChange(object sender, FocusChangeEventArgs e)
    {
        if (e.HasFocus)
        {
            if (Clickable)
                CallOnClick();
            else
                OnClick();
        }
        else if (_dialog != null)
        {
            _dialog.Hide();
            ElementController.SetValueFromRenderer(VisualElement.IsFocusedPropertyKey, false);
            _dialog = null;
        }
    }
}

Comments

[yiwata]

ソースコードで詳しくご回答いただきありがとうございます。ご回答いただいたソースで、意図した動作ができることが確認できました。

少し追加の質問をさせてください。XAMLでEntryとPickerを順に並べて、Entryに「ReturnType="Next"」を指定した場合、Entryの入力完了後にソフトキーボードの「→」キー押下でPickerにフォーカスを移すことができると思います。そのような動作でPickerにフォーカスを移した場合、今回実装していただいたダイアログは出てこない動作となっていました。Focus周りの処理も実装していただいたようなのでお訊きしたいのですが、上記したような「直前のEntryからソフトキーボードでPickerにフォーカスが移ったケース」でもダイアログが出てくれるように、ご回答いただいたソースを改変することは可能でしょうか？

もしそれほど手がかからないようであれば、改変後のソースをご教示いただけると大変助かります。逆にそう簡単には改変できないという見立てであれば、その旨コメントいただけますでしょうか。その場合は実現方法を別途詳しく調査したいと思いますので、いったんこの質問はベストアンサー指定の上クローズさせていただこうと思います。

[f-miyu]

そもそも元々のPickerでも、Focusメソッド呼び出しではダイアログは表示されますが、キー押下では、フォーカスが移動してもダイアログは表示されないようですね。
一応、フォーカス移動でもダイアログが表示されるように修正しましたので、確認してみてください。
（OnFocusChangeRequestedで行っていたダイアログ表示処理をFocusChangeイベント発火時に行うようにしています。）

[yiwata]

ソースコードのご修正ありがとうございます。「直前のEntryからソフトキーボードでPickerにフォーカスが移ったケース」でもダイアログが表示されることが確認できました。

ソースコードレベルで具体的な実装をご回答いただき感謝しております。Rendererの中身についてはおそらく自力では実装できなかったと思いますので、大変助かりました。どうもありがとうございました。