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 to be implemented by a customized widget class to implement TitleViewAdapter.

Constants

const Int
const Int
const Int

Public constructors

Public functions

Drawable!

Returns the badge drawable.

SearchOrbView.Colors!

Returns the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.

abstract View!

Returns the view for the search affordance.

CharSequence!

Returns the title text.

Unit

Enables or disables any view animations.

Unit

Sets the badge drawable.

Unit

Sets a click listener for the search affordance view.

Unit

Sets the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.

Unit
setTitle(titleText: CharSequence!)

Sets the title text.

Unit

Based on the flag, it updates the visibility of the individual components - Branding views (badge drawable and/or title) and search affordance view.

Constants

BRANDING_VIEW_VISIBLE

Added in 1.1.0
const val BRANDING_VIEW_VISIBLE = 2: Int

FULL_VIEW_VISIBLE

Added in 1.1.0
const val FULL_VIEW_VISIBLE = 6: Int

SEARCH_VIEW_VISIBLE

Added in 1.1.0
const val SEARCH_VIEW_VISIBLE = 4: Int

Public constructors

TitleViewAdapter

Added in 1.1.0
TitleViewAdapter()

Public functions

getBadgeDrawable

Added in 1.1.0
fun getBadgeDrawable(): Drawable!

Returns the badge drawable.

Returns
Drawable!

The badge drawable.

getSearchAffordanceColors

Added in 1.1.0
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

Added in 1.1.0
abstract fun getSearchAffordanceView(): View!

Returns the view for the search affordance.

Returns
View!

The view for search affordance.

getTitle

Added in 1.1.0
fun getTitle(): CharSequence!

Returns the title text.

Returns
CharSequence!

The title text.

setAnimationEnabled

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
fun setTitle(titleText: CharSequence!): Unit

Sets the title text.

Parameters
titleText: CharSequence!

The text to set as title.

updateComponentsVisibility

Added in 1.1.0
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.