TitleViewAdapter

Artifact: androidx.leanback:leanback

View Source

Added in 1.1.0

---

Kotlin |Java

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

Constants
static final int	BRANDING_VIEW_VISIBLE = 2
static final int	FULL_VIEW_VISIBLE = 6
static final int	SEARCH_VIEW_VISIBLE = 4

Public constructors
TitleViewAdapter()

Public methods
Drawable	getBadgeDrawable() Returns the badge drawable.
SearchOrbView.Colors	getSearchAffordanceColors() Returns the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.
abstract View	getSearchAffordanceView() Returns the view for the search affordance.
CharSequence	getTitle() Returns the title text.
void	setAnimationEnabled(boolean enable) Enables or disables any view animations.
void	setBadgeDrawable(Drawable drawable) Sets the badge drawable.
void	setOnSearchClickedListener(View.OnClickListener listener) Sets a click listener for the search affordance view.
void	setSearchAffordanceColors(@NonNull SearchOrbView.Colors colors) Sets the androidx.leanback.widget.SearchOrbView.Colors used to draw the search affordance.
void	setTitle(CharSequence titleText) Sets the title text.
void	updateComponentsVisibility(int flags) 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

public static final int BRANDING_VIEW_VISIBLE = 2

FULL_VIEW_VISIBLE

Added in 1.1.0

public static final int FULL_VIEW_VISIBLE = 6

SEARCH_VIEW_VISIBLE

Added in 1.1.0

public static final int SEARCH_VIEW_VISIBLE = 4

Public constructors

TitleViewAdapter

Added in 1.1.0

public TitleViewAdapter()

Public methods

getBadgeDrawable

Added in 1.1.0

public Drawable getBadgeDrawable()

Returns the badge drawable.

Returns
Drawable	The badge drawable.

getSearchAffordanceColors

Added in 1.1.0

public SearchOrbView.Colors getSearchAffordanceColors()

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

public abstract View getSearchAffordanceView()

Returns the view for the search affordance.

Returns
View	The view for search affordance.

getTitle

Added in 1.1.0

public CharSequence getTitle()

Returns the title text.

Returns
CharSequence	The title text.

setAnimationEnabled

Added in 1.1.0

public void setAnimationEnabled(boolean enable)

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
boolean enable	True to enable animation, false otherwise.

setBadgeDrawable

Added in 1.1.0

public void setBadgeDrawable(Drawable drawable)

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

public void setOnSearchClickedListener(View.OnClickListener listener)

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
View.OnClickListener listener	The listener to call when the search element is clicked.

setSearchAffordanceColors

Added in 1.1.0

public void setSearchAffordanceColors(@NonNull SearchOrbView.Colors colors)

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

Parameters
@NonNull SearchOrbView.Colors colors	Colors used to draw search affordance.

setTitle

Added in 1.1.0

public void setTitle(CharSequence titleText)

Sets the title text.

Parameters
CharSequence titleText	The text to set as title.

updateComponentsVisibility

Added in 1.1.0

public void updateComponentsVisibility(int flags)

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

Parameters
int flags	integer representing the visibility of TitleView components.

See also
BRANDING_VIEW_VISIBLE
SEARCH_VIEW_VISIBLE
FULL_VIEW_VISIBLE