BrowseSupportFragment

Kotlin |Java

open class BrowseSupportFragment : BaseSupportFragment

kotlin.Any
↳	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 , you must disable this default Back key support by calling setHeadersTransitionOnBackEnabled(boolean) with false and use BrowseSupportFragment.BrowseTransitionListener and startHeadersTransition(boolean).

The recommended theme to use with a BrowseSupportFragment is androidx.leanback.R.style#Theme_Leanback_Browse.

Summary

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

Constants
static Int	`HEADERS_DISABLED` The headers fragment is disabled and will never be shown.
static Int	`HEADERS_ENABLED` The headers fragment is enabled and shown by default.
static Int	`HEADERS_HIDDEN` The headers fragment is enabled and hidden by default.

Public constructors
`<init>()` A fragment for creating Leanback browse screens.

Public methods
open static Bundle!	`createArgs(args: Bundle!, title: String!, headersState: Int)` Creates arguments for a browse fragment.
open Unit	`enableMainFragmentScaling(enable: Boolean)` Enables scaling of main fragment when headers are present.
open Unit	`enableRowScaling(enable: Boolean)`
open ObjectAdapter!	`getAdapter()` Returns the adapter containing the rows for the fragment.
open Int	`getBrandColor()` Returns the brand color for the browse fragment.
open Int	`getHeadersState()` Returns the state of the headers column in the browse fragment.
open HeadersSupportFragment!	`getHeadersSupportFragment()` Get currently bound HeadersSupportFragment or null if HeadersSupportFragment has not been created yet.
open Fragment!	`getMainFragment()`
BrowseSupportFragment.MainFragmentAdapterRegistry!	`getMainFragmentRegistry()`
open OnItemViewClickedListener!	`getOnItemViewClickedListener()` Returns the item Clicked listener.
open OnItemViewSelectedListener!	`getOnItemViewSelectedListener()` Returns an item selection listener.
open 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.
open Int	`getSelectedPosition()` Gets position of currently selected row.
open RowPresenter.ViewHolder!	`getSelectedRowViewHolder()`
Boolean	`isHeadersTransitionOnBackEnabled()` Returns true if headers transition on back key support is enabled.
open Boolean	`isInHeadersTransition()` Returns true if the headers transition is currently running.
open Boolean	`isShowingHeaders()` Returns true if headers are shown.
open Unit	`onCreate(savedInstanceState: Bundle?)`
open HeadersSupportFragment!	`onCreateHeadersSupportFragment()` Creates a new `HeadersSupportFragment` instance.
open View?	`onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?)`
open Unit	`onDestroy()`
open Unit	`onDestroyView()`
open Unit	`onSaveInstanceState(outState: Bundle)`
open Unit	`onStart()`
open Unit	`onStop()`
open Unit	`setAdapter(adapter: ObjectAdapter!)` Sets the adapter containing the rows for the fragment.
open Unit	`setBrandColor(@ColorInt color: Int)` Sets the brand color for the browse fragment.
open Unit	`setBrowseTransitionListener(listener: BrowseSupportFragment.BrowseTransitionListener!)` Sets a listener for browse fragment transitions.
open Unit	`setHeaderPresenterSelector(headerPresenterSelector: PresenterSelector!)` Sets the `PresenterSelector` used to render the row headers.
open Unit	`setHeadersState(headersState: Int)` Sets the state for the headers column in the browse fragment.
Unit	`setHeadersTransitionOnBackEnabled(headersBackStackEnabled: Boolean)` Enables/disables headers transition on back key support.
open Unit	`setOnItemViewClickedListener(listener: OnItemViewClickedListener!)` Sets an item clicked listener on the fragment.
open Unit	`setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!)` Sets an item selection listener.
open Unit	`setSelectedPosition(position: Int)` Sets the selected row position with smooth animation.
open Unit	`setSelectedPosition(position: Int, smooth: Boolean)` Sets the selected row position.
open Unit	`setSelectedPosition(rowPosition: Int, smooth: Boolean, rowHolderTask: Presenter.ViewHolderTask!)` Selects a Row and perform an optional task on the Row.
open Unit	`startHeadersTransition(withHeaders: Boolean)` Starts a headers transition.

Protected methods
open Any!	`createEntranceTransition()`
open Unit	`onEntranceTransitionEnd()`
open Unit	`onEntranceTransitionPrepare()`
open Unit	`onEntranceTransitionStart()`
open Unit	`runEntranceTransition(entranceTransition: Any!)`

Inherited functions

From class Fragment

`Unit`	`dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?)` Print the Fragments's state into the given stream.
`Boolean`	`equals(@Nullable other: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with. May return `null` if the fragment is associated with a `Context` instead.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.
`Bundle?`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context?`	`getContext()` Return the `Context` this fragment is currently associated with.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors. 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 factory.
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View#INVISIBLE` to `View#VISIBLE`.
`Any?`	`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. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected.
`FragmentManager?`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.
`Any?`	`getHost()` Return the host object of this fragment. May return `null` if the fragment isn't currently being hosted.
`Int`	`getId()` Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment.
`LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment. If `onGetLayoutInflater(Bundle)` has not been called `onGetLayoutInflater(Bundle)` will be called with a `null` argument and that value will be cached. The cached LayoutInflater will be replaced immediately prior to `onCreateView(LayoutInflater, ViewGroup, Bundle)` and cleared immediately after `onDetach()`.
`Lifecycle`	`getLifecycle()` Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`LoaderManager`	`getLoaderManager()` Return the LoaderManager for this fragment.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.
`Any?`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If nothing is set, the default will be to use the same transition as `getExitTransition()`.
`Resources`	`getResources()` Return `requireActivity().getResources()`.
`Boolean`	`getRetainInstance()` Returns `true` if this fragment instance's state will be retained across configuration changes, and `false` if it will not.
`Any?`	`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. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If nothing is set, the default will be to use the same transition as `getEnterTransition()`.
`SavedStateRegistry`	`getSavedStateRegistry()`
`Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.
`Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(Object)`.
`String`	`getString(@StringRes resId: Int)` Return a localized string from the application's package's default string table.
`String`	`getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any!)` 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 java.lang.String#format.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` Return the target fragment set by