Time zone, Region, UTC picker

- Extract most common view related codes into BaseTimeZoneAdapter
  and BaseTimeZonePicker. Subclass handles the text formatting and
  order.
- Search view is added compared to previous version of time
  zone picker
- SpannableUtil is added to preserve spannable when formatting
  String resource.
- Fix the bug using GMT+<arabic> as time zone id. b/73132985
- Fix Talkback treating flags on screens as a separate element

Bug: 72146259
Bug: 73132985
Bug: 73952488
Test: mm RunSettingsRoboTests
Change-Id: I42c6ac369199c09d11e7f5cc4707358fa4780fed
(cherry picked from commit fbd30acef0)

src/com/android/settings/datetime/timezone/BaseTimeZonePicker.java

@@ -0,0 +1,159 @@
+/*
+ * Copyright (C) 2018 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.datetime.timezone;
+
+import android.os.Bundle;
+import android.support.v7.widget.LinearLayoutManager;
+import android.support.v7.widget.RecyclerView;
+import android.view.LayoutInflater;
+import android.view.Menu;
+import android.view.MenuInflater;
+import android.view.MenuItem;
+import android.view.View;
+import android.view.ViewGroup;
+import android.widget.SearchView;
+
+import com.android.internal.logging.nano.MetricsProto.MetricsEvent;
+import com.android.settings.R;
+import com.android.settings.core.InstrumentedFragment;
+import com.android.settings.datetime.timezone.model.TimeZoneData;
+import com.android.settings.datetime.timezone.model.TimeZoneDataLoader;
+
+import java.util.Locale;
+
+/**
+ * It's abstract class. Subclass should use it with {@class BaseTimeZoneAdapter} and
+ * {@class AdapterItem} to provide a list view with text search capability.
+ * The search matches the prefix of words in the search text.
+ */
+public abstract class BaseTimeZonePicker extends InstrumentedFragment
+        implements SearchView.OnQueryTextListener{
+
+    public static final String EXTRA_RESULT_REGION_ID =
+            "com.android.settings.datetime.timezone.result_region_id";
+    public static final String EXTRA_RESULT_TIME_ZONE_ID =
+            "com.android.settings.datetime.timezone.result_time_zone_id";
+    private final int mTitleResId;
+    private final int mSearchHintResId;
+    private final boolean mSearchEnabled;
+    private final boolean mDefaultExpandSearch;
+
+    protected Locale mLocale;
+    private BaseTimeZoneAdapter mAdapter;
+    private RecyclerView mRecyclerView;
+    private TimeZoneData mTimeZoneData;
+
+    private SearchView mSearchView;
+
+    /**
+     * Constructor called by subclass.
+     * @param defaultExpandSearch whether expand the search view when first launching the fragment
+     */
+    protected BaseTimeZonePicker(int titleResId, int searchHintResId,
+            boolean searchEnabled, boolean defaultExpandSearch) {
+        mTitleResId = titleResId;
+        mSearchHintResId = searchHintResId;
+        mSearchEnabled = searchEnabled;
+        mDefaultExpandSearch = defaultExpandSearch;
+    }
+
+    @Override
+    public void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setHasOptionsMenu(true);
+        getActivity().setTitle(mTitleResId);
+    }
+
+    @Override
+    public View onCreateView(LayoutInflater inflater, ViewGroup container,
+            Bundle savedInstanceState) {
+        final View view = inflater.inflate(R.layout.recycler_view, container, false);
+        mRecyclerView = view.findViewById(R.id.recycler_view);
+        mRecyclerView.setLayoutManager(new LinearLayoutManager(getContext(),
+                LinearLayoutManager.VERTICAL, /* reverseLayout */ false));
+        mRecyclerView.setAdapter(mAdapter);
+
+        // Initialize TimeZoneDataLoader only when mRecyclerView is ready to avoid race
+        // during onDateLoaderReady callback.
+        getLoaderManager().initLoader(0, null, new TimeZoneDataLoader.LoaderCreator(
+                getContext(), this::onTimeZoneDataReady));
+        return view;
+    }
+
+    public void onTimeZoneDataReady(TimeZoneData timeZoneData) {
+        if (mTimeZoneData == null && timeZoneData != null) {
+            mTimeZoneData = timeZoneData;
+            mAdapter = createAdapter(mTimeZoneData);
+            if (mRecyclerView != null) {
+                mRecyclerView.setAdapter(mAdapter);
+            }
+        }
+    }
+
+    protected Locale getLocale() {
+        return getContext().getResources().getConfiguration().getLocales().get(0);
+    }
+
+    /**
+     * Called when TimeZoneData is ready.
+     */
+    protected abstract BaseTimeZoneAdapter createAdapter(TimeZoneData timeZoneData);
+
+    @Override
+    public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
+        if (mSearchEnabled) {
+            inflater.inflate(R.menu.time_zone_base_search_menu, menu);
+
+            final MenuItem searchMenuItem = menu.findItem(R.id.time_zone_search_menu);
+            mSearchView = (SearchView) searchMenuItem.getActionView();
+
+            mSearchView.setQueryHint(getText(mSearchHintResId));
+            mSearchView.setOnQueryTextListener(this);
+
+            if (mDefaultExpandSearch) {
+                searchMenuItem.expandActionView();
+                mSearchView.setIconified(false);
+                mSearchView.setActivated(true);
+                mSearchView.setQuery("", true /* submit */);
+            }
+        }
+    }
+
+    @Override
+    public boolean onQueryTextSubmit(String query) {
+        return false;
+    }
+
+    @Override
+    public boolean onQueryTextChange(String newText) {
+        if (mAdapter != null) {
+            mAdapter.getFilter().filter(newText);
+        }
+        return false;
+    }
+
+    @Override
+    public int getMetricsCategory() {
+        // TODO: use a new metrics id?
+        return MetricsEvent.ZONE_PICKER;
+    }
+
+    public interface OnListItemClickListener {
+        void onListItemClick(int position);
+    }
+
+}