BrandedFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

public class BrandedFragment extends Fragment

java.lang.Object
↳	android.app.Fragment
	↳	androidx.leanback.app.BrandedFragment

Known direct subclasses

BaseFragment, ErrorFragment

BaseFragment

This class is deprecated.

use BaseSupportFragment

ErrorFragment

This class is deprecated.

use ErrorSupportFragment

Known indirect subclasses

BrowseFragment, DetailsFragment, VerticalGridFragment

BrowseFragment

This class is deprecated.

use BrowseSupportFragment

DetailsFragment

This class is deprecated.

use DetailsSupportFragment

VerticalGridFragment

This class is deprecated.

use VerticalGridSupportFragment

Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider.

Summary

Public constructors
`BrandedFragment()`

Public methods
`@Nullable Drawable`	`getBadgeDrawable()` Returns the badge drawable used in the fragment title.
`int`	`getSearchAffordanceColor()` Returns the color used to draw the search affordance.
`@Nullable SearchOrbView.Colors`	`getSearchAffordanceColors()` Returns the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`@Nullable CharSequence`	`getTitle()` Returns the title text for the fragment.
`@Nullable View`	`getTitleView()` Returns the view that implements `TitleViewAdapter.Provider`.
`@Nullable TitleViewAdapter`	`getTitleViewAdapter()` Returns the `TitleViewAdapter` implemented by title view.
`void`	`installTitleView( @NonNull LayoutInflater inflater, @NonNull ViewGroup parent, @Nullable Bundle savedInstanceState )` Inflate title view and add to parent.
`final boolean`	`isShowingTitle()` Returns true/false to indicate the visibility of TitleView.
`void`	`onDestroyView()` This method is deprecated.
`@NonNull View`	`onInflateTitleView( @NonNull LayoutInflater inflater, @Nullable ViewGroup parent, @Nullable Bundle savedInstanceState )` Called by `installTitleView` to inflate title view.
`void`	`onPause()` This method is deprecated.
`void`	`onResume()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` This method is deprecated.
`void`	`setBadgeDrawable(@Nullable Drawable drawable)` Sets the drawable displayed in the fragment title.
`void`	`setOnSearchClickedListener(@Nullable View.OnClickListener listener)` Sets a click listener for the search affordance.
`void`	`setSearchAffordanceColor(int color)` Sets the color used to draw the search affordance.
`void`	`setSearchAffordanceColors(@NonNull SearchOrbView.Colors colors)` Sets the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`void`	`setTitle(@Nullable CharSequence title)` Sets title text for the fragment.
`void`	`setTitleView(@Nullable View titleView)` Sets the view that implemented `TitleViewAdapter`.
`void`	`showTitle(int flags)` Changes title view's components visibility and shows title.
`void`	`showTitle(boolean show)` Shows or hides the title view.

Inherited Constants

