HeadersSupportFragment
public
class
HeadersSupportFragment
extends Fragment
java.lang.Object | ||
↳ | androidx.fragment.app.Fragment | |
↳ | androidx.leanback.app.HeadersSupportFragment |
An fragment containing a list of row headers. Implementation must support three types of rows:
DividerRow
rendered byDividerPresenter
.Row
rendered byRowHeaderPresenter
.SectionRow
rendered byRowHeaderPresenter
.
setPresenterSelector(PresenterSelector)
in subclass constructor to customize
Presenters. App may override BrowseSupportFragment.onCreateHeadersSupportFragment()
.
Summary
Nested classes | |
---|---|
interface |
HeadersSupportFragment.OnHeaderClickedListener
Interface definition for a callback to be invoked when a header item is clicked. |
interface |
HeadersSupportFragment.OnHeaderViewSelectedListener
Interface definition for a callback to be invoked when a header item is selected. |
Public constructors | |
---|---|
HeadersSupportFragment()
|
Public methods | |
---|---|
final
ObjectAdapter
|
getAdapter()
Returns the Adapter that represents list of rows. |
final
ItemBridgeAdapter
|
getBridgeAdapter()
Returns the RecyclerView.Adapter that wraps |
final
PresenterSelector
|
getPresenterSelector()
Get the presenter selector used to create and bind views. |
int
|
getSelectedPosition()
Gets position of currently selected row. |
final
VerticalGridView
|
getVerticalGridView()
|
boolean
|
isScrolling()
|
View
|
onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Called to have the fragment instantiate its user interface view. |
void
|
onDestroyView()
Called when the view previously created by |
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 if its process is restarted. |
void
|
onTransitionEnd()
|
boolean
|
onTransitionPrepare()
|
void
|
onTransitionStart()
|
void
|
onViewCreated(View view, Bundle savedInstanceState)
Called immediately after |
final
void
|
setAdapter(ObjectAdapter rowsAdapter)
Sets the adapter that represents a list of rows. |
void
|
setAlignment(int windowAlignOffsetTop)
|
void
|
setOnHeaderClickedListener(HeadersSupportFragment.OnHeaderClickedListener listener)
|
void
|
setOnHeaderViewSelectedListener(HeadersSupportFragment.OnHeaderViewSelectedListener listener)
|
final
void
|
setPresenterSelector(PresenterSelector presenterSelector)
Set the presenter selector used to create and bind views. |
void
|
setSelectedPosition(int position)
Sets the selected row position with smooth animation. |
void
|
setSelectedPosition(int position, boolean smooth)
Sets the selected row position. |
Inherited methods | |
---|---|
Public constructors
HeadersSupportFragment
public HeadersSupportFragment ()
Public methods
getAdapter
public final ObjectAdapter getAdapter ()
Returns the Adapter that represents list of rows.
Returns | |
---|---|
ObjectAdapter |
Adapter that represents list of rows. |
getBridgeAdapter
public final ItemBridgeAdapter getBridgeAdapter ()
Returns the RecyclerView.Adapter that wraps getAdapter()
.
Returns | |
---|---|
ItemBridgeAdapter |
The RecyclerView.Adapter that wraps getAdapter() .
|
getPresenterSelector
public final PresenterSelector getPresenterSelector ()
Get the presenter selector used to create and bind views.
Returns | |
---|---|
PresenterSelector |
getSelectedPosition
public int getSelectedPosition ()
Gets position of currently selected row.
Returns | |
---|---|
int |
Position of currently selected row. |
isScrolling
public boolean isScrolling ()
Returns | |
---|---|
boolean |
onCreateView
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. This will be called between
onCreate(Bundle)
and onViewCreated(View, Bundle)
.
A default View can be returned by calling Fragment(int)
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(View, 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. |
onDestroyView
public 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
public 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 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(Bundle)
,
onCreateView(LayoutInflater, ViewGroup, Bundle)
, and
onViewCreated(View, 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.
|
onTransitionEnd
public void onTransitionEnd ()
onTransitionPrepare
public boolean onTransitionPrepare ()
Returns | |
---|---|
boolean |
onTransitionStart
public void onTransitionStart ()
onViewCreated
public 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.
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.
Parameters | |
---|---|
view |
View : The View returned by onCreateView(LayoutInflater, ViewGroup, Bundle) . |
savedInstanceState |
Bundle : If non-null, this fragment is being re-constructed
from a previous saved state as given here.
|
setAdapter
public final void setAdapter (ObjectAdapter rowsAdapter)
Sets the adapter that represents a list of rows.
Parameters | |
---|---|
rowsAdapter |
ObjectAdapter : Adapter that represents list of rows.
|
setAlignment
public void setAlignment (int windowAlignOffsetTop)
Parameters | |
---|---|
windowAlignOffsetTop |
int |
setOnHeaderClickedListener
public void setOnHeaderClickedListener (HeadersSupportFragment.OnHeaderClickedListener listener)
Parameters | |
---|---|
listener |
HeadersSupportFragment.OnHeaderClickedListener |
setOnHeaderViewSelectedListener
public void setOnHeaderViewSelectedListener (HeadersSupportFragment.OnHeaderViewSelectedListener listener)
Parameters | |
---|---|
listener |
HeadersSupportFragment.OnHeaderViewSelectedListener |
setPresenterSelector
public final void setPresenterSelector (PresenterSelector presenterSelector)
Set the presenter selector used to create and bind views.
Parameters | |
---|---|
presenterSelector |
PresenterSelector |
setSelectedPosition
public void setSelectedPosition (int position)
Sets the selected row position with smooth animation.
Parameters | |
---|---|
position |
int |
setSelectedPosition
public void setSelectedPosition (int position, boolean smooth)
Sets the selected row position.
Parameters | |
---|---|
position |
int |
smooth |
boolean |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-02-24 UTC.