BrowseFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

public class BrowseFragment extends BaseFragment

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

A fragment for creating Leanback browse screens. It is composed of a RowsFragment and a HeadersFragment.

A BrowseFragment renders the elements of its ObjectAdapter as a set of rows in a vertical list. The elements in this adapter must be subclasses of Row.

The HeadersFragment can be set to be either shown or hidden by default, or may be disabled entirely. See setHeadersState for details.

By default the BrowseFragment includes support for returning to the headers when the user presses Back. For Activities that customize onBackPressed, you must disable this default Back key support by calling setHeadersTransitionOnBackEnabled with false and use BrowseFragment.BrowseTransitionListener and startHeadersTransition.

The recommended theme to use with a BrowseFragment is Theme_Leanback_Browse.

Summary

Nested types
`public class BrowseFragment.BrowseTransitionListener` This class is deprecated. use `BrowseSupportFragment`
`public abstract class BrowseFragment.FragmentFactory<T extends Fragment>` This class is deprecated. use `BrowseSupportFragment`
`public interface BrowseFragment.FragmentHost` This interface is deprecated. use `BrowseSupportFragment`
`public class BrowseFragment.ListRowFragmentFactory extends BrowseFragment.FragmentFactory` This class is deprecated. use `BrowseSupportFragment`
`public class BrowseFragment.MainFragmentAdapter<T extends Fragment>` This class is deprecated. use `BrowseSupportFragment`
`public interface BrowseFragment.MainFragmentAdapterProvider` This interface is deprecated. use `BrowseSupportFragment`
`public final class BrowseFragment.MainFragmentAdapterRegistry` This class is deprecated. use `BrowseSupportFragment`
`public class BrowseFragment.MainFragmentRowsAdapter<T extends Fragment>` This class is deprecated. use `BrowseSupportFragment`
`public interface BrowseFragment.MainFragmentRowsAdapterProvider` This interface is deprecated. use `BrowseSupportFragment`

Nested types

public class BrowseFragment.BrowseTransitionListener

This class is deprecated.

use BrowseSupportFragment

public abstract class BrowseFragment.FragmentFactory<T extends Fragment>

This class is deprecated.

use BrowseSupportFragment

public interface BrowseFragment.FragmentHost

This interface is deprecated.

use BrowseSupportFragment

public class BrowseFragment.ListRowFragmentFactory extends BrowseFragment.FragmentFactory

This class is deprecated.

use BrowseSupportFragment

public class BrowseFragment.MainFragmentAdapter<T extends Fragment>

This class is deprecated.

use BrowseSupportFragment

public interface BrowseFragment.MainFragmentAdapterProvider

This interface is deprecated.

use BrowseSupportFragment

public final class BrowseFragment.MainFragmentAdapterRegistry

This class is deprecated.

use BrowseSupportFragment

public class BrowseFragment.MainFragmentRowsAdapter<T extends Fragment>

This class is deprecated.

use BrowseSupportFragment

public interface BrowseFragment.MainFragmentRowsAdapterProvider

This interface is deprecated.

use BrowseSupportFragment

Constants
`static final int`	`HEADERS_DISABLED = 3` The headers fragment is disabled and will never be shown.
`static final int`	`HEADERS_ENABLED = 1` The headers fragment is enabled and shown by default.
`static final int`	`HEADERS_HIDDEN = 2` The headers fragment is enabled and hidden by default.

Public constructors
`BrowseFragment()`

