BrowseSupportFragment

Added in 1.1.0

Kotlin |Java

public class BrowseSupportFragment extends BaseSupportFragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	androidx.leanback.app.BrandedSupportFragment
		↳	androidx.leanback.app.BaseSupportFragment
			↳	androidx.leanback.app.BrowseSupportFragment

A fragment for creating Leanback browse screens. It is composed of a RowsSupportFragment and a HeadersSupportFragment.

A BrowseSupportFragment 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 HeadersSupportFragment can be set to be either shown or hidden by default, or may be disabled entirely. See setHeadersState for details.

By default the BrowseSupportFragment 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 BrowseSupportFragment.BrowseTransitionListener and startHeadersTransition.

The recommended theme to use with a BrowseSupportFragment is Theme_Leanback_Browse.

Summary

Nested types
`public class BrowseSupportFragment.BrowseTransitionListener` Listener for transitions between browse headers and rows.
`public abstract class BrowseSupportFragment.FragmentFactory<T extends Fragment>` Factory class responsible for creating fragment given the current item.
`public interface BrowseSupportFragment.FragmentHost` Possible set of actions that `BrowseSupportFragment` exposes to clients.
`public class BrowseSupportFragment.ListRowFragmentFactory extends BrowseSupportFragment.FragmentFactory` FragmentFactory implementation for `ListRow`.
`public class BrowseSupportFragment.MainFragmentAdapter<T extends Fragment>` Interface that defines the interaction between `BrowseSupportFragment` and its main content fragment.
`public interface BrowseSupportFragment.MainFragmentAdapterProvider` Interface to be implemented by all fragments for providing an instance of `MainFragmentAdapter`.
`public final class BrowseSupportFragment.MainFragmentAdapterRegistry` Registry class maintaining the mapping of `Row` subclasses to `FragmentFactory`.
`public class BrowseSupportFragment.MainFragmentRowsAdapter<T extends Fragment>` This is used to pass information to `RowsSupportFragment` or its subclasses.
`public interface BrowseSupportFragment.MainFragmentRowsAdapterProvider` Interface to be implemented by `RowsSupportFragment` and its subclasses for providing an instance of `MainFragmentRowsAdapter`.

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
`BrowseSupportFragment()`

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.
`int`	`getHeadersState()` Returns the state of the headers column in the browse fragment.
`HeadersSupportFragment`	`getHeadersSupportFragment()` Get currently bound HeadersSupportFragment or null if HeadersSupportFragment has not been created yet.
`Fragment`	`getMainFragment()`
`final BrowseSupportFragment.MainFragmentAdapterRegistry`	`getMainFragmentRegistry()`
`OnItemViewClickedListener`	`getOnItemViewClickedListener()` Returns the item Clicked listener.
`OnItemViewSelectedListener`	`getOnItemViewSelectedListener()` Returns an item selection listener.
`RowsSupportFragment`	`getRowsSupportFragment()` Get RowsSupportFragment if it's bound to BrowseSupportFragment or null if either BrowseSupportFragment 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)` Called to do initial creation of a fragment.
`HeadersSupportFragment`	`onCreateHeadersSupportFragment()` Creates a new `HeadersSupportFragment` instance.
`@Nullable View`	`onCreateView( @NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState )` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`void`	`onSaveInstanceState(@NonNull Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`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( BrowseSupportFragment.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 methods

From androidx.activity.result.ActivityResultCaller

abstract ActivityResultLauncher<I>

<I, O> registerForActivityResult(
    ActivityResultContract<I, O> contract,
    ActivityResultCallback<O> callback
)

From androidx.leanback.app.BaseSupportFragment

`final ProgressBarManager`	`getProgressBarManager()` Returns the `ProgressBarManager`.
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`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.BrandedSupportFragment

`@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()` Called when the Fragment is no longer resumed.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`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.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration p)`
`abstract void`	`onLowMemory()`

From androidx.fragment.app.Fragment

`void`	`dump( @NonNull String prefix, @Nullable FileDescriptor fd, @NonNull PrintWriter writer, @Nullable String[] args )` Print the Fragments's state into the given stream.
`final boolean`	`equals(@Nullable Object o)` Subclasses can not override equals().
`final @Nullable FragmentActivity`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`final @Nullable Bundle`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`final @NonNull FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`@Nullable Context`	`getContext()` Return the `Context` this fragment is currently associated with.
`@NonNull CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()` The `Fragment's arguments` when this is first called will be used as the defaults to any `androidx.lifecycle.SavedStateHandle` passed to a view model created using this extra.
`@NonNull ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`@Nullable Object`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`@Nullable Object`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`final @Nullable FragmentManager`	`getFragmentManager()` This method is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`final @Nullable Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final @NonNull LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`@NonNull Lifecycle`	`getLifecycle()` Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`@NonNull LoaderManager`	`getLoaderManager()` This method is deprecated. Use `LoaderManager.getInstance(this)`.
`final @Nullable Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`final @NonNull FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`@Nullable Object`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final @NonNull Resources`	`getResources()` Return `requireActivity().getResources()`.
`final boolean`	`getRetainInstance()` This method is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`@Nullable Object`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`final @NonNull SavedStateRegistry`	`getSavedStateRegistry()`
`@Nullable Object`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`@Nullable Object`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final @NonNull String`	`getString(@StringRes int resId)` Return a localized string from the application's package's default string table.
`final @NonNull String`	`getString(@StringRes int resId, @Nullable Object[] formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and format.
`final @Nullable String`	`getTag()` Get the tag name of the fragment, if specified.
`final @Nullable Fragment`	`getTargetFragment()` This method is deprecated. Instead of using a target fragment to pass results, use `setFragmentResult` to deliver results to `FragmentResultListener` instances registered by other fragments via `setFragmentResultListener`.
`final int`	`getTargetRequestCode()` This method is deprecated. When using the target fragment replacement of `setFragmentResultListener` and `setFragmentResult`, consider using `setArguments` to pass a `requestKey` if you need to support dynamic request keys.
`final @NonNull CharSequence`	`getText(@StringRes int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()` This method is deprecated. Use `setMaxLifecycle` instead.
`@Nullable View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`@NonNull LifecycleOwner`	`@MainThread getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`@NonNull LiveData<LifecycleOwner>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`@NonNull ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment
`final int`	`hashCode()` Subclasses can not override hashCode().
`static @NonNull Fragment`	`instantiate(@NonNull Context context, @NonNull String fname)` This method is deprecated. Use `getFragmentFactory` and `instantiate`
`static @NonNull Fragment`	`instantiate( @NonNull Context context, @NonNull String fname, @Nullable Bundle args )` This method is deprecated. Use `getFragmentFactory` and `instantiate`, manually calling `setArguments` on the returned Fragment.
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`@MainThread @CallSuper onActivityCreated(@Nullable Bundle savedInstanceState)` This method is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`void`	`onActivityResult(int requestCode, int resultCode, @Nullable Intent data)` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`@MainThread @CallSuper onAttach(@NonNull Activity activity)` This method is deprecated. See `onAttach`.
`void`	`@MainThread @CallSuper onAttach(@NonNull Context context)` Called when a fragment is first attached to its context.
`void`	`@MainThread onAttachFragment(@NonNull Fragment childFragment)` This method is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`void`	`@CallSuper onConfigurationChanged(@NonNull Configuration newConfig)`
`boolean`	`@MainThread onContextItemSelected(@NonNull MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`@MainThread @CallSuper onCreate(@Nullable Bundle savedInstanceState)` Called to do initial creation of a fragment.
`@Nullable Animation`	`@MainThread onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`@Nullable Animator`	`@MainThread onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`@MainThread onCreateContextMenu( @NonNull ContextMenu menu, @NonNull View v, @Nullable ContextMenu.ContextMenuInfo menuInfo )` Called when a context menu for the `view` is about to be shown.
`void`	`@MainThread onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflater)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread onDestroyOptionsMenu()` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`@NonNull LayoutInflater`	`onGetLayoutInflater(@Nullable Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`@MainThread onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`void`	`@UiThread @CallSuper onInflate( @NonNull Activity activity, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )` This method is deprecated. See `onInflate`.
`void`	`@UiThread @CallSuper onInflate( @NonNull Context context, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`@MainThread @CallSuper onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`@MainThread onOptionsItemSelected(@NonNull MenuItem item)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread onOptionsMenuClosed(@NonNull Menu menu)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`@MainThread onPrepareOptionsMenu(@NonNull Menu menu)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread onPrimaryNavigationFragmentChanged( boolean isPrimaryNavigationFragment )` Callback for when the primary navigation state of this Fragment has changed.
`void`	`onRequestPermissionsResult( int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults )` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`@MainThread @CallSuper onViewStateRestored(@Nullable Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`final void`	`postponeEnterTransition(long duration, @NonNull TimeUnit timeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`final @NonNull ActivityResultLauncher<I>`	`@MainThread <I, O> registerForActivityResult( @NonNull ActivityResultContract<I, O> contract, @NonNull ActivityResultCallback<O> callback )` Register a request to `start an activity for result`, designated by the given `contract`.
`final @NonNull ActivityResultLauncher<I>`	`@MainThread <I, O> registerForActivityResult( @NonNull ActivityResultContract<I, O> contract, @NonNull ActivityResultRegistry registry, @NonNull ActivityResultCallback<O> callback )` Register a request to `start an activity for result`, designated by the given `contract`.
`void`	`registerForContextMenu(@NonNull View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(@NonNull String[] permissions, int requestCode)` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`final @NonNull FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final @NonNull Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`final @NonNull Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final @NonNull FragmentManager`	`requireFragmentManager()` This method is deprecated. This has been renamed to `getParentFragmentManager()` to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.
`final @NonNull Object`	`requireHost()` Return the host object of this fragment.
`final @NonNull Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`final @NonNull View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the the return transition and reenter transition overlap or not.
`void`	`setArguments(@Nullable Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(@Nullable SharedElementCallback callback)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`void`	`setEnterTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(@Nullable SharedElementCallback callback)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`void`	`setExitTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`void`	`setHasOptionsMenu(boolean hasMenu)` This method is deprecated. This method is no longer needed when using a `MenuProvider` to provide a `Menu` to your activity, which replaces `onCreateOptionsMenu` as the recommended way to provide a consistent, optionally `Lifecycle`-aware, and modular way to handle menu creation and item selection.
`void`	`setInitialSavedState(@Nullable Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void`	`setRetainInstance(boolean retain)` This method is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`void`	`setReturnTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`void`	`setSharedElementEnterTransition(@Nullable Object transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(@Nullable Object transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(@Nullable Fragment fragment, int requestCode)` This method is deprecated. Instead of using a target fragment to pass results, the fragment requesting a result should use `setFragmentResultListener` to register a `FragmentResultListener` with a `requestKey` using its `parent fragment manager`.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`boolean`	`shouldShowRequestPermissionRationale(@NonNull String permission)` Gets whether you should show UI with rationale before requesting a permission.
`void`	`startActivity(@NonNull Intent intent)` Call startActivity from the fragment's containing Activity.
`void`	`startActivity(@NonNull Intent intent, @Nullable Bundle options)` Call startActivity from the fragment's containing Activity.
`void`	`startActivityForResult(@NonNull Intent intent, int requestCode)` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`startActivityForResult( @NonNull Intent intent, int requestCode, @Nullable Bundle options )` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`startIntentSenderForResult( @NonNull IntentSender intent, int requestCode, @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, @Nullable Bundle options )` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`@NonNull String`	`toString()`
`void`	`unregisterForContextMenu(@NonNull View view)` Prevents a context menu to be shown for the given view.

From androidx.lifecycle.HasDefaultViewModelProviderFactory

`CreationExtras`	`getDefaultViewModelCreationExtras()`
`abstract ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle

getLifecycle()

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry

getSavedStateRegistry()

From android.view.View.OnCreateContextMenuListener

abstract void

onCreateContextMenu(
    ContextMenu p,
    View p1,
    ContextMenu.ContextMenuInfo p2
)

From androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore

getViewModelStore()

Constants

HEADERS_DISABLED

Added 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

public static final int HEADERS_ENABLED = 1

The headers fragment is enabled and shown by default.

HEADERS_HIDDEN

Added in 1.1.0

public static final int HEADERS_HIDDEN = 2

The headers fragment is enabled and hidden by default.

Public constructors

BrowseSupportFragment

Added in 1.1.0

public BrowseSupportFragment()

Public methods

createArgs

Added 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 BrowseSupportFragment.
`int headersState`	The initial state of the headers of the BrowseSupportFragment. Must be one of `HEADERS_ENABLED`, `HEADERS_HIDDEN`, or `HEADERS_DISABLED`.

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

enableMainFragmentScaling

Added 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

public ObjectAdapter getAdapter()

Returns the adapter containing the rows for the fragment.

getBrandColor

Added in 1.1.0

public @ColorInt int getBrandColor()

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

getHeadersState

Added in 1.1.0

public int getHeadersState()

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

getHeadersSupportFragment

Added in 1.1.0

public HeadersSupportFragment getHeadersSupportFragment()

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

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

getMainFragment

Added in 1.1.0

public Fragment getMainFragment()

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

getMainFragmentRegistry

Added in 1.1.0

public final BrowseSupportFragment.MainFragmentAdapterRegistry getMainFragmentRegistry()

getOnItemViewClickedListener

Added in 1.1.0

public OnItemViewClickedListener getOnItemViewClickedListener()

Returns the item Clicked listener.

getOnItemViewSelectedListener

Added in 1.1.0

public OnItemViewSelectedListener getOnItemViewSelectedListener()

Returns an item selection listener.

getRowsSupportFragment

Added in 1.1.0

public RowsSupportFragment getRowsSupportFragment()

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

Returns
`RowsSupportFragment`	RowsSupportFragment if it's bound to BrowseSupportFragment or null otherwise.

getSelectedPosition

Added 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

public RowPresenter.ViewHolder getSelectedRowViewHolder()

Returns
`RowPresenter.ViewHolder`	selected row ViewHolder inside fragment created by `MainFragmentRowsAdapter`.

isHeadersTransitionOnBackEnabled

Added in 1.1.0

public final boolean isHeadersTransitionOnBackEnabled()

Returns true if headers transition on back key support is enabled.

isInHeadersTransition

Added in 1.1.0

public boolean isInHeadersTransition()

Returns true if the headers transition is currently running.

isShowingHeaders

Added in 1.1.0

public boolean isShowingHeaders()

Returns true if headers are shown.

onCreate

public void onCreate(Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach and before onCreateView.

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a androidx.lifecycle.LifecycleObserver on the activity's Lifecycle, removing it when it receives the CREATED callback.

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Parameters
`Bundle savedInstanceState`	If the fragment is being re-created from a previous saved state, this is the state.

onCreateHeadersSupportFragment

Added in 1.1.0

public HeadersSupportFragment onCreateHeadersSupportFragment()

Creates a new HeadersSupportFragment instance. Subclass of BrowseSupportFragment may override and return an instance of subclass of HeadersSupportFragment, e.g. when app wants to replace presenter to render HeaderItem.

Returns
`HeadersSupportFragment`	A new instance of `HeadersSupportFragment` or its subclass.

onCreateView

public @Nullable View onCreateView(
    @NonNull LayoutInflater inflater,
    @Nullable ViewGroup container,
    @Nullable Bundle savedInstanceState
)

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between onCreate and onViewCreated.

A default View can be returned by calling Fragment in your constructor. Otherwise, this method returns null.

It is recommended to only inflate the layout in this method and move logic that operates on the returned View to onViewCreated.

If you return a View from here, you will later be called in onDestroyView when the view is being released.

Parameters
`@NonNull LayoutInflater inflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`@Nullable ViewGroup container`	If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
`@Nullable Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`@Nullable View`	Return the View for the fragment's UI, or null.

onDestroy

public void onDestroy()

Called when the fragment is no longer in use. This is called after onStop and before onDetach.

onDestroyView

public void onDestroyView()

Called when the view previously created by onCreateView has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after onStop and before onDestroy. It is called regardless of whether onCreateView returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

onSaveInstanceState

public void onSaveInstanceState(@NonNull Bundle outState)

Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to onCreate, onCreateView, and onViewCreated.

This corresponds to Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: this method may be called at any time before onDestroy. There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Parameters
`@NonNull Bundle outState`	Bundle in which to place your saved state.

onStart

public void onStart()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

onStop

public void onStop()

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

Added in 1.1.0

public void setAdapter(ObjectAdapter adapter)

Sets the adapter containing the rows for the fragment.

The items referenced by the adapter must be be derived from Row. These rows will be used by the rows fragment and the headers fragment (if not disabled) to render the browse rows.

Parameters
`ObjectAdapter adapter`	An ObjectAdapter for the browse rows. All items must derive from `Row`.

setBrandColor

Added in 1.1.0

public void setBrandColor(@ColorInt int color)

Sets the brand color for the browse fragment. The brand color is used as the primary color for UI elements in the browse fragment. For example, the background color of the headers fragment uses the brand color.

Parameters
`@ColorInt int color`	The color to use as the brand color of the fragment.

setBrowseTransitionListener

Added in 1.1.0

public void setBrowseTransitionListener(
    BrowseSupportFragment.BrowseTransitionListener listener
)

Sets a listener for browse fragment transitions.

Parameters
`BrowseSupportFragment.BrowseTransitionListener listener`	The listener to call when a browse headers transition begins or ends.

Added in 1.1.0

public void setHeaderPresenterSelector(PresenterSelector headerPresenterSelector)

Sets the PresenterSelector used to render the row headers.

Parameters
`PresenterSelector headerPresenterSelector`	The PresenterSelector that will determine the Presenter for each row header.

setHeadersState

Added in 1.1.0

public void setHeadersState(int headersState)

Sets the state for the headers column in the browse fragment. Must be one of HEADERS_ENABLED, HEADERS_HIDDEN, or HEADERS_DISABLED.

Parameters
`int headersState`	The state of the headers for the browse fragment.

setHeadersTransitionOnBackEnabled

Added in 1.1.0

public final void setHeadersTransitionOnBackEnabled(boolean headersBackStackEnabled)

Enables/disables headers transition on back key support. This is enabled by default. The BrowseSupportFragment will add a back stack entry when headers are showing. Running a headers transition when the back key is pressed only works when the headers state is HEADERS_ENABLED or HEADERS_HIDDEN.

NOTE: If an Activity has its own onBackPressed() handling, you must disable this feature. You may use startHeadersTransition and BrowseTransitionListener in your own back stack handling.

Added in 1.1.0

public void setOnItemViewClickedListener(OnItemViewClickedListener listener)

Sets an item clicked listener on the fragment. OnItemViewClickedListener will override View.OnClickListener that item presenter sets during onCreateViewHolder. So in general, developer should choose one of the listeners but not both.

Added in 1.1.0

public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener)

Sets an item selection listener.

setSelectedPosition

Added in 1.1.0

public void setSelectedPosition(int position)

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

public void setSelectedPosition(int position, boolean smooth)

Sets the selected row position.

Added in 1.1.0

public void setSelectedPosition(
    int rowPosition,
    boolean smooth,
    Presenter.ViewHolderTask rowHolderTask
)

Selects a Row and perform an optional task on the Row. For example setSelectedPosition(10, true, new ListRowPresenterSelectItemViewHolderTask(5)) scrolls to 11th row and selects 6th item on that row. The method will be ignored if RowsSupportFragment has not been created (i.e. before onCreateView).

Parameters
`int rowPosition`	Which row to select.
`boolean smooth`	True to scroll to the row, false for no animation.
`Presenter.ViewHolderTask rowHolderTask`	Optional task to perform on the Row. When the task is not null, headers fragment will be collapsed.

startHeadersTransition

Added in 1.1.0

public void startHeadersTransition(boolean withHeaders)

Starts a headers transition.

This method will begin a transition to either show or hide the headers, depending on the value of withHeaders. If headers are disabled for this browse fragment, this method will throw an exception.

Parameters
`boolean withHeaders`	True if the headers should transition to being shown, false if the transition should result in headers being hidden.

Protected methods

createEntranceTransition

protected Object createEntranceTransition()

Create entrance transition. Subclass can override to load transition from resource or construct manually. Typically app does not need to override the default transition that browse and details provides.

onEntranceTransitionEnd

protected void onEntranceTransitionEnd()

Callback when entrance transition is ended.

onEntranceTransitionPrepare

protected void onEntranceTransitionPrepare()

Callback when entrance transition is prepared. This is when fragment should stop user input and animations.

onEntranceTransitionStart

protected void onEntranceTransitionStart()

Callback when entrance transition is started. This is when fragment should stop processing layout.

runEntranceTransition

protected void runEntranceTransition(Object entranceTransition)

Run entrance transition. Subclass may use TransitionManager to perform go(Scene) or beginDelayedTransition(). App should not override the default implementation of browse and details fragment.

BrowseSupportFragment

Summary

Nested types

Constants

Public constructors

Public methods

Protected methods

Inherited methods

Constants

HEADERS_DISABLED

HEADERS_ENABLED

HEADERS_HIDDEN

Public constructors

BrowseSupportFragment

Public methods

createArgs

enableMainFragmentScaling

enableRowScaling

getAdapter

getBrandColor

getHeadersState

getHeadersSupportFragment

getMainFragment

getMainFragmentRegistry

getOnItemViewClickedListener

getOnItemViewSelectedListener

getRowsSupportFragment

getSelectedPosition

getSelectedRowViewHolder

isHeadersTransitionOnBackEnabled

isInHeadersTransition

isShowingHeaders

onCreate

onCreateHeadersSupportFragment

onCreateView

onDestroy

onDestroyView

onSaveInstanceState

onStart

onStop

setAdapter

setBrandColor

setBrowseTransitionListener

setHeaderPresenterSelector

setHeadersState

setHeadersTransitionOnBackEnabled

setOnItemViewClickedListener

setOnItemViewSelectedListener

setSelectedPosition

setSelectedPosition

setSelectedPosition

startHeadersTransition

Protected methods

createEntranceTransition

onEntranceTransitionEnd

onEntranceTransitionPrepare

onEntranceTransitionStart

runEntranceTransition