Leanback UI ツールキット ライブラリ

Leanback UI ツールキットには、Android TV OS 用に開発されたアプリ専用のテレビ固有のライブラリがいくつか用意されています。これらのライブラリには次のものがあります。

• Leanback ライブラリ: Android TV アプリの作成を簡素化する UI テンプレートを提供します。
• Leanback Preferences ライブラリ: プラットフォームと一致する設定画面を提供しますが、アプリに合わせてテーマを設定できます。
• Leanback ページング ライブラリ: ObjectAdapters 用の AndroidX ページング モデルをサポートします。Leanback テンプレートでよく使用されます。
• Leanback Tabs ライブラリ: Android TV でタブ形式のナビゲーションをサポートします。

Leanback ページング ライブラリ

Leanback UI ツールキット内のページングは AndroidX の Paging 3 ライブラリと同じように機能し、RecyclerView.Adapter へのページングの追加が簡単になります。Leanback ページング ライブラリでは、公開されるアダプターは通常、代わりに ObjectAdapter であるため、ライブラリは ObjectAdapter にページングのサポートを追加します。

アプリにページング アダプターを追加するには、まずライブラリの依存関係をプロジェクトに追加します。

implementation "androidx.leanback:leanback-paging:$version"

次に、androidx.paging.PagingDataAdapter ではなく androidx.leanback.paging.PagingDataAdapter を使用して、Paging 3 のドキュメントに従います。唯一の違いは、Presenter または PresenterSelector を渡せるようになったことです。これは、ListRow のように、ObjectAdapter を通常使用する場所であればどこでも機能します。

val adapter: PagingDataAdapter<MyItem> = PagingDataAdapter(myPresenter,
   object : DiffUtil.ItemCallback<MyItem>() {
       override fun areItemsTheSame(
           oldItem: MyItem,
           newItem: MyItem
       ): Boolean {
           return oldItem.id === newItem.id
       }

       override fun areContentsTheSame(
           oldItem: MyItem,
           newItem: MyItem
       ): Boolean {
           return oldItem == newItem
       }
   })

val header = HeaderItem(headerTitle)
val row = ListRow(header, adapter)

PagingDataAdapter<MyItem> adapter = new PagingDataAdapter(myPresenter, new DiffUtil.ItemCallback<MyItem>() {
    @Override
    public boolean areItemsTheSame(@NonNull MyItem oldItem, @NonNull MyItem newItem) {
        return oldItem.getId().equals(newItem.getId());
    }

    @Override
    public boolean areContentsTheSame(@NonNull MyItem oldItem, @NonNull MyItem newItem) {
        return oldItem.equals(newItem);
    }
});

HeaderItem header = new HeaderItem(headerTitle);
Row row = new ListRow(header, adapter);

Leanback Tabs ライブラリ

Leanback UI ツールキット テンプレートは、参照画面にサイド ナビゲーションを提供します。アプリの上部にタブの行を横方向に追加するには、代わりに Leanback Tabs を使用します。

プロジェクトにライブラリ依存関係を追加します。

implementation "androidx.leanback:leanback-tab:$version"

次に、既存の ViewPager ガイドに沿って、LeanbackTabLayout と LeanbackViewPager を使用してタブを実装します。LeanbackViewPager は ViewPager2 ではなく ViewPager に基づいています。

次に例を示します。

val leanbackTabLayout = findViewById<LeanbackTabLayout>(R.id.tab_layout)
val leanbackViewPager = findViewById<LeanbackViewPager>(R.id.view_pager)

leanbackViewPager.setAdapter(adapter)
leanbackTabLayout.setupWithViewPager(leanbackViewPager)

LeanbackTabLayout leanbackTabLayout = findViewById(R.id.tab_layout);
LeanbackViewPager leanbackViewPager = findViewById(R.id.view_pager);

leanbackViewPager.setAdapter(adapter);
leanbackTabLayout.setupWithViewPager(leanbackViewPager);

制限事項

Leanback Tabs ライブラリには、サポートするテーマとフォーカス移動の処理方法に制限があります。

サポートされているテーマ

Theme.AppCompat から派生したテーマのみがサポートされています。TabLayout にはテーマ適用の制約が含まれており、Theme.AppCompat の子孫ではないテーマが使用されなくなります。また、Leanback UI ツールキットのブリッジテーマを使用することもできます。

タブから上部へのフォーカス移動

レイアウトの高さが画面の高さよりも大きいときに D-pad の上ボタンを押すと、コントロールはフラグメント内にとどまってその上にあるアイテムに移動するのではなく、タブに戻ります（図 1 を参照）。この問題に対処するには、フラグメント内のコンテンツでフォーカス検索をオーバーライドする必要があります。たとえば、RowsSupportFragment を使用します。BrowseSupportFragment は、オーバーライドされたフォーカス検索メソッドが含まれているため、タブ内では使用できません。