TitleViewAdapter
abstract class 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 types |
|---|
interface TitleViewAdapter.ProviderInterface to be implemented by a customized widget class to implement |
Public constructors |
|---|
Public functions |
|
|---|---|
Drawable! |
Returns the badge drawable. |
SearchOrbView.Colors! |
Returns the |
abstract View! |
Returns the view for the search affordance. |
CharSequence! |
getTitle()Returns the title text. |
Unit |
setAnimationEnabled(enable: Boolean)Enables or disables any view animations. |
Unit |
setBadgeDrawable(drawable: Drawable!)Sets the badge drawable. |
Unit |
setOnSearchClickedListener(listener: View.OnClickListener!)Sets a click listener for the search affordance view. |
Unit |
Sets the |
Unit |
setTitle(titleText: CharSequence!)Sets the title text. |
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
Public constructors
Public functions
getBadgeDrawable
fun getBadgeDrawable(): Drawable!
Returns the badge drawable.
| Returns | |
|---|---|
Drawable! |
The badge drawable. |
getSearchAffordanceColors
fun getSearchAffordanceColors(): SearchOrbView.Colors!
Returns the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.
| Returns | |
|---|---|
SearchOrbView.Colors! |
Colors used to draw search affordance. |
getSearchAffordanceView
abstract fun getSearchAffordanceView(): View!
Returns the view for the search affordance.
| Returns | |
|---|---|
View! |
The view for search affordance. |
getTitle
fun getTitle(): CharSequence!
Returns the title text.
| Returns | |
|---|---|
CharSequence! |
The title text. |
setAnimationEnabled
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
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
fun setOnSearchClickedListener(listener: View.OnClickListener!): Unit
Sets a click listener for the search affordance view.
The presence of a listener will change the visibility of the search affordance in the fragment title. When set to non-null, the title will contain an element that a user may click to begin a search.
The listener's onClick method will be invoked when the user clicks on the search element.
| Parameters | |
|---|---|
listener: View.OnClickListener! |
The listener to call when the search element is clicked. |
setSearchAffordanceColors
fun setSearchAffordanceColors(colors: SearchOrbView.Colors): Unit
Sets the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.
| Parameters | |
|---|---|
colors: SearchOrbView.Colors |
Colors used to draw search affordance. |
setTitle
fun setTitle(titleText: CharSequence!): Unit
Sets the title text.
| Parameters | |
|---|---|
titleText: CharSequence! |
The text to set as title. |
updateComponentsVisibility
fun updateComponentsVisibility(flags: Int): Unit
Based on the flag, it updates the visibility of the individual components - Branding views (badge drawable and/or title) and search affordance view.
| Parameters | |
|---|---|
flags: Int |
integer representing the visibility of TitleView components. |