TitleViewAdapter
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.ProviderInterface to be implemented by a customized widget class to implement |
Constants |
|
|---|---|
static final int |
|
static final int |
|
static final int |
Public constructors |
|---|
Public methods |
|
|---|---|
Drawable |
Returns the badge drawable. |
SearchOrbView.Colors |
Returns the |
abstract View |
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 |
Sets a click listener for the search affordance view. |
void |
Sets the |
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
Public constructors
Public methods
getBadgeDrawable
public Drawable getBadgeDrawable()
Returns the badge drawable.
| Returns | |
|---|---|
Drawable |
The badge drawable. |
getSearchAffordanceColors
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
public abstract View getSearchAffordanceView()
Returns the view for the search affordance.
| Returns | |
|---|---|
View |
The view for search affordance. |
getTitle
public CharSequence getTitle()
Returns the title text.
| Returns | |
|---|---|
CharSequence |
The title text. |
setAnimationEnabled
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
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
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
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
public void setTitle(CharSequence titleText)
Sets the title text.
| Parameters | |
|---|---|
CharSequence titleText |
The text to set as title. |
updateComponentsVisibility
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. |