From android.content.ComponentCallbacks2

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80` This field is deprecated.
`static final int`	`TRIM_MEMORY_MODERATE = 60` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This field is deprecated.
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited methods

From android.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` This method is deprecated.
`final boolean`	`equals(Object o)` This method is deprecated.
`final Activity`	`getActivity()` This method is deprecated.
`boolean`	`getAllowEnterTransitionOverlap()` This method is deprecated.
`boolean`	`getAllowReturnTransitionOverlap()` This method is deprecated.
`final Bundle`	`getArguments()` This method is deprecated.
`final FragmentManager`	`getChildFragmentManager()` This method is deprecated.
`Context`	`getContext()` This method is deprecated.
`Transition`	`getEnterTransition()` This method is deprecated.
`Transition`	`getExitTransition()` This method is deprecated.
`final FragmentManager`	`getFragmentManager()` This method is deprecated.
`final Object`	`getHost()` This method is deprecated.
`final int`	`getId()` This method is deprecated.
`final LayoutInflater`	`getLayoutInflater()` This method is deprecated.
`LoaderManager`	`getLoaderManager()` This method is deprecated.
`final Fragment`	`getParentFragment()` This method is deprecated.
`Transition`	`getReenterTransition()` This method is deprecated.
`final Resources`	`getResources()` This method is deprecated.
`final boolean`	`getRetainInstance()` This method is deprecated.
`Transition`	`getReturnTransition()` This method is deprecated.
`Transition`	`getSharedElementEnterTransition()` This method is deprecated.
`Transition`	`getSharedElementReturnTransition()` This method is deprecated.
`final String`	`getString(int resId)` This method is deprecated.
`final String`	`getTag()` This method is deprecated.
`final Fragment`	`getTargetFragment()` This method is deprecated.
`final int`	`getTargetRequestCode()` This method is deprecated.
`final CharSequence`	`getText(int resId)` This method is deprecated.
`boolean`	`getUserVisibleHint()` This method is deprecated.
`View`	`getView()` This method is deprecated.
`final int`	`hashCode()` This method is deprecated.
`static Fragment`	`instantiate(Context context, String fname)` This method is deprecated.
`final boolean`	`isAdded()` This method is deprecated.
`final boolean`	`isDetached()` This method is deprecated.
`final boolean`	`isHidden()` This method is deprecated.
`final boolean`	`isInLayout()` This method is deprecated.
`final boolean`	`isRemoving()` This method is deprecated.
`final boolean`	`isResumed()` This method is deprecated.
`final boolean`	`isStateSaved()` This method is deprecated.
`final boolean`	`isVisible()` This method is deprecated.
`void`	`onActivityCreated(Bundle savedInstanceState)` This method is deprecated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` This method is deprecated.
`void`	`onAttach(Activity activity)` This method is deprecated.
`void`	`onAttachFragment(Fragment childFragment)` This method is deprecated.
`void`	`onConfigurationChanged(Configuration newConfig)` This method is deprecated.
`boolean`	`onContextItemSelected(MenuItem item)` This method is deprecated.
`void`	`onCreate(Bundle savedInstanceState)` This method is deprecated.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` This method is deprecated.
`void`	`onCreateContextMenu( ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo )` This method is deprecated.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` This method is deprecated.
`View`	`onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroy()` This method is deprecated.
`void`	`onDestroyOptionsMenu()` This method is deprecated.
`void`	`onDetach()` This method is deprecated.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` This method is deprecated.
`void`	`onHiddenChanged(boolean hidden)` This method is deprecated.
`void`	`onInflate( Activity activity, AttributeSet attrs, Bundle savedInstanceState )` This method is deprecated.
`void`	`onLowMemory()` This method is deprecated.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` This method is deprecated.
`boolean`	`onOptionsItemSelected(MenuItem item)` This method is deprecated.
`void`	`onOptionsMenuClosed(Menu menu)` This method is deprecated.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` This method is deprecated.
`void`	`onPrepareOptionsMenu(Menu menu)` This method is deprecated.
`void`	`onRequestPermissionsResult( int requestCode, String[] permissions, int[] grantResults )` This method is deprecated.
`void`	`onStop()` This method is deprecated.
`void`	`onTrimMemory(int level)` This method is deprecated.
`void`	`onViewStateRestored(Bundle savedInstanceState)` This method is deprecated.
`void`	`postponeEnterTransition()` This method is deprecated.
`void`	`registerForContextMenu(View view)` This method is deprecated.
`final void`	`requestPermissions(String[] permissions, int requestCode)` This method is deprecated.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` This method is deprecated.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` This method is deprecated.
`void`	`setArguments(Bundle args)` This method is deprecated.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` This method is deprecated.
`void`	`setEnterTransition(Transition transition)` This method is deprecated.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` This method is deprecated.
`void`	`setExitTransition(Transition transition)` This method is deprecated.
`void`	`setHasOptionsMenu(boolean hasMenu)` This method is deprecated.
`void`	`setInitialSavedState(Fragment.SavedState state)` This method is deprecated.
`void`	`setMenuVisibility(boolean menuVisible)` This method is deprecated.
`void`	`setReenterTransition(Transition transition)` This method is deprecated.
`void`	`setRetainInstance(boolean retain)` This method is deprecated.
`void`	`setReturnTransition(Transition transition)` This method is deprecated.
`void`	`setSharedElementEnterTransition(Transition transition)` This method is deprecated.
`void`	`setSharedElementReturnTransition(Transition transition)` This method is deprecated.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` This method is deprecated.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` This method is deprecated.
`void`	`startActivity(Intent intent)` This method is deprecated.
`void`	`startActivityForResult(Intent intent, int requestCode)` This method is deprecated.
`void`	`startIntentSenderForResult( IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options )` This method is deprecated.
`void`	`startPostponedEnterTransition()` This method is deprecated.
`String`	`toString()` This method is deprecated.
`void`	`unregisterForContextMenu(View view)` This method is deprecated.

Public constructors

BrandedFragment

Added in 1.1.0

Deprecated in 1.1.0

public BrandedFragment()

Public methods

getBadgeDrawable

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable Drawable getBadgeDrawable()

Returns the badge drawable used in the fragment title.

Returns
`@Nullable Drawable`	The badge drawable used in the fragment title.

getSearchAffordanceColor

Added in 1.1.0

Deprecated in 1.1.0

public int getSearchAffordanceColor()

Returns the color used to draw the search affordance.

getSearchAffordanceColors

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable SearchOrbView.Colors getSearchAffordanceColors()

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

getTitle

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable CharSequence getTitle()

Returns the title text for the fragment.

Returns
`@Nullable CharSequence`	Title text for the fragment.

getTitleView

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable View getTitleView()

Returns the view that implements TitleViewAdapter.Provider.

Returns
`@Nullable View`	The view that implements `TitleViewAdapter.Provider`.

getTitleViewAdapter

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable TitleViewAdapter getTitleViewAdapter()

Returns the TitleViewAdapter implemented by title view.

Returns
`@Nullable TitleViewAdapter`	The `TitleViewAdapter` implemented by title view.

installTitleView

Added in 1.1.0

Deprecated in 1.1.0

public void installTitleView(
    @NonNull LayoutInflater inflater,
    @NonNull ViewGroup parent,
    @Nullable Bundle savedInstanceState
)

Inflate title view and add to parent. This method should be called in onCreateView.

Parameters
`@NonNull LayoutInflater inflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`@NonNull ViewGroup parent`	Parent of title view.
`@Nullable Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

isShowingTitle

Added in 1.1.0

Deprecated in 1.1.0

public final boolean isShowingTitle()

Returns true/false to indicate the visibility of TitleView.

Returns
`boolean`	boolean to indicate whether or not it's showing the title.

onDestroyView

Added in 1.1.0

Deprecated in 1.1.0

public void onDestroyView()

onInflateTitleView

Added in 1.1.0

Deprecated in 1.1.0

public @NonNull View onInflateTitleView(
    @NonNull LayoutInflater inflater,
    @Nullable ViewGroup parent,
    @Nullable Bundle savedInstanceState
)

Called by installTitleView to inflate title view. Default implementation uses layout file lb_browse_title. Subclass may override and use its own layout, the layout must have a descendant with id browse_title_group that implements TitleViewAdapter.Provider. Subclass may return null if no title is needed.

Parameters
`@NonNull LayoutInflater inflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`@Nullable ViewGroup parent`	Parent of title view.
`@Nullable Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`@NonNull View`	Title view which must have a descendant with id browse_title_group that implements `TitleViewAdapter.Provider`, or null for no title view.

onPause

Added in 1.1.0

Deprecated in 1.1.0

public void onPause()

onResume

Added in 1.1.0

Deprecated in 1.1.0

public void onResume()

onSaveInstanceState

Added in 1.1.0

Deprecated in 1.1.0

public void onSaveInstanceState(Bundle outState)

onStart

Added in 1.1.0

Deprecated in 1.1.0

public void onStart()

onViewCreated

Added in 1.1.0

Deprecated in 1.1.0

public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)

setBadgeDrawable

Added in 1.1.0

Deprecated in 1.1.0

public void setBadgeDrawable(@Nullable Drawable drawable)

Sets the drawable displayed in the fragment title.

Parameters
`@Nullable Drawable drawable`	The Drawable to display in the fragment title.

setOnSearchClickedListener

Added in 1.1.0

Deprecated in 1.1.0

public void setOnSearchClickedListener(@Nullable View.OnClickListener listener)

Sets a click listener for the search affordance.

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

setSearchAffordanceColor

Added in 1.1.0

Deprecated in 1.1.0

public void setSearchAffordanceColor(int color)

Sets the color used to draw the search affordance. A default brighter color will be set by the framework.

Parameters
`int color`	The color to use for the search affordance.

Added in 1.1.0

Deprecated 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

Deprecated in 1.1.0

public void setTitle(@Nullable CharSequence title)

Sets title text for the fragment.

Parameters
`@Nullable CharSequence title`	The title text of the fragment.

setTitleView

Added in 1.1.0

Deprecated in 1.1.0

public void setTitleView(@Nullable View titleView)

Sets the view that implemented TitleViewAdapter.

Parameters
`@Nullable View titleView`	The view that implemented `TitleViewAdapter.Provider`.

showTitle

Added in 1.1.0

Deprecated in 1.1.0

public void showTitle(int flags)

Changes title view's components visibility and shows title.

Parameters
`int flags`	Flags representing the visibility of components inside title view.

See also
`SEARCH_VIEW_VISIBLE`
`BRANDING_VIEW_VISIBLE`
`FULL_VIEW_VISIBLE`
`updateComponentsVisibility`

showTitle

Added in 1.1.0

Deprecated in 1.1.0

public void showTitle(boolean show)

Shows or hides the title view.

Parameters
`boolean show`	True to show title view, false to hide title view.