Public methods
`static Bundle`	`createArgs(Bundle args, String title, int headersState)` Creates arguments for a browse fragment.
`void`	`enableMainFragmentScaling(boolean enable)` Enables scaling of main fragment when headers are present.
`void`	`enableRowScaling(boolean enable)` This method is deprecated. use `enableMainFragmentScaling` instead.
`ObjectAdapter`	`getAdapter()` Returns the adapter containing the rows for the fragment.
`@ColorInt int`	`getBrandColor()` Returns the brand color for the browse fragment.
`HeadersFragment`	`getHeadersFragment()` Get currently bound HeadersFragment or null if HeadersFragment has not been created yet.
`int`	`getHeadersState()` Returns the state of the headers column in the browse fragment.
`Fragment`	`getMainFragment()`
`final BrowseFragment.MainFragmentAdapterRegistry`	`getMainFragmentRegistry()`
`OnItemViewClickedListener`	`getOnItemViewClickedListener()` Returns the item Clicked listener.
`OnItemViewSelectedListener`	`getOnItemViewSelectedListener()` Returns an item selection listener.
`RowsFragment`	`getRowsFragment()` Get RowsFragment if it's bound to BrowseFragment or null if either BrowseFragment has not been created yet or a different fragment is bound to it.
`int`	`getSelectedPosition()` Gets position of currently selected row.
`RowPresenter.ViewHolder`	`getSelectedRowViewHolder()`
`final boolean`	`isHeadersTransitionOnBackEnabled()` Returns true if headers transition on back key support is enabled.
`boolean`	`isInHeadersTransition()` Returns true if the headers transition is currently running.
`boolean`	`isShowingHeaders()` Returns true if headers are shown.
`void`	`onCreate(Bundle savedInstanceState)` This method is deprecated.
`HeadersFragment`	`onCreateHeadersFragment()` Creates a new `HeadersFragment` instance.
`@Nullable View`	`onCreateView( LayoutInflater inflater, @Nullable ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroy()` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`onStop()` This method is deprecated.
`void`	`setAdapter(ObjectAdapter adapter)` Sets the adapter containing the rows for the fragment.
`void`	`setBrandColor(@ColorInt int color)` Sets the brand color for the browse fragment.
`void`	`setBrowseTransitionListener( BrowseFragment.BrowseTransitionListener listener )` Sets a listener for browse fragment transitions.
`void`	`setHeaderPresenterSelector(PresenterSelector headerPresenterSelector)` Sets the `PresenterSelector` used to render the row headers.
`void`	`setHeadersState(int headersState)` Sets the state for the headers column in the browse fragment.
`final void`	`setHeadersTransitionOnBackEnabled(boolean headersBackStackEnabled)` Enables/disables headers transition on back key support.
`void`	`setOnItemViewClickedListener(OnItemViewClickedListener listener)` Sets an item clicked listener on the fragment.
`void`	`setOnItemViewSelectedListener(OnItemViewSelectedListener listener)` Sets an item selection listener.
`void`	`setSelectedPosition(int position)` Sets the selected row position with smooth animation.
`void`	`setSelectedPosition(int position, boolean smooth)` Sets the selected row position.
`void`	`setSelectedPosition( int rowPosition, boolean smooth, Presenter.ViewHolderTask rowHolderTask )` Selects a Row and perform an optional task on the Row.
`void`	`startHeadersTransition(boolean withHeaders)` Starts a headers transition.

Protected methods
`Object`	`createEntranceTransition()` Create entrance transition.
`void`	`onEntranceTransitionEnd()` Callback when entrance transition is ended.
`void`	`onEntranceTransitionPrepare()` Callback when entrance transition is prepared.
`void`	`onEntranceTransitionStart()` Callback when entrance transition is started.
`void`	`runEntranceTransition(Object entranceTransition)` Run entrance transition.

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 androidx.leanback.app.BaseFragment

`final ProgressBarManager`	`getProgressBarManager()` Returns the `ProgressBarManager`.
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` This method is deprecated.
`void`	`prepareEntranceTransition()` Enables entrance transition.
`void`	`startEntranceTransition()` When fragment finishes loading data, it should call startEntranceTransition() to execute the entrance transition. startEntranceTransition() will start transition only if both two conditions are satisfied:

From androidx.leanback.app.BrandedFragment

`@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.
`@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`	`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.

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(Context context)` 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.
`void`	`onDestroyOptionsMenu()` This method is deprecated.
`void`	`onDestroyView()` 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(AttributeSet attrs, Bundle savedInstanceState)` This method is deprecated.
`void`	`onLowMemory()` This method is deprecated.
`void`	`onMultiWindowModeChanged( boolean isInMultiWindowMode, Configuration newConfig )` This method is deprecated.
`boolean`	`onOptionsItemSelected(MenuItem item)` This method is deprecated.
`void`	`onOptionsMenuClosed(Menu menu)` This method is deprecated.
`void`	`onPause()` This method is deprecated.
`void`	`onPictureInPictureModeChanged( boolean isInPictureInPictureMode, Configuration newConfig )` 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`	`onResume()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`onTrimMemory(int level)` This method is deprecated.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` 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.

Constants

HEADERS_DISABLED

Added in 1.1.0

Deprecated in 1.1.0

public static final int HEADERS_DISABLED = 3

