public class

BrowseFragment

extends Fragment

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

Class Overview

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

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

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

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

Summary

Nested Classes
class	BrowseFragment.BrowseTransitionListener	Listener for transitions between browse headers and rows.

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.

[Expand]

Inherited Constants

From interface android.content.ComponentCallbacks2

Public Constructors
	BrowseFragment()

Public Methods
static Bundle	createArgs(Bundle args, String title, int headersState) Create arguments for a browse fragment.
ObjectAdapter	getAdapter() Returns the adapter containing the rows for the fragment.
Drawable	getBadgeDrawable() Returns the badge drawable used in the fragment title.
int	getBrandColor() Returns the brand color for the browse fragment.
int	getHeadersState() Returns the state of the headers column in the browse fragment.
OnItemClickedListener	getOnItemClickedListener() Returns the item clicked listener.
int	getSearchAffordanceColor() Returns the color used to draw the search affordance.
String	getTitle() Returns the title for the browse fragment.
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.
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	onStart() Called when the Fragment is visible to the user.
void	setAdapter(ObjectAdapter adapter) Sets the adapter containing the rows for the fragment.
void	setBadgeDrawable(Drawable drawable) Sets the drawable displayed in the browse fragment title.
void	setBrandColor(int color) Sets the brand color for the browse fragment.
void	setBrowseTransitionListener(BrowseFragment.BrowseTransitionListener listener) Set 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) Enable/disable headers transition on back key support.
void	setOnItemClickedListener(OnItemClickedListener listener) Sets an item clicked listener on the fragment.
void	setOnItemSelectedListener(OnItemSelectedListener listener) Sets an item selection listener.
void	setOnSearchClickedListener(View.OnClickListener listener) Sets a click listener for the search affordance.
void	setSearchAffordanceColor(int color) Sets the color used to draw the search affordance.
void	setTitle(String title) Sets a title for the browse fragment.
void	startHeadersTransition(boolean withHeaders) Start a headers transition.

[Expand]

Inherited Methods

