Leanback UI 工具包程式庫

Leanback UI 工具包提供部分電視專用程式庫,專為 Android TV OS 開發的應用程式提供。這些程式庫包括:

  • Leanback 程式庫:提供 UI 範本,簡化建立 Android TV 應用程式的流程。
  • Leanback Preferences 程式庫:提供與平台一致的偏好設定和設定畫面,但可依據應用程式進行主題設定。
  • Leanback Paging 程式庫:支援 ObjectAdapters 的 AndroidX 分頁模型,通常與 Leanback 範本搭配使用。
  • Leanback Tabs 程式庫:支援 Android TV 上的分頁式瀏覽功能。

Leanback Paging 程式庫

Leanback UI 工具包中的分頁功能與 AndroidX Paging 3 程式庫中的分頁功能相同,後者可簡化在 RecyclerView.Adapter 中新增分頁的過程。使用 Leanback Paging 程式庫時,公開的轉接程式通常改為 ObjectAdapter,因此程式庫會為 ObjectAdapter 新增分頁支援。

如要在應用程式中新增分頁轉接器,請先將程式庫依附元件新增至專案:

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

接著,請使用 androidx.leanback.paging.PagingDataAdapter (而非 androidx.paging.PagingDataAdapter) 參閱 Paging 3 說明文件。唯一的差別在於,您現在已經可以傳入 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 UI 工具包範本可在瀏覽畫面中提供側邊導覽。如要在應用程式頂端水平新增一列分頁,可以改用 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 分頁程式庫對於支援的主題和處理焦點移動的方式有所限制。

支援的主題

系統僅支援衍生自 Theme.AppCompat 的主題。TabLayout 包含主題強制執行限制,可防止使用 Theme.AppCompat 的任何非延伸主題。您也可以使用橋接主題搭配 Leanback UI 工具包。

焦點移至分頁頂端

如果版面配置高度超過螢幕高度,而您按下 D-Pad 向上按鈕,控制項會移回分頁,而非停留在片段內,並瀏覽至上方的項目 (如圖 1 所示)。如要處理這個問題,片段中的內容必須覆寫焦點搜尋,例如使用 RowsSupportFragmentBrowseSupportFragment 具有覆寫的焦點搜尋方法,會造成焦點移回分頁,因此不得在分頁中使用。

圖 1.D-Pad 的向上按鈕會將焦點移至 Tab 鍵,而非上一個項目。