AllAppsSearchBarController.java revision 35d96306ad6d8c404cfaa90e1d68fb194a27a2fa
1ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung/* 2ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Copyright (C) 2015 The Android Open Source Project 3ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * 4ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Licensed under the Apache License, Version 2.0 (the "License"); 5ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * you may not use this file except in compliance with the License. 6ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * You may obtain a copy of the License at 7ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * 8ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * http://www.apache.org/licenses/LICENSE-2.0 9ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * 10ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Unless required by applicable law or agreed to in writing, software 11ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * distributed under the License is distributed on an "AS IS" BASIS, 12ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * See the License for the specific language governing permissions and 14ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * limitations under the License. 15ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 16ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chungpackage com.android.launcher3.allapps; 17ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 180ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.content.Context; 192494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyalimport android.content.Intent; 20ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chungimport android.graphics.Rect; 212494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyalimport android.net.Uri; 220ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.text.Editable; 230ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.text.TextWatcher; 240ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.view.KeyEvent; 25ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chungimport android.view.View; 260ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.view.inputmethod.EditorInfo; 270ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.view.inputmethod.InputMethodManager; 280ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.widget.TextView; 290ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport android.widget.TextView.OnEditorActionListener; 30ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 310ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport com.android.launcher3.ExtendedEditText; 329e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyalimport com.android.launcher3.Launcher; 330ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalimport com.android.launcher3.Utilities; 345183285847816cee9d0db6a8a7ab1a5929163e4eSunny Goyalimport com.android.launcher3.util.ComponentKey; 355183285847816cee9d0db6a8a7ab1a5929163e4eSunny Goyal 36ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chungimport java.util.ArrayList; 37ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 38ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung/** 39ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * An interface to a search box that AllApps can command. 40ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 410ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyalpublic abstract class AllAppsSearchBarController 42ce3fffb5fb446e031e52ee0c5f2a4a5cf86a8c81Sunny Goyal implements TextWatcher, OnEditorActionListener, ExtendedEditText.OnBackKeyListener { 43ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 449e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyal protected Launcher mLauncher; 45ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung protected AlphabeticalAppsList mApps; 46ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung protected Callbacks mCb; 470ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal protected ExtendedEditText mInput; 48f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song private String mQuery; 490ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 500ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal protected DefaultAppSearchAlgorithm mSearchAlgorithm; 510ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal protected InputMethodManager mInputMethodManager; 52ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 53645764e3e5fa34d9adcddfc722d726b76f048306Hyunyoung Song public void setVisibility(int visibility) { 54645764e3e5fa34d9adcddfc722d726b76f048306Hyunyoung Song mInput.setVisibility(visibility); 55645764e3e5fa34d9adcddfc722d726b76f048306Hyunyoung Song } 56ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 57ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Sets the references to the apps model and the search result callback. 58ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 590ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public final void initialize( 600ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal AlphabeticalAppsList apps, ExtendedEditText input, 619e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyal Launcher launcher, Callbacks cb) { 62ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung mApps = apps; 63ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung mCb = cb; 649e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyal mLauncher = launcher; 650ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 660ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput = input; 670ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput.addTextChangedListener(this); 680ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput.setOnEditorActionListener(this); 690ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput.setOnBackKeyListener(this); 700ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 710ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInputMethodManager = (InputMethodManager) 720ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput.getContext().getSystemService(Context.INPUT_METHOD_SERVICE); 730ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 740ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mSearchAlgorithm = onInitializeSearch(); 75ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung } 76ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 774919827990b16ae22595d0b7cb123a875961d9beSunny Goyal /** 782494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal * To be implemented by subclasses. This method will get called when the controller is set. 794919827990b16ae22595d0b7cb123a875961d9beSunny Goyal */ 802494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal protected abstract DefaultAppSearchAlgorithm onInitializeSearch(); 810ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 820ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal @Override 830ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public void beforeTextChanged(CharSequence s, int start, int count, int after) { 840ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal // Do nothing 850ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 860ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 870ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal @Override 880ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public void onTextChanged(CharSequence s, int start, int before, int count) { 890ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal // Do nothing 900ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 910ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 920ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal @Override 930ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public void afterTextChanged(final Editable s) { 94f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song mQuery = s.toString(); 95f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song if (mQuery.isEmpty()) { 960ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mSearchAlgorithm.cancel(true); 970ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mCb.clearSearchResult(); 980ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } else { 990ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mSearchAlgorithm.cancel(false); 100f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song mSearchAlgorithm.doSearch(mQuery, mCb); 101f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song } 102f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song } 103f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song 104f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song protected void refreshSearchResult() { 105f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song if (mQuery == null) { 106f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song return; 1070ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 108f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song // If play store continues auto updating an app, we want to show partial result. 109f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song mSearchAlgorithm.cancel(false); 110f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song mSearchAlgorithm.doSearch(mQuery, mCb); 1110ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1120ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 1130ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal @Override 1140ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public boolean onEditorAction(TextView v, int actionId, KeyEvent event) { 1150ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal // Skip if it's not the right action 1160ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal if (actionId != EditorInfo.IME_ACTION_SEARCH) { 1170ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal return false; 1180ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1199e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyal // Skip if the query is empty 1209e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyal String query = v.getText().toString(); 1219e3fee1427c0baa38564e20a9f351d1a87c25761Sunny Goyal if (query.isEmpty()) { 1220ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal return false; 1230ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1242494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal return mLauncher.startActivitySafely(v, createMarketSearchIntent(query), null); 1250ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1260ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 1270ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal @Override 1280ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public boolean onBackKey() { 1290ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal // Only hide the search field if there is no query, or if there 1300ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal // are no filtered results 1310ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal String query = Utilities.trim(mInput.getEditableText().toString()); 1320ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal if (query.isEmpty() || mApps.hasNoFilteredResults()) { 1330ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal reset(); 1340ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal return true; 1350ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1360ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal return false; 1370ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1380ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 1390ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal /** 1400ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal * Resets the search bar state. 1410ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal */ 1420ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public void reset() { 143f66b6802392bc473d7e1f86a58cf65b25ed2148cHyunyoung Song mQuery = null; 1440ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal unfocusSearchField(); 1450ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mCb.clearSearchResult(); 1460ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput.setText(""); 14735d96306ad6d8c404cfaa90e1d68fb194a27a2faPeter Schiller hideKeyboard(); 14835d96306ad6d8c404cfaa90e1d68fb194a27a2faPeter Schiller } 14935d96306ad6d8c404cfaa90e1d68fb194a27a2faPeter Schiller 15035d96306ad6d8c404cfaa90e1d68fb194a27a2faPeter Schiller protected void hideKeyboard() { 1510ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInputMethodManager.hideSoftInputFromWindow(mInput.getWindowToken(), 0); 1520ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1530ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal 1540ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal protected void unfocusSearchField() { 1550ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal View nextFocus = mInput.focusSearch(View.FOCUS_DOWN); 1560ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal if (nextFocus != null) { 1570ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal nextFocus.requestFocus(); 1580ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 1590ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 160ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 161ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 162ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Focuses the search field to handle key events. 163ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 1640ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public void focusSearchField() { 1650ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInput.requestFocus(); 1660ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal mInputMethodManager.showSoftInput(mInput, InputMethodManager.SHOW_IMPLICIT); 1670ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 168ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 169ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 170ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Returns whether the search field is focused. 171ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 1720ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal public boolean isSearchFieldFocused() { 1730ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal return mInput.isFocused(); 1740ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 175ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 176ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 1772494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal * Creates a new market search intent. 178ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 1792494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal public Intent createMarketSearchIntent(String query) { 1802494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal Uri marketSearchUri = Uri.parse("market://search") 1812494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal .buildUpon() 1822494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal .appendQueryParameter("c", "apps") 1832494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal .appendQueryParameter("q", query) 1842494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal .build(); 1852494c3f1681e71af06556ef47de16f018811f7e3Sunny Goyal return new Intent(Intent.ACTION_VIEW).setData(marketSearchUri); 1860ac7ede56afebe4401c0636196f5844be573ad68Sunny Goyal } 187ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 188ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 189ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Callback for getting search results. 190ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 191ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung public interface Callbacks { 192ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 193ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 194ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Called when the bounds of the search bar has changed. 195ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 19605c8c57fa72a81f34058036f6dc30c084ca6742bSunny Goyal @Deprecated 197ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung void onBoundsChanged(Rect newBounds); 198ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 199ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 200ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Called when the search is complete. 201ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * 202ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * @param apps sorted list of matching components or null if in case of failure. 203ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 2045183285847816cee9d0db6a8a7ab1a5929163e4eSunny Goyal void onSearchResult(String query, ArrayList<ComponentKey> apps); 205ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung 206ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung /** 207ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung * Called when the search results should be cleared. 208ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung */ 209ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung void clearSearchResult(); 210ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung } 211ef7f874a889b609bd34e692b9c9a1f8cefd1ea95Winson Chung}