Android APIs
public class

DetailsSupportFragment

extends Fragment
java.lang.Object
   ↳ android.support.v4.app.Fragment
     ↳ android.support.v17.leanback.app.DetailsSupportFragment
Known Direct Subclasses

Class Overview

Wrapper fragment for leanback details screens.

Summary

Public Constructors
DetailsSupportFragment()
Public Methods
ObjectAdapter getAdapter()
Returns the list of rows.
OnItemClickedListener getOnItemClickedListener()
This method is deprecated. Use getOnItemViewClickedListener()
OnItemViewClickedListener getOnItemViewClickedListener()
Returns the item Clicked listener.
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 onStart()
Called when the Fragment is visible to the user.
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 prepareEntranceTransition()
Enables entrance transition.
void setAdapter(ObjectAdapter adapter)
Sets the list of rows for the fragment.
void setOnItemClickedListener(OnItemClickedListener listener)
void setOnItemSelectedListener(OnItemSelectedListener listener)
void setOnItemViewClickedListener(OnItemViewClickedListener listener)
Sets an item Clicked listener.
void setOnItemViewSelectedListener(OnItemViewSelectedListener listener)
Sets an item selection listener.
void setSelectedPosition(int position, boolean smooth)
Sets the selected row position.
void setSelectedPosition(int position)
Sets the selected row position with smooth animation.
void startEntranceTransition()
When fragment finishes loading data, it should call startEntranceTransition() to execute the entrance transition.
Protected Methods
Object createEntranceTransition()
Create entrance transition.
void onEntranceTransitionEnd()
Callback when entrance transition is ended.
void onEntranceTransitionStart()
Callback when entrance transition is started.
void runEntranceTransition(Object entranceTransition)
Run entrance transition.
[Expand]
Inherited Methods
From class android.support.v4.app.Fragment
From class java.lang.Object
From interface android.content.ComponentCallbacks
From interface android.view.View.OnCreateContextMenuListener

Public Constructors

public DetailsSupportFragment ()

Public Methods

public ObjectAdapter getAdapter ()

Returns the list of rows.

public OnItemClickedListener getOnItemClickedListener ()

This method is deprecated.
Use getOnItemViewClickedListener()

Returns the item Clicked listener.

public OnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item Clicked listener.

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

public void prepareEntranceTransition ()

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:

  • Workaround the problem that activity transition is not available between launcher and app. Browse activity must programmatically start the slide-in transition.
  • Separates DetailsOverviewRow transition from other rows transition. So that the DetailsOverviewRow transition can be executed earlier without waiting for all rows to be loaded.
  • Transition object is returned by createEntranceTransition(). Typically the app does not need override the default transition that browse and details provides.

    public void setAdapter (ObjectAdapter adapter)

    Sets the list of rows for the fragment.

    public void setOnItemClickedListener (OnItemClickedListener listener)

    This method is deprecated.
    Use setOnItemViewClickedListener(OnItemViewClickedListener)

    Sets an item Clicked listener.

    public void setOnItemSelectedListener (OnItemSelectedListener listener)

    This method is deprecated.
    Use setOnItemViewSelectedListener(OnItemViewSelectedListener)

    Sets an item selection listener.

    public void setOnItemViewClickedListener (OnItemViewClickedListener listener)

    Sets an item Clicked listener.

    public void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

    Sets an item selection listener.

    public void setSelectedPosition (int position, boolean smooth)

    Sets the selected row position.

    public void setSelectedPosition (int position)

    Sets the selected row position with smooth animation.

    public void startEntranceTransition ()

    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:

  • prepareEntranceTransition() was called.
  • has not executed entrance transition yet.
  • If startEntranceTransition() is called before onViewCreated(), it will be pending and executed when view is created.

    Protected Methods

    protected 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.

    protected void onEntranceTransitionEnd ()

    Callback when entrance transition is ended.

    protected void onEntranceTransitionStart ()

    Callback when entrance transition is started.

    protected 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.