belongs to Maven artifact androidx.leanback:leanback:1.0.0-alpha1

TitleView

public class TitleView
extends FrameLayout implements TitleViewAdapter.Provider

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ androidx.leanback.widget.TitleView


Title view for a leanback fragment.

Summary

Inherited constants

Inherited fields

Public constructors

TitleView(Context context)
TitleView(Context context, AttributeSet attrs)
TitleView(Context context, AttributeSet attrs, int defStyleAttr)

Public methods

void enableAnimation(boolean enable)

Enables or disables any view animations.

Drawable getBadgeDrawable()

Returns the badge drawable.

SearchOrbView.Colors getSearchAffordanceColors()

Returns the SearchOrbView.Colors used to draw the search affordance.

View getSearchAffordanceView()

Returns the view for the search affordance.

CharSequence getTitle()

Returns the title text.

TitleViewAdapter getTitleViewAdapter()

Returns TitleViewAdapter to be implemented by the customized widget class.

void setBadgeDrawable(Drawable drawable)

Sets the badge drawable.

void setOnSearchClickedListener(View.OnClickListener listener)

Sets the listener to be called when the search affordance is clicked.

void setSearchAffordanceColors(SearchOrbView.Colors colors)

Sets the 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 - BadgeView, TextView and SearchView.

Inherited methods

Public constructors

TitleView

TitleView (Context context)

Parameters
context Context

TitleView

TitleView (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

TitleView

TitleView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

Public methods

enableAnimation

void enableAnimation (boolean enable)

Enables or disables any view animations.

Parameters
enable boolean

getBadgeDrawable

Drawable getBadgeDrawable ()

Returns the badge drawable.

Returns
Drawable

getSearchAffordanceColors

SearchOrbView.Colors getSearchAffordanceColors ()

Returns the SearchOrbView.Colors used to draw the search affordance.

Returns
SearchOrbView.Colors

getSearchAffordanceView

View getSearchAffordanceView ()

Returns the view for the search affordance.

Returns
View

getTitle

CharSequence getTitle ()

Returns the title text.

Returns
CharSequence

getTitleViewAdapter

TitleViewAdapter getTitleViewAdapter ()

Returns TitleViewAdapter to be implemented by the customized widget class.

Returns
TitleViewAdapter TitleViewAdapter to be implemented by the customized widget class.

setBadgeDrawable

void setBadgeDrawable (Drawable drawable)

Sets the badge drawable. If non-null, the drawable is displayed instead of the title text.

Parameters
drawable Drawable

setOnSearchClickedListener

void setOnSearchClickedListener (View.OnClickListener listener)

Sets the listener to be called when the search affordance is clicked.

Parameters
listener View.OnClickListener

setSearchAffordanceColors

void setSearchAffordanceColors (SearchOrbView.Colors colors)

Sets the SearchOrbView.Colors used to draw the search affordance.

Parameters
colors SearchOrbView.Colors

setTitle

void setTitle (CharSequence titleText)

Sets the title text.

Parameters
titleText CharSequence

updateComponentsVisibility

void updateComponentsVisibility (int flags)

Based on the flag, it updates the visibility of the individual components - BadgeView, TextView and SearchView.

Parameters
flags int: integer representing the visibility of TitleView components.