TitleViewAdapter
abstract class TitleViewAdapter
| kotlin.Any | |
| ↳ | androidx.leanback.widget.TitleViewAdapter |
This class allows a customized widget class to implement TitleViewAdapter.Provider and expose TitleViewAdapter methods to containing fragment (e.g. BrowseFragment or DetailsFragment). The title view must have a search orb view (getSearchAffordanceView() aligned to start and can typically have a branding Drawable and or title text aligned to end. The branding part is fully open to customization: not necessary to be a drawable or text.
Summary
| Nested classes | |
|---|---|
| abstract |
Interface to be implemented by a customized widget class to implement |
| Constants | |
|---|---|
| static Int | |
| static Int | |
| static Int | |
| Public constructors | |
|---|---|
<init>()This class allows a customized widget class to implement |
|
| Public methods | |
|---|---|
| open Drawable! |
Returns the badge drawable. |
| open SearchOrbView.Colors! |
Returns the |
| abstract View! |
Returns the view for the search affordance. |
| open CharSequence! |
getTitle()Returns the title text. |
| open Unit |
setAnimationEnabled(enable: Boolean)Enables or disables any view animations. |
| open Unit |
setBadgeDrawable(drawable: Drawable!)Sets the badge drawable. |
| open Unit |
setOnSearchClickedListener(listener: OnClickListener!)Sets a click listener for the search affordance view. |
| open Unit |
Sets the |
| open Unit |
setTitle(titleText: CharSequence!)Sets the title text. |
| open Unit |
updateComponentsVisibility(flags: Int)Based on the flag, it updates the visibility of the individual components - Branding views (badge drawable and/or title) and search affordance view. |
Constants
FULL_VIEW_VISIBLE
static val FULL_VIEW_VISIBLE: Int
Value: BRANDING_VIEW_VISIBLE | SEARCH_VIEW_VISIBLE
Public constructors
<init>
TitleViewAdapter()
This class allows a customized widget class to implement TitleViewAdapter.Provider and expose TitleViewAdapter methods to containing fragment (e.g. BrowseFragment or DetailsFragment). The title view must have a search orb view (getSearchAffordanceView() aligned to start and can typically have a branding Drawable and or title text aligned to end. The branding part is fully open to customization: not necessary to be a drawable or text.
Public methods
getBadgeDrawable
open fun getBadgeDrawable(): Drawable!
Returns the badge drawable.
| Return | |
|---|---|
Drawable! |
The badge drawable. |
getSearchAffordanceColors
open fun getSearchAffordanceColors(): SearchOrbView.Colors!
Returns the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.
| Return | |
|---|---|
SearchOrbView.Colors! |
Colors used to draw search affordance. |
getSearchAffordanceView
abstract fun getSearchAffordanceView(): View!
Returns the view for the search affordance.
| Return | |
|---|---|
View! |
The view for search affordance. |
getTitle
open fun getTitle(): CharSequence!
Returns the title text.
| Return | |
|---|---|
CharSequence! |
The title text. |
setAnimationEnabled
open fun setAnimationEnabled(enable: Boolean): Unit
Enables or disables any view animations. This method is called to save CPU cycle for example stop search view breathing animation when containing fragment is paused.
| Parameters | |
|---|---|
enable |
Boolean: True to enable animation, false otherwise. |
setBadgeDrawable
open fun setBadgeDrawable(drawable: Drawable!): Unit
Sets the badge drawable. If non-null, the drawable is displayed instead of the title text.
| Parameters | |
|---|---|
drawable |
Drawable!: The badge drawable to set on title view. |
setOnSearchClickedListener
open fun setOnSearchC