java.lang.Object | ||
↳ | android.app.Fragment | |
↳ | android.support.v17.leanback.app.BrowseFragment |
A fragment for creating Leanback browse screens. It is composed of a RowsFragment and a HeadersFragment.
A BrowseFragment renders the elements of its ObjectAdapter
as a set
of rows in a vertical list. The elements in this adapter must be subclasses
of Row
.
The HeadersFragment can be set to be either shown or hidden by default, or
may be disabled entirely. See setHeadersState(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)
.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
BrowseFragment.BrowseTransitionListener | Listener for transitions between browse headers and rows. |
[Expand]
Inherited XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.app.Fragment
|
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create arguments for a browse fragment.
| |||||||||||
Enables scaling of rows when headers are present.
| |||||||||||
Returns the adapter containing the rows for the fragment.
| |||||||||||
Returns the badge drawable used in the fragment title.
| |||||||||||
Returns the brand color for the browse fragment.
| |||||||||||
Returns the state of the headers column in the browse fragment.
| |||||||||||
This method is deprecated.
Use
getOnItemViewClickedListener()
| |||||||||||
Returns the item Clicked listener.
| |||||||||||
Returns an item selection listener.
| |||||||||||
Returns the color used to draw the search affordance.
| |||||||||||
Returns the
SearchOrbView.Colors used to draw the search affordance.
| |||||||||||
Returns the title for the browse fragment.
| |||||||||||
Returns true if headers transition on back key support is enabled.
| |||||||||||
Returns true if the headers transition is currently running.
| |||||||||||
Returns true if headers are shown.
| |||||||||||
Called to do initial creation of a fragment.
| |||||||||||
Called to have the fragment instantiate its user interface view.
| |||||||||||
Called when the fragment is no longer in use.
| |||||||||||
Called when the Fragment is no longer resumed.
| |||||||||||
Called when the fragment is visible to the user and actively running.
| |||||||||||
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.
| |||||||||||
Called when the Fragment is visible to the user.
| |||||||||||
Called immediately after
onCreateView(LayoutInflater, ViewGroup, Bundle)
has returned, but before any saved state has been restored in to the view.
| |||||||||||
Enables entrance transition.
| |||||||||||
Sets the adapter containing the rows for the fragment.
| |||||||||||
Sets the drawable displayed in the browse fragment title.
| |||||||||||
Sets the brand color for the browse fragment.
| |||||||||||
Set a listener for browse fragment transitions.
| |||||||||||
Sets the
PresenterSelector used to render the row headers.
| |||||||||||
Sets the state for the headers column in the browse fragment.
| |||||||||||
Enable/disable headers transition on back key support.
| |||||||||||
This method is deprecated.
Use
setOnItemViewClickedListener(OnItemViewClickedListener)
| |||||||||||
This method is deprecated.
Use
setOnItemViewSelectedListener(OnItemViewSelectedListener)
| |||||||||||
Sets an item clicked listener on the fragment.
| |||||||||||
Sets an item selection listener.
| |||||||||||
Sets a click listener for the search affordance.
| |||||||||||
Sets the color used to draw the search affordance.
| |||||||||||
Sets the
SearchOrbView.Colors used to draw the search affordance.
| |||||||||||
Sets the selected row position.
| |||||||||||
Sets the selected row position with smooth animation.
| |||||||||||
Sets a title for the browse fragment.
| |||||||||||
When fragment finishes loading data, it should call startEntranceTransition()
to execute the entrance transition.
| |||||||||||
Start a headers transition.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create entrance transition.
| |||||||||||
Callback when entrance transition is ended.
| |||||||||||
Callback when entrance transition is started.
| |||||||||||
Run entrance transition.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.app.Fragment
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.content.ComponentCallbacks2
| |||||||||||
From interface
android.view.View.OnCreateContextMenuListener
| |||||||||||
From interface
android.content.ComponentCallbacks
|
The headers fragment is disabled and will never be shown.
The headers fragment is enabled and shown by default.
The headers fragment is enabled and hidden by default.
Create arguments for a browse fragment.
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 . |
Enables scaling of rows when headers are present. By default enabled to increase density.
enable | true to enable row scaling |
---|
Returns the brand color for the browse fragment. The default is transparent.
Returns the state of the headers column in the browse fragment.
Returns an item selection listener.
Returns the color used to draw the search affordance.
Returns the SearchOrbView.Colors
used to draw the search affordance.
Returns true if headers transition on back key support is enabled.
Returns true if the headers transition is currently running.
Returns true if headers are shown.
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)
.
savedInstanceState | If the fragment is being re-created from a previous saved state, this is the state. |
---|
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.
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. |
Called when the fragment is no longer in use. This is called
after onStop()
and before onDetach()
.
Called when the Fragment is no longer resumed. This is generally
tied to Activity.onPause
of the containing
Activity's lifecycle.
Called when the fragment is visible to the user and actively running.
This is generally
tied to Activity.onResume
of the containing
Activity's lifecycle.
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.
outState | Bundle in which to place your saved state. |
---|
Called when the Fragment is visible to the user. This is generally
tied to Activity.onStart
of the containing
Activity's lifecycle.
Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle)
has returned, but before any saved state has been restored in to the view.
This gives subclasses a chance to initialize themselves once
they know their view hierarchy has been completely created. The fragment's
view hierarchy is not however attached to its parent at this point.
view | The View returned by onCreateView(LayoutInflater, ViewGroup, Bundle) . |
---|---|
savedInstanceState | If non-null, this fragment is being re-constructed from a previous saved state as given here. |
Enables entrance transition.
Entrance transition is the standard slide-in transition that shows rows of data in browse screen and details screen.
The method is ignored before LOLLIPOP (API21).
This method must be called in or
before onCreate(). Typically entrance transition should be enabled when savedInstance is
null so that fragment restored from instanceState does not run an extra entrance transition.
When the entrance transition is enabled, the fragment will make headers and content
hidden initially.
When data of rows are ready, app must call startEntranceTransition()
to kick off
the transition, otherwise the rows will be invisible forever.
It is similar to android:windowsEnterTransition and can be considered a late-executed android:windowsEnterTransition controlled by app. There are two reasons that app needs it:
Transition object is returned by createEntranceTransition(). Typically the app does not need override the default transition that browse and details provides.
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.
adapter | An ObjectAdapter for the browse rows. All items must
derive from Row .
|
---|
Sets the drawable displayed in the browse fragment title.
drawable | The Drawable to display in the browse fragment title. |
---|
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.
color | The color to use as the brand color of the fragment. |
---|
Set a listener for browse fragment transitions.
listener | The listener to call when a browse headers transition begins or ends. |
---|
Sets the PresenterSelector
used to render the row headers.
headerPresenterSelector | The PresenterSelector that will determine the Presenter for each row header. |
---|
Sets the state for the headers column in the browse fragment. Must be one
of HEADERS_ENABLED
, HEADERS_HIDDEN
, or
HEADERS_DISABLED
.
headersState | The state of the headers for the browse fragment. |
---|
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.
This method is deprecated.
Use setOnItemViewClickedListener(OnItemViewClickedListener)
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.
listener | The listener to call when an item is clicked. |
---|
This method is deprecated.
Use setOnItemViewSelectedListener(OnItemViewSelectedListener)
Sets an item selection listener. This listener will be called when an item or row is selected by a user.
listener | The listener to call when an item or row is selected. |
---|
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.
Sets an item selection 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.
listener | The listener to call when the search element is clicked. |
---|
Sets the color used to draw the search affordance. A default brighter color will be set by the framework.
color | The color to use for the search affordance. |
---|
Sets the SearchOrbView.Colors
used to draw the search affordance.
Sets the selected row position.
Sets the selected row position with smooth animation.
Sets a title for the browse fragment.
title | The title of the browse fragment. |
---|
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:
If startEntranceTransition() is called before onViewCreated(), it will be pending and executed when view is created.
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.
withHeaders | True if the headers should transition to being shown, false if the transition should result in headers being hidden. |
---|
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.
Callback when entrance transition is ended.
Callback when entrance transition is started.
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.