added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

BrowseSupportFragment

public class BrowseSupportFragment
extends BaseSupportFragment

java.lang.Object
↳	android.support.v4.app.Fragment
	↳	android.support.v17.leanback.app.BrandedSupportFragment
		↳	android.support.v17.leanback.app.BaseSupportFragment
			↳	android.support.v17.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(int) 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(boolean) with false and use BrowseSupportFragment.BrowseTransitionListener and startHeadersTransition(boolean).

The recommended theme to use with a BrowseSupportFragment is Theme_Leanback_Browse.

Summary

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

Constants
`int`	`HEADERS_DISABLED` The headers fragment is disabled and will never be shown.
`int`	`HEADERS_ENABLED` The headers fragment is enabled and shown by default.
`int`	`HEADERS_HIDDEN` 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 was deprecated in API level 24.1.0. use `enableMainFragmentScaling(boolean)` instead.
`ObjectAdapter`	`getAdapter()` Returns the adapter containing the rows for the fragment.
`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.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, 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(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`setAdapter(ObjectAdapter adapter)` Sets the adapter containing the rows for the fragment.
`void`	`setBrandColor(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 rowPosition, boolean smooth, Presenter.ViewHolderTask rowHolderTask)` Selects a Row and perform an optional task on the Row.
`void`	`setSelectedPosition(int position, boolean smooth)` Sets the selected row position.
`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 class


  
    android.support.v17.leanback.app.BaseSupportFragment

From class


  
    android.support.v17.leanback.app.BrandedSupportFragment

From class


  
    android.support.v4.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final 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 Bundle`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`final 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.