From class android.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 Activity	getActivity() Return the Activity this fragment is currently associated with.
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.
final FragmentManager	getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity.
final int	getId() Return the identifier this fragment is known by.
LoaderManager	getLoaderManager() Return the LoaderManager for this fragment, creating it if needed.
final Fragment	getParentFragment() Returns the parent Fragment containing this Fragment.
final Resources	getResources() Return `getActivity().getResources()`.
final boolean	getRetainInstance()
final String	getString(int resId) Return a localized string from the application's package's default string table.
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	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.
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	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) Called when a fragment is first attached to its activity.
void	onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running.
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.
Animator	onCreateAnimator(int transit, boolean enter, int nextAnim) Called when a fragment loads an animation.
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 Activity'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.
void	onHiddenChanged(boolean hidden) Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
void	onInflate(AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 12. Use `onInflate(Activity, AttributeSet, Bundle)` instead.
void	onInflate(Activity activity, 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() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
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	onPrepareOptionsMenu(Menu menu) Prepare the Screen's standard options menu to be displayed.
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	onTrimMemory(int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
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	registerForContextMenu(View view) Registers a context menu to be shown for the given view (multiple views can show the context menu).
void	setArguments(Bundle args) Supply the construction arguments for this fragment.
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	setRetainInstance(boolean retain) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
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.
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.
String	toString() Returns a string containing a concise, human-readable description of this object.
void	unregisterForContextMenu(View view) Prevents a context menu to be shown for the given view.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks

From interface android.content.ComponentCallbacks2

From interface android.view.View.OnCreateContextMenuListener

Constants

public static final int HEADERS_DISABLED

The headers fragment is disabled and will never be shown.

Constant Value: 3 (0x00000003)

public static final int HEADERS_ENABLED

The headers fragment is enabled and shown by default.

Constant Value: 1 (0x00000001)

public static final int HEADERS_HIDDEN

The headers fragment is enabled and hidden by default.

Constant Value: 2 (0x00000002)

Public Constructors

public BrowseFragment ()

Public Methods

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

Create arguments for a browse fragment.

Parameters

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

Returns

A Bundle with the given arguments for creating a BrowseFragment.

public ObjectAdapter getAdapter ()

Returns the adapter containing the rows for the fragment.

public Drawable getBadgeDrawable ()

Returns the badge drawable used in the fragment title.

public int getBrandColor ()

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

public int getHeadersState ()

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

public OnItemClickedListener getOnItemClickedListener ()

Returns the item clicked listener.

public int getSearchAffordanceColor ()

Returns the color used to draw the search affordance. Can be called only after an activity has been attached.

public String getTitle ()

Returns the title for the browse fragment.

public final boolean isHeadersTransitionOnBackEnabled ()

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

public boolean isInHeadersTransition ()

Returns true if the headers transition is currently running.

public boolean isShowingHeaders ()

Returns true if headers are shown.

public 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).

Parameters

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

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

Returns

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

public void onDestroy ()

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

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.

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

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

public void setBadgeDrawable (Drawable drawable)

Sets the drawable displayed in the browse fragment title.

Parameters

drawable	The Drawable to display in the browse fragment title.

public 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	The color to use as the brand color of the fragment.

public void setBrowseTransitionListener (BrowseFragment.BrowseTransitionListener listener)

Set a listener for browse fragment transitions.

Parameters

listener	The listener to call when a browse headers transition begins or ends.

public void setHeaderPresenterSelector (PresenterSelector headerPresenterSelector)

Sets the PresenterSelector used to render the row headers.

Parameters

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

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

headersState	The state of the headers for the browse fragment.

public final void setHeadersTransitionOnBackEnabled (boolean headersBackStackEnabled)

Enable/disable headers transition on back key support. This is enabled by default. The BrowseFragment 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 BrowseFragment.BrowseTransitionListener in your own back stack handling.

public void setOnItemClickedListener (OnItemClickedListener listener)

Sets an item clicked listener on the fragment.

OnItemClickedListener will override View.OnClickListener that an item presenter may set during onCreateViewHolder(ViewGroup). So in general, you should choose to use an OnItemClickedListener or a View.OnClickListener on your item views, but not both.

Parameters

listener	The listener to call when an item is clicked.

public void setOnItemSelectedListener (OnItemSelectedListener listener)

Sets an item selection listener. This listener will be called when an item or row is selected by a user.

Parameters

listener	The listener to call when an item or row is selected.

public void setOnSearchClickedListener (View.OnClickListener listener)

Sets a click listener for the search affordance.

The presence of a listener will change the visibility of the search affordance in the fragment title. When set to non-null, the title will contain an element that a user may click to begin a search.

The listener's onClick method will be invoked when the user clicks on the search element.

Parameters

listener	The listener to call when the search element is clicked.

public void setSearchAffordanceColor (int color)

Sets the color used to draw the search affordance.

Parameters

color	The color to use for the search affordance.

public void setTitle (String title)

Sets a title for the browse fragment.

Parameters

title	The title of the browse fragment.

public void startHeadersTransition (boolean withHeaders)

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

Results

Interfaces

Classes

BrowseFragment

Class Overview

Summary

Constants

public static final int HEADERS_DISABLED

public static final int HEADERS_ENABLED

public static final int HEADERS_HIDDEN

Public Constructors

public BrowseFragment ()

Public Methods

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

Parameters

Returns

public ObjectAdapter getAdapter ()

public Drawable getBadgeDrawable ()

public int getBrandColor ()

public int getHeadersState ()

public OnItemClickedListener getOnItemClickedListener ()

public int getSearchAffordanceColor ()

public String getTitle ()

public final boolean isHeadersTransitionOnBackEnabled ()

public boolean isInHeadersTransition ()

public boolean isShowingHeaders ()

public void onCreate (Bundle savedInstanceState)

Parameters

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

Parameters

Returns

public void onDestroy ()

public void onStart ()

public void setAdapter (ObjectAdapter adapter)

Parameters

public void setBadgeDrawable (Drawable drawable)

Parameters

public void setBrandColor (int color)

Parameters

public void setBrowseTransitionListener (BrowseFragment.BrowseTransitionListener listener)

Parameters

public void setHeaderPresenterSelector (PresenterSelector headerPresenterSelector)

Parameters

public void setHeadersState (int headersState)

Parameters

public final void setHeadersTransitionOnBackEnabled (boolean headersBackStackEnabled)

public void setOnItemClickedListener (OnItemClickedListener listener)

Parameters

public void setOnItemSelectedListener (OnItemSelectedListener listener)

Parameters

public void setOnSearchClickedListener (View.OnClickListener listener)

Parameters

public void setSearchAffordanceColor (int color)

Parameters

public void setTitle (String title)

Parameters

public void startHeadersTransition (boolean withHeaders)

Parameters