1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.settings.datetime.timezone;
18 
19 import android.os.Bundle;
20 import android.view.LayoutInflater;
21 import android.view.Menu;
22 import android.view.MenuInflater;
23 import android.view.MenuItem;
24 import android.view.View;
25 import android.view.ViewGroup;
26 import android.widget.LinearLayout;
27 import android.widget.SearchView;
28 import android.widget.TextView;
29 
30 import androidx.recyclerview.widget.LinearLayoutManager;
31 import androidx.recyclerview.widget.RecyclerView;
32 
33 import com.android.settings.R;
34 import com.android.settings.core.InstrumentedFragment;
35 import com.android.settings.datetime.timezone.model.TimeZoneData;
36 import com.android.settings.datetime.timezone.model.TimeZoneDataLoader;
37 
38 import java.util.Locale;
39 
40 /**
41  * It's abstract class. Subclass should use it with {@class BaseTimeZoneAdapter} and
42  * {@class AdapterItem} to provide a list view with text search capability.
43  * The search matches the prefix of words in the search text.
44  */
45 public abstract class BaseTimeZonePicker extends InstrumentedFragment
46         implements SearchView.OnQueryTextListener {
47 
48     public static final String EXTRA_RESULT_REGION_ID =
49             "com.android.settings.datetime.timezone.result_region_id";
50     public static final String EXTRA_RESULT_TIME_ZONE_ID =
51             "com.android.settings.datetime.timezone.result_time_zone_id";
52     private final int mTitleResId;
53     private final int mSearchHintResId;
54     private final boolean mSearchEnabled;
55     private final boolean mDefaultExpandSearch;
56 
57     protected Locale mLocale;
58     private BaseTimeZoneAdapter mAdapter;
59     private RecyclerView mRecyclerView;
60     private TimeZoneData mTimeZoneData;
61 
62     private SearchView mSearchView;
63 
64     /**
65      * Constructor called by subclass.
66      * @param defaultExpandSearch whether expand the search view when first launching the fragment
67      */
BaseTimeZonePicker(int titleResId, int searchHintResId, boolean searchEnabled, boolean defaultExpandSearch)68     protected BaseTimeZonePicker(int titleResId, int searchHintResId,
69             boolean searchEnabled, boolean defaultExpandSearch) {
70         mTitleResId = titleResId;
71         mSearchHintResId = searchHintResId;
72         mSearchEnabled = searchEnabled;
73         mDefaultExpandSearch = defaultExpandSearch;
74     }
75 
76     @Override
onCreate(Bundle savedInstanceState)77     public void onCreate(Bundle savedInstanceState) {
78         super.onCreate(savedInstanceState);
79         setHasOptionsMenu(true);
80         getActivity().setTitle(mTitleResId);
81     }
82 
83     @Override
onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)84     public View onCreateView(LayoutInflater inflater, ViewGroup container,
85             Bundle savedInstanceState) {
86         final View view = inflater.inflate(R.layout.recycler_view, container, false);
87         mRecyclerView = view.findViewById(R.id.recycler_view);
88         mRecyclerView.setLayoutManager(new LinearLayoutManager(getContext(),
89                 LinearLayoutManager.VERTICAL, /* reverseLayout */ false));
90         mRecyclerView.setAdapter(mAdapter);
91 
92         // Initialize TimeZoneDataLoader only when mRecyclerView is ready to avoid race
93         // during onDateLoaderReady callback.
94         getLoaderManager().initLoader(0, null, new TimeZoneDataLoader.LoaderCreator(
95                 getContext(), this::onTimeZoneDataReady));
96         return view;
97     }
98 
onTimeZoneDataReady(TimeZoneData timeZoneData)99     public void onTimeZoneDataReady(TimeZoneData timeZoneData) {
100         if (mTimeZoneData == null && timeZoneData != null) {
101             mTimeZoneData = timeZoneData;
102             mAdapter = createAdapter(mTimeZoneData);
103             if (mRecyclerView != null) {
104                 mRecyclerView.setAdapter(mAdapter);
105             }
106         }
107     }
108 
getLocale()109     protected Locale getLocale() {
110         return getContext().getResources().getConfiguration().getLocales().get(0);
111     }
112 
113     /**
114      * Called when TimeZoneData is ready.
115      */
createAdapter(TimeZoneData timeZoneData)116     protected abstract BaseTimeZoneAdapter createAdapter(TimeZoneData timeZoneData);
117 
118     @Override
onCreateOptionsMenu(Menu menu, MenuInflater inflater)119     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
120         if (mSearchEnabled) {
121             inflater.inflate(R.menu.time_zone_base_search_menu, menu);
122 
123             final MenuItem searchMenuItem = menu.findItem(R.id.time_zone_search_menu);
124             mSearchView = (SearchView) searchMenuItem.getActionView();
125 
126             mSearchView.setQueryHint(getText(mSearchHintResId));
127             mSearchView.setOnQueryTextListener(this);
128 
129             if (mDefaultExpandSearch) {
130                 searchMenuItem.expandActionView();
131                 mSearchView.setIconified(false);
132                 mSearchView.setActivated(true);
133                 mSearchView.setQuery("", true /* submit */);
134             }
135 
136             // Set zero margin and padding to align with the text horizontally in the preference
137             final TextView searchViewView = (TextView) mSearchView.findViewById(
138                     com.android.internal.R.id.search_src_text);
139             searchViewView.setPadding(0, searchViewView.getPaddingTop(), 0,
140                     searchViewView.getPaddingBottom());
141             final View editFrame = mSearchView.findViewById(
142                     com.android.internal.R.id.search_edit_frame);
143             final LinearLayout.LayoutParams params = (LinearLayout.LayoutParams) editFrame
144                     .getLayoutParams();
145             params.setMarginStart(0);
146             params.setMarginEnd(0);
147             editFrame.setLayoutParams(params);
148         }
149     }
150 
151     @Override
onQueryTextSubmit(String query)152     public boolean onQueryTextSubmit(String query) {
153         return false;
154     }
155 
156     @Override
onQueryTextChange(String newText)157     public boolean onQueryTextChange(String newText) {
158         if (mAdapter != null) {
159             mAdapter.getFilter().filter(newText);
160         }
161         return false;
162     }
163 
164     public interface OnListItemClickListener<T extends BaseTimeZoneAdapter.AdapterItem> {
onListItemClick(T item)165         void onListItemClick(T item);
166     }
167 
168 }
169