`Object`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`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 FragmentManager`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()`
`LoaderManager`	`getLoaderManager()` Return the LoaderManager for this fragment.
`final Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`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 Resources`	`getResources()` Return `requireActivity().getResources()`.
`final boolean`	`getRetainInstance()`
`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.
`Object`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Object`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String`	`getString(int resId, Object... formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
`final String`	`getString(int resId)` Return a localized string from the application's package's default string table.
`final String`	`getTag()` Get the tag name of the fragment, if specified.
`final Fragment`	`getTargetFragment()` Return the target fragment set by `setTargetFragment(Fragment, int)`.
`final int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment(Fragment, int)`.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()`
`View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
`ViewModelStore`	`getViewModelStore()`
`final int`	`hashCode()` Subclasses can not override hashCode().
`static Fragment`	`instantiate(Context context, String fname)` Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
`static Fragment`	`instantiate(Context context, String fname, Bundle args)` Create a new instance of a Fragment with the given class name.
`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 <fragment> 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`	`onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(Intent, int)`.
`void`	`onAttach(Activity activity)` This method was deprecated in API level 24.1.0. See `onAttach(Context)`.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void`	`onConfigurationChanged(Configuration newConfig)`
`boolean`	`onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animation`	`onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Fragment host's standard options menu.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void`	`onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 24.1.0. See `onInflate(Context, AttributeSet, Bundle)`.
`void`	`onInflate(Context context, AttributeSet attrs, 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`	`onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(Menu menu)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`onPrepareOptionsMenu(Menu menu)` Prepare the Fragment host's standard options menu to be displayed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of 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`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(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.
`void`	`registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`final FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final FragmentManager`	`requireFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`requireHost()` Return the host object of this fragment.
`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(Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(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(Object transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(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(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)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void`	`setInitialSavedState(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(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)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
`void`	`setReturnTransition(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(Object transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(Object transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` Optional target for this fragment.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` Set a hint to the system about whether this fragment's UI is currently visible to the user.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale for requesting a permission.
`void`	`startActivity(Intent intent)` Call `startActivity(Intent)` from the fragment's containing Activity.
`void`	`startActivity(Intent intent, Bundle options)` Call `startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode)` Call `startActivityForResult(Intent, int)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode, Bundle options)` Call `startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called.
`String`	`toString()`
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class


  
    java.lang.Object

From interface


  
    android.content.ComponentCallbacks

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.arch.lifecycle.LifecycleOwner

From interface


  
    android.arch.lifecycle.ViewModelStoreOwner

Constants

HEADERS_DISABLED

added in version 22.1.0

int HEADERS_DISABLED

The headers fragment is disabled and will never be shown.

Constant Value: 3 (0x00000003)

HEADERS_ENABLED

added in version 22.1.0

int HEADERS_ENABLED

The headers fragment is enabled and shown by default.

Constant Value: 1 (0x00000001)

HEADERS_HIDDEN

added in version 22.1.0

int HEADERS_HIDDEN

The headers fragment is enabled and hidden by default.

Constant Value: 2 (0x00000002)

Public constructors

BrowseSupportFragment

added in version 22.1.0

BrowseSupportFragment ()

Public methods

createArgs

added in version 22.1.0

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

Creates arguments for a browse fragment.

Parameters
`args`	`Bundle`: The Bundle to place arguments into, or null if the method should return a new Bundle.
`title`	`String`: The title of the BrowseSupportFragment.
`headersState`	`int`: 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 version 24.1.0

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
`enable`	`boolean`: true to enable row scaling

enableRowScaling

added in version 22.1.0

void enableRowScaling (boolean enable)

This method was deprecated in API level 24.1.0.
use enableMainFragmentScaling(boolean) instead.

Parameters
`enable`	`boolean`: true to enable row scaling

getAdapter

added in version 22.1.0

ObjectAdapter getAdapter ()

Returns the adapter containing the rows for the fragment.

Returns
`ObjectAdapter`

getBrandColor

added in version 22.1.0

int getBrandColor ()

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

Returns
`int`

getHeadersState

added in version 22.1.0

int getHeadersState ()

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

Returns
`int`

getHeadersSupportFragment

added in version 24.1.0

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 version 25.1.0

Fragment getMainFragment ()

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

getMainFragmentRegistry

added in version 24.1.0

BrowseSupportFragment.MainFragmentAdapterRegistry getMainFragmentRegistry ()

Returns
`BrowseSupportFragment.MainFragmentAdapterRegistry`

getOnItemViewClickedListener

added in version 22.1.0

OnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item Clicked listener.

Returns
`OnItemViewClickedListener`

getOnItemViewSelectedListener

added in version 22.1.0

OnItemViewSelectedListener getOnItemViewSelectedListener ()

Returns an item selection listener.

Returns
`OnItemViewSelectedListener`

getRowsSupportFragment

added in version 24.1.0

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 version 24.1.0

int getSelectedPosition ()

Gets position of currently selected row.

Returns
`int`	Position of currently selected row.

getSelectedRowViewHolder

added in version 25.1.0

RowPresenter.ViewHolder getSelectedRowViewHolder ()

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

isHeadersTransitionOnBackEnabled

added in version 22.1.0

boolean isHeadersTransitionOnBackEnabled ()

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

Returns
`boolean`

isInHeadersTransition

added in version 22.1.0

boolean isInHeadersTransition ()

Returns true if the headers transition is currently running.

Returns
`boolean`

isShowingHeaders

added in version 22.1.0

boolean isShowingHeaders ()

Returns true if headers are shown.

Returns
`boolean`

onCreate

added in version 24.1.0

void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle).

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, see onActivityCreated(Bundle).

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

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

onCreateHeadersSupportFragment

added in version 25.4.0

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

added in version 24.1.0

View onCreateView (LayoutInflater inflater, 
                ViewGroup container, 
                Bundle savedInstanceState)

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null (which is the default implementation). This will be called between onCreate(Bundle) and onActivityCreated(Bundle).

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

Parameters
`inflater`	`LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
`container`	`ViewGroup`: 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.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

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

onDestroy

added in version 24.1.0

void onDestroy ()

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

onDestroyView

added in version 24.1.0

void onDestroyView ()

Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) 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(LayoutInflater, ViewGroup, Bundle) 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

added in version 24.1.0

void onSaveInstanceState (Bundle outState)

Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of 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(Bundle), onCreateView(LayoutInflater, ViewGroup, Bundle), and onActivityCreated(Bundle).

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
`outState`	`Bundle`: Bundle in which to place your saved state.

onStart

added in version 24.1.0

void onStart ()

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

setAdapter

added in version 22.1.0

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
`adapter`	`ObjectAdapter`: An ObjectAdapter for the browse rows. All items must derive from `Row`.

setBrandColor

added in version 22.1.0

void setBrandColor (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
`color`	`int`: The color to use as the brand color of the fragment.

setBrowseTransitionListener

added in version 22.1.0

void setBrowseTransitionListener (BrowseSupportFragment.BrowseTransitionListener listener)

Sets a listener for browse fragment transitions.

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

setHeaderPresenterSelector

added in version 22.1.0

void setHeaderPresenterSelector (PresenterSelector headerPresenterSelector)

Sets the PresenterSelector used to render the row headers.

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

setHeadersState

added in version 22.1.0

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
`headersState`	`int`: The state of the headers for the browse fragment.

setHeadersTransitionOnBackEnabled

added in version 22.1.0

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(boolean) and BrowseSupportFragment.BrowseTransitionListener in your own back stack handling.

Parameters
`headersBackStackEnabled`	`boolean`

setOnItemViewClickedListener

added in version 22.1.0

void setOnItemViewClickedListener (OnItemViewClickedListener listener)

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

Parameters
`listener`	`OnItemViewClickedListener`

setOnItemViewSelectedListener

added in version 22.1.0

void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

Sets an item selection listener.

Parameters
`listener`	`OnItemViewSelectedListener`

setSelectedPosition

added in version 22.1.0

void setSelectedPosition (int position)

Sets the selected row position with smooth animation.

Parameters
`position`	`int`

setSelectedPosition

added in version 24.1.0

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(LayoutInflater, ViewGroup, Bundle)).

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

setSelectedPosition

added in version 22.1.0

void setSelectedPosition (int position, 
                boolean smooth)

Sets the selected row position.

Parameters
`position`	`int`
`smooth`	`boolean`

startHeadersTransition

added in version 22.1.0

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
`withHeaders`	`boolean`: True if the headers should transition to being shown, false if the transition should result in headers being hidden.

Protected methods

createEntranceTransition

added in version 24.1.0

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.

Returns
`Object`

onEntranceTransitionEnd

added in version 24.1.0

void onEntranceTransitionEnd ()

Callback when entrance transition is ended.

onEntranceTransitionPrepare

added in version 24.1.0

void onEntranceTransitionPrepare ()

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

onEntranceTransitionStart

added in version 24.1.0

void onEntranceTransitionStart ()

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

runEntranceTransition

added in version 24.1.0

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.

Parameters
`entranceTransition`	`Object`

BrowseSupportFragment

Summary

Nested classes

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

setAdapter

setBrandColor

setBrowseTransitionListener

setHeaderPresenterSelector

setHeadersState

setHeadersTransitionOnBackEnabled

setOnItemViewClickedListener

setOnItemViewSelectedListener

setSelectedPosition

setSelectedPosition

setSelectedPosition

startHeadersTransition

Protected methods

createEntranceTransition

onEntranceTransitionEnd

onEntranceTransitionPrepare

onEntranceTransitionStart

runEntranceTransition

Interfaces

Classes