ユーザーがテレビでメディアアプリを使用する際、特定のコンテンツを念頭に置いていることがよくあります。アプリに大量のコンテンツ カタログが含まれている場合、特定のタイトルのブラウジングは、ユーザーが探しているコンテンツを見つける最も効率的な方法ではないことがあります。検索インターフェースを使用すると、ユーザーはブラウジングするよりも早く必要なコンテンツにアクセスできます。
androidx.leanback ライブラリには、アプリ内で標準の検索インターフェースを有効にするクラスのセットが用意されています。この検索インターフェースはテレビの他の検索機能と整合し、音声入力などの機能も提供します。
このガイドでは、Leanback サポート ライブラリ クラスを使用してアプリに検索インターフェースを提供する方法について説明します。
検索アクションを追加する
メディア ブラウジング インターフェースに BrowseFragment
クラスを使用すると、検索インターフェースをユーザー インターフェースの標準部分として有効にできます。検索インターフェースは、BrowseFragment
オブジェクトで View.OnClickListener
を設定するとレイアウトに表示されるアイコンです。次のサンプルコードは、この方法を示しています。
Kotlin
override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.browse_activity) browseFragment = fragmentManager.findFragmentById(R.id.browse_fragment) as BrowseFragment browseFragment.setOnSearchClickedListener { view -> val intent = Intent(this@BrowseActivity, SearchActivity::class.java) startActivity(intent) } browseFragment.setAdapter(buildAdapter()) }
Java
@Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.browse_activity); browseFragment = (BrowseFragment) getFragmentManager().findFragmentById(R.id.browse_fragment); ... browseFragment.setOnSearchClickedListener(new View.OnClickListener() { @Override public void onClick(View view) { Intent intent = new Intent(BrowseActivity.this, SearchActivity.class); startActivity(intent); } }); browseFragment.setAdapter(buildAdapter()); }
注: setSearchAffordanceColor(int)
メソッドを使用して、検索アイコンの色を設定できます。
検索入力と検索結果を追加する
ユーザーが検索アイコンを選択すると、システムは定義されたインテントを使用して検索アクティビティを呼び出します。検索アクティビティには、SearchFragment
を含む線形レイアウトを使用します。このフラグメントは、検索結果を表示するために SearchFragment.SearchResultProvider
インターフェースも実装する必要があります。
次のコードサンプルは、SearchFragment
クラスを拡張して検索インターフェースと結果を提供する方法を示しています。
Kotlin
class MySearchFragment : SearchFragment(), SearchFragment.SearchResultProvider { private val rowsAdapter = ArrayObjectAdapter(ListRowPresenter()) private val handler = Handler() private val delayedLoad = SearchRunnable() val resultsAdapter: ObjectAdapter get() { return rowsAdapter } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setSearchResultProvider(this) setOnItemClickedListener(getDefaultItemClickedListener()) } fun onQueryTextChange(newQuery: String): Boolean { rowsAdapter.clear() if (!TextUtils.isEmpty(newQuery)) { delayedLoad.setSearchQuery(newQuery) handler.removeCallbacks(delayedLoad) handler.postDelayed(delayedLoad, SEARCH_DELAY_MS) } return true } fun onQueryTextSubmit(query: String): Boolean { rowsAdapter.clear() if (!TextUtils.isEmpty(query)) { delayedLoad.setSearchQuery(query) handler.removeCallbacks(delayedLoad) handler.postDelayed(delayedLoad, SEARCH_DELAY_MS) } return true } companion object { private val SEARCH_DELAY_MS = 300 } }
Java
public class MySearchFragment extends SearchFragment implements SearchFragment.SearchResultProvider { private static final int SEARCH_DELAY_MS = 300; private ArrayObjectAdapter rowsAdapter; private Handler handler = new Handler(); private SearchRunnable delayedLoad; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); rowsAdapter = new ArrayObjectAdapter(new ListRowPresenter()); setSearchResultProvider(this); setOnItemClickedListener(getDefaultItemClickedListener()); delayedLoad = new SearchRunnable(); } @Override public ObjectAdapter getResultsAdapter() { return rowsAdapter; } @Override public boolean onQueryTextChange(String newQuery) { rowsAdapter.clear(); if (!TextUtils.isEmpty(newQuery)) { delayedLoad.setSearchQuery(newQuery); handler.removeCallbacks(delayedLoad); handler.postDelayed(delayedLoad, SEARCH_DELAY_MS); } return true; } @Override public boolean onQueryTextSubmit(String query) { rowsAdapter.clear(); if (!TextUtils.isEmpty(query)) { delayedLoad.setSearchQuery(query); handler.removeCallbacks(delayedLoad); handler.postDelayed(delayedLoad, SEARCH_DELAY_MS); } return true; } }
上記のサンプルコードは、別のスレッドで検索クエリを実行する SearchRunnable
クラスと一緒に使用することを想定しています。これにより、実行速度が遅い可能性のあるクエリがメインのユーザー インターフェース スレッドをブロックするのを回避できます。