The headers fragment is disabled and will never be shown.

HEADERS_ENABLED

Added in 1.1.0

Deprecated in 1.1.0

public static final int HEADERS_ENABLED = 1

The headers fragment is enabled and shown by default.

HEADERS_HIDDEN

Added in 1.1.0

Deprecated in 1.1.0

public static final int HEADERS_HIDDEN = 2

The headers fragment is enabled and hidden by default.

Public constructors

BrowseFragment

Added in 1.1.0

Deprecated in 1.1.0

public BrowseFragment()

Public methods

createArgs

Added in 1.1.0

Deprecated in 1.1.0

public static Bundle createArgs(Bundle args, String title, int headersState)

Creates arguments for a browse fragment.

Parameters
`Bundle args`	The Bundle to place arguments into, or null if the method should return a new Bundle.
`String title`	The title of the BrowseFragment.
`int headersState`	The initial state of the headers of the BrowseFragment. Must be one of `HEADERS_ENABLED`, `HEADERS_HIDDEN`, or `HEADERS_DISABLED`.

Returns
`Bundle`	A Bundle with the given arguments for creating a BrowseFragment.

enableMainFragmentScaling

Added in 1.1.0

Deprecated in 1.1.0

public void enableMainFragmentScaling(boolean enable)

Enables scaling of main fragment when headers are present. For the page/row fragment, scaling is enabled only when both this method and isScalingEnabled are enabled.

Parameters
`boolean enable`	true to enable row scaling

enableRowScaling

Added in 1.1.0

Deprecated in 1.1.0

public void enableRowScaling(boolean enable)

Parameters
`boolean enable`	true to enable row scaling

getAdapter

Added in 1.1.0

Deprecated in 1.1.0

public ObjectAdapter getAdapter()

Returns the adapter containing the rows for the fragment.

getBrandColor

Added in 1.1.0

Deprecated in 1.1.0

public @ColorInt int getBrandColor()

Returns the brand color for the browse fragment. The default is transparent.

getHeadersFragment

Added in 1.1.0

Deprecated in 1.1.0

public HeadersFragment getHeadersFragment()

Get currently bound HeadersFragment or null if HeadersFragment has not been created yet.

Returns
`HeadersFragment`	Currently bound HeadersFragment or null if HeadersFragment has not been created yet.

getHeadersState

Added in 1.1.0

Deprecated in 1.1.0

public int getHeadersState()

Returns the state of the headers column in the browse fragment.

getMainFragment

Added in 1.1.0

Deprecated in 1.1.0

public Fragment getMainFragment()

Returns
`Fragment`	Current main fragment or null if not created.

getMainFragmentRegistry

Added in 1.1.0

Deprecated in 1.1.0

public final BrowseFragment.MainFragmentAdapterRegistry getMainFragmentRegistry()

getOnItemViewClickedListener

Added in 1.1.0

Deprecated in 1.1.0

public OnItemViewClickedListener getOnItemViewClickedListener()

Returns the item Clicked listener.

getOnItemViewSelectedListener

Added in 1.1.0

Deprecated in 1.1.0

public OnItemViewSelectedListener getOnItemViewSelectedListener()

Returns an item selection listener.

getRowsFragment

Added in 1.1.0

Deprecated in 1.1.0

public RowsFragment getRowsFragment()

Get RowsFragment if it's bound to BrowseFragment or null if either BrowseFragment has not been created yet or a different fragment is bound to it.

Returns
`RowsFragment`	RowsFragment if it's bound to BrowseFragment or null otherwise.

getSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

public int getSelectedPosition()

Gets position of currently selected row.

Returns
`int`	Position of currently selected row.

getSelectedRowViewHolder

Added in 1.1.0

Deprecated in 1.1.0

public

BrowseFragment

Summary

Nested types

Constants

Public constructors

Public methods

Protected methods

Inherited Constants

Inherited methods

Constants

HEADERS_DISABLED

HEADERS_ENABLED

HEADERS_HIDDEN

Public constructors

BrowseFragment

Public methods

createArgs

enableMainFragmentScaling

enableRowScaling

getAdapter

getBrandColor

getHeadersFragment

getHeadersState

getMainFragment

getMainFragmentRegistry

getOnItemViewClickedListener

getOnItemViewSelectedListener

getRowsFragment

getSelectedPosition

getSelectedRowViewHolder