Leanback 界面工具包库

Leanback 界面工具包为专为 Android TV OS 开发的应用提供了一些电视专用库。这些库包括:

  • Leanback 库:提供可简化 Android TV 应用的创建流程的界面模板。
  • Leanback Preferences 库:提供与平台一致的偏好设置和设置界面,但可以设置与您的应用相匹配的主题。
  • Leanback Paging 库:支持 ObjectAdapters 的 AndroidX 分页模型,该模型通常与 Leanback 模板一起使用。
  • Leanback Tabs 库:支持 Android TV 上的标签页式导航。

Leanback Paging 库

Leanback 界面工具包中的 Paging 的运作方式与 AndroidX Paging 3 库相同,后者简化了向 RecyclerView.Adapter 添加 Paging 的过程。使用 Leanback Paging 库时,公开的适配器通常是 ObjectAdapter,因此该库向 ObjectAdapter 添加了分页支持。

如需向应用添加分页适配器,请先将库依赖项添加到项目中:

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

然后,按照 Paging 3 文档中的说明进行操作,使用 androidx.leanback.paging.PagingDataAdapter 而不是 androidx.paging.PagingDataAdapter。唯一的区别是您现在可以传入 PresenterPresenterSelector。这适用于您通常使用 ObjectAdapter 的任何位置,例如在 ListRow 中:

Kotlin

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)

Java

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 标签页库

Leanback 界面工具包模板可在浏览屏幕中提供侧边导航。如需在应用顶部水平添加一行标签页,您可以改用 Leanback 标签页。

为您的项目添加库依赖项:

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

然后,按照现有的 ViewPager 指南,使用 LeanbackTabLayoutLeanbackViewPager 实现标签页。请注意,LeanbackViewPager 基于 ViewPager,而不是 ViewPager2

示例如下:

Kotlin

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

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

Java

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 界面工具包。

将焦点从标签页移至顶部

当布局高度大于屏幕高度并且当您按方向键向上按钮时,控件会移回标签页,而不是留在 fragment 内并导航到它上方的项(见图 1)。如需解决此问题,fragment 内的内容必须替换焦点搜索;例如使用 RowsSupportFragmentBrowseSupportFragment 无法在标签页内使用,因为它具有已替换的焦点搜索方法,会阻止焦点移回标签页。

图 1.使用方向键向上键可将焦点移到标签页上,而不是移到上一项。