added in version 24.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Deprecated since version 27.1.0

Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

BrandedFragment

public class BrandedFragment
extends Fragment

java.lang.Object
↳	android.app.Fragment
	↳	android.support.v17.leanback.app.BrandedFragment

Known Direct Subclasses

BaseFragment,ErrorFragment

Known Indirect Subclasses

BrowseFragment,DetailsFragment,VerticalGridFragment

This class was deprecated in API level 27.1.0.
use BrandedSupportFragment

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

Summary

Inherited constants

From interface


    android.content.ComponentCallbacks2

Public constructors
`BrandedFragment()`

Public methods
`Drawable`	`getBadgeDrawable()` Returns the badge drawable used in the fragment title.
`int`	`getSearchAffordanceColor()` Returns the color used to draw the search affordance.
`SearchOrbView.Colors`	`getSearchAffordanceColors()` Returns the `SearchOrbView.Colors` used to draw the search affordance.
`CharSequence`	`getTitle()` Returns the title text for the fragment.
`View`	`getTitleView()` Returns the view that implements `TitleViewAdapter.Provider`.
`TitleViewAdapter`	`getTitleViewAdapter()` Returns the `TitleViewAdapter` implemented by title view.
`void`	`installTitleView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)` Inflate title view and add to parent.
`final boolean`	`isShowingTitle()` Returns true/false to indicate the visibility of TitleView.
`void`	`onDestroyView()`
`View`	`onInflateTitleView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)` Called by `installTitleView(LayoutInflater, ViewGroup, Bundle)` to inflate title view.
`void`	`onPause()`
`void`	`onResume()`
`void`	`onSaveInstanceState(Bundle outState)`
`void`	`onStart()`
`void`	`onViewCreated(View view, Bundle savedInstanceState)`
`void`	`setBadgeDrawable(Drawable drawable)` Sets the drawable displayed in the fragment title.
`void`	`setOnSearchClickedListener(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(SearchOrbView.Colors colors)` Sets the `SearchOrbView.Colors` used to draw the search affordance.
`void`	`setTitle(CharSequence title)` Sets title text for the fragment.
`void`	`setTitleView(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 methods

From class


  
    android.app.Fragment

`void`	`dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)`
`final boolean`	`equals(Object arg0)`
`final Activity`	`getActivity()`
`boolean`	`getAllowEnterTransitionOverlap()`
`boolean`	`getAllowReturnTransitionOverlap()`
`final Bundle`	`getArguments()`
`final FragmentManager`	`getChildFragmentManager()`
`Context`	`getContext()`
`Transition`	`getEnterTransition()`
`Transition`	`getExitTransition()`
`final FragmentManager`	`getFragmentManager()`
`final Object`	`getHost()`
`final int`	`getId()`
`final LayoutInflater`	`getLayoutInflater()`
`LoaderManager`	`getLoaderManager()`
`final Fragment`	`getParentFragment()`
`Transition`	`getReenterTransition()`
`final Resources`	`getResources()`
`final boolean`	`getRetainInstance()`
`Transition`	`getReturnTransition()`
`Transition`	`getSharedElementEnterTransition()`
`Transition`	`getSharedElementReturnTransition()`
`final String`	`getString(int arg0, Object... arg1)`
`final String`	`getString(int arg0)`
`final String`	`getTag()`
`final Fragment`	`getTargetFragment()`
`final int`	`getTargetRequestCode()`
`final CharSequence`	`getText(int arg0)`
`boolean`	`getUserVisibleHint()`
`View`	`getView()`
`final int`	`hashCode()`
`static Fragment`	`instantiate(Context arg0, String arg1)`
`static Fragment`	`instantiate(Context arg0, String arg1, Bundle arg2)`
`final boolean`	`isAdded()`
`final boolean`	`isDetached()`
`final boolean`	`isHidden()`
`final boolean`	`isInLayout()`
`final boolean`	`isRemoving()`
`final boolean`	`isResumed()`
`final boolean`	`isStateSaved()`
`final boolean`	`isVisible()`
`void`	`onActivityCreated(Bundle arg0)`
`void`	`onActivityResult(int arg0, int arg1, Intent arg2)`
`void`	`onAttach(Activity arg0)`
`void`	`onAttach(Context arg0)`
`void`	`onAttachFragment(Fragment arg0)`
`void`	`onConfigurationChanged(Configuration arg0)`
`boolean`	`onContextItemSelected(MenuItem arg0)`
`void`	`onCreate(Bundle arg0)`
`Animator`	`onCreateAnimator(int arg0, boolean arg1, int arg2)`
`void`	`onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)`
`void`	`onCreateOptionsMenu(Menu arg0, MenuInflater arg1)`
`View`	`onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2)`
`void`	`onDestroy()`
`void`	`onDestroyOptionsMenu()`
`void`	`onDestroyView()`
`void`	`onDetach()`
`LayoutInflater`	`onGetLayoutInflater(Bundle arg0)`
`void`	`onHiddenChanged(boolean arg0)`
`void`	`onInflate(AttributeSet arg0, Bundle arg1)`
`void`	`onInflate(Activity arg0, AttributeSet arg1, Bundle arg2)`
`void`	`onInflate(Context arg0, AttributeSet arg1, Bundle arg2)`
`void`	`onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean arg0)`
`void`	`onMultiWindowModeChanged(boolean arg0, Configuration arg1)`
`boolean`	`onOptionsItemSelected(MenuItem arg0)`
`void`	`onOptionsMenuClosed(Menu arg0)`
`void`	`onPause()`
`void`	`onPictureInPictureModeChanged(boolean arg0, Configuration arg1)`
`void`	`onPictureInPictureModeChanged(boolean arg0)`
`void`	`onPrepareOptionsMenu(Menu arg0)`
`void`	`onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)`
`void`	`onResume()`
`void`	`onSaveInstanceState(Bundle arg0)`
`void`	`onStart()`
`void`	`onStop()`
`void`	`onTrimMemory(int arg0)`
`void`	`onViewCreated(View arg0, Bundle arg1)`
`void`	`onViewStateRestored(Bundle arg0)`
`void`	`postponeEnterTransition()`
`void`	`registerForContextMenu(View arg0)`
`final void`	`requestPermissions(String[] arg0, int arg1)`
`void`	`setAllowEnterTransitionOverlap(boolean arg0)`
`void`	`setAllowReturnTransitionOverlap(boolean arg0)`
`void`	`setArguments(Bundle arg0)`
`void`	`setEnterSharedElementCallback(SharedElementCallback arg0)`
`void`	`setEnterTransition(Transition arg0)`
`void`	`setExitSharedElementCallback(SharedElementCallback arg0)`
`void`	`setExitTransition(Transition arg0)`
`void`	`setHasOptionsMenu(boolean arg0)`
`void`	`setInitialSavedState(Fragment.SavedState arg0)`
`void`	`setMenuVisibility(boolean arg0)`
`void`	`setReenterTransition(Transition arg0)`
`void`	`setRetainInstance(boolean arg0)`
`void`	`setReturnTransition(Transition arg0)`
`void`	`setSharedElementEnterTransition(Transition arg0)`
`void`	`setSharedElementReturnTransition(Transition arg0)`
`void`	`setTargetFragment(Fragment arg0, int arg1)`
`void`	`setUserVisibleHint(boolean arg0)`
`boolean`	`shouldShowRequestPermissionRationale(String arg0)`
`void`	`startActivity(Intent arg0)`
`void`	`startActivity(Intent arg0, Bundle arg1)`
`void`	`startActivityForResult(Intent arg0, int arg1)`
`void`	`startActivityForResult(Intent arg0, int arg1, Bundle arg2)`
`void`	`startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)`
`void`	`startPostponedEnterTransition()`
`String`	`toString()`
`void`	`unregisterForContextMenu(View arg0)`

From class


  
    java.lang.Object

From interface


  
    android.content.ComponentCallbacks2

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.content.ComponentCallbacks

Public constructors

BrandedFragment

added in version 24.1.0

BrandedFragment ()

Public methods

getBadgeDrawable

added in version 22.1.0

Drawable getBadgeDrawable ()

Returns the badge drawable used in the fragment title.

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

getSearchAffordanceColor

added in version 24.1.0

int getSearchAffordanceColor ()

Returns the color used to draw the search affordance.

Returns
`int`

getSearchAffordanceColors

added in version 24.1.0

SearchOrbView.Colors getSearchAffordanceColors ()

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

Returns
`SearchOrbView.Colors`

getTitle

added in version 22.1.0

CharSequence getTitle ()

Returns the title text for the fragment.

Returns
`CharSequence`	Title text for the fragment.

getTitleView

added in version 24.1.0

View getTitleView ()

Returns the view that implements TitleViewAdapter.Provider.

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

getTitleViewAdapter

added in version 24.1.0

TitleViewAdapter getTitleViewAdapter ()

Returns the TitleViewAdapter implemented by title view.

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

installTitleView

added in version 24.1.0

void installTitleView (LayoutInflater inflater, 
                ViewGroup parent, 
                Bundle savedInstanceState)

Inflate title view and add to parent. This method should be called in onCreateView(LayoutInflater, ViewGroup, Bundle).

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

isShowingTitle

added in version 24.1.0

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

void onDestroyView ()

onInflateTitleView

added in version 24.1.0

View onInflateTitleView (LayoutInflater inflater, 
                ViewGroup parent, 
                Bundle savedInstanceState)

Called by installTitleView(LayoutInflater, ViewGroup, Bundle) 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
`inflater`	`LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
`parent`	`ViewGroup`: Parent of title view.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

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

onPause

void onPause ()

onResume

void onResume ()

onSaveInstanceState

void onSaveInstanceState (Bundle outState)

Parameters
`outState`	`Bundle`

onStart

void onStart ()

onViewCreated

void onViewCreated (View view, 
                Bundle savedInstanceState)

Parameters
`view`	`View`
`savedInstanceState`	`Bundle`

setBadgeDrawable

added in version 22.1.0

void setBadgeDrawable (Drawable drawable)

Sets the drawable displayed in the fragment title.

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

setOnSearchClickedListener

added in version 24.1.0

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

setSearchAffordanceColor

added in version 24.1.0

void setSearchAffordanceColor (int color)

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

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

setSearchAffordanceColors

added in version 24.1.0

void setSearchAffordanceColors (SearchOrbView.Colors colors)

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

Parameters
`colors`	`SearchOrbView.Colors`: Colors used to draw search affordance.

setTitle

added in version 24.1.0

void setTitle (CharSequence title)

Sets title text for the fragment.

Parameters
`title`	`CharSequence`: The title text of the fragment.

setTitleView

added in version 24.1.0

void setTitleView (View titleView)

Sets the view that implemented TitleViewAdapter.

Parameters
`titleView`	`View`: The view that implemented `TitleViewAdapter.Provider`.

showTitle

added in version 24.1.0

void showTitle (int flags)

Changes title view's components visibility and shows title.

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

See also:

showTitle

added in version 24.1.0

void showTitle (boolean show)

Shows or hides the title view.

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

BrandedFragment

Summary

Inherited constants

Public constructors

Public methods

Inherited methods

Public constructors

BrandedFragment

Public methods

getBadgeDrawable

getSearchAffordanceColor

getSearchAffordanceColors

getTitle

getTitleView

getTitleViewAdapter

installTitleView

isShowingTitle

onDestroyView

onInflateTitleView

onPause

onResume

onSaveInstanceState

onStart

onViewCreated

setBadgeDrawable

setOnSearchClickedListener

setSearchAffordanceColor

setSearchAffordanceColors

setTitle

setTitleView

showTitle

showTitle

Interfaces

Classes