HeadersFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

public class HeadersFragment extends Fragment

java.lang.Object
↳	android.app.Fragment
	↳	androidx.leanback.app.HeadersFragment

An fragment containing a list of row headers. Implementation must support three types of rows:

DividerRow rendered by DividerPresenter.
Row rendered by RowHeaderPresenter.
SectionRow rendered by RowHeaderPresenter.

Use setPresenterSelector in subclass constructor to customize Presenters. App may override onCreateHeadersFragment.

Summary

Nested types
`public interface HeadersFragment.OnHeaderClickedListener` This interface is deprecated. use `HeadersSupportFragment`
`public interface HeadersFragment.OnHeaderViewSelectedListener` This interface is deprecated. use `HeadersSupportFragment`

Nested types

public interface HeadersFragment.OnHeaderClickedListener

This interface is deprecated.

use HeadersSupportFragment

public interface HeadersFragment.OnHeaderViewSelectedListener

This interface is deprecated.

use HeadersSupportFragment

Public constructors
`HeadersFragment()`

Public methods
`final ObjectAdapter`	`getAdapter()` Returns the Adapter that represents list of rows.
`final ItemBridgeAdapter`	`getBridgeAdapter()` Returns the RecyclerView.Adapter that wraps `getAdapter`.
`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()`
`@Nullable View`	`onCreateView( LayoutInflater inflater, @Nullable ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onTransitionEnd()`
`boolean`	`onTransitionPrepare()`
`void`	`onTransitionStart()`
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` This method is deprecated.
`final void`	`setAdapter(ObjectAdapter rowsAdapter)` Sets the adapter that represents a list of rows.
`void`	`setAlignment(int windowAlignOffsetTop)`
`void`	`setOnHeaderClickedListener( HeadersFragment.OnHeaderClickedListener listener )`
`void`	`setOnHeaderViewSelectedListener( HeadersFragment.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 Constants

From android.content.ComponentCallbacks2

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80` This field is deprecated.
`static final int`	`TRIM_MEMORY_MODERATE = 60` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This field is deprecated.
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited methods

From android.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` This method is deprecated.
`final boolean`	`equals(Object o)` This method is deprecated.
`final Activity`	`getActivity()` This method is deprecated.
`boolean`	`getAllowEnterTransitionOverlap()` This method is deprecated.
`boolean`	`getAllowReturnTransitionOverlap()` This method is deprecated.
`final Bundle`	`getArguments()` This method is deprecated.
`final FragmentManager`	`getChildFragmentManager()` This method is deprecated.
`Context`	`getContext()` This method is deprecated.
`Transition`	`getEnterTransition()` This method is deprecated.
`Transition`	`getExitTransition()` This method is deprecated.
`final FragmentManager`	`getFragmentManager()` This method is deprecated.
`final Object`	`getHost()` This method is deprecated.
`final int`	`getId()` This method is deprecated.
`final LayoutInflater`	`getLayoutInflater()` This method is deprecated.
`LoaderManager`	`getLoaderManager()` This method is deprecated.
`final Fragment`	`getParentFragment()` This method is deprecated.
`Transition`	`getReenterTransition()` This method is deprecated.
`final Resources`	`getResources()` This method is deprecated.
`final boolean`	`getRetainInstance()` This method is deprecated.
`Transition`	`getReturnTransition()` This method is deprecated.
`Transition`	`getSharedElementEnterTransition()` This method is deprecated.
`Transition`	`getSharedElementReturnTransition()` This method is deprecated.
`final String`	`getString(int resId)` This method is deprecated.
`final String`	`getTag()` This method is deprecated.
`final Fragment`	`getTargetFragment()` This method is deprecated.
`final int`	`getTargetRequestCode()` This method is deprecated.
`final CharSequence`	`getText(int resId)` This method is deprecated.
`boolean`	`getUserVisibleHint()` This method is deprecated.
`View`	`getView()` This method is deprecated.
`final int`	`hashCode()` This method is deprecated.
`static Fragment`	`instantiate(Context context, String fname)` This method is deprecated.
`final boolean`	`isAdded()` This method is deprecated.
`final boolean`	`isDetached()` This method is deprecated.
`final boolean`	`isHidden()` This method is deprecated.
`final boolean`	`isInLayout()` This method is deprecated.
`final boolean`	`isRemoving()` This method is deprecated.
`final boolean`	`isResumed()` This method is deprecated.
`final boolean`	`isStateSaved()` This method is deprecated.
`final boolean`	`isVisible()` This method is deprecated.
`void`	`onActivityCreated(Bundle savedInstanceState)` This method is deprecated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` This method is deprecated.
`void`	`onAttach(Activity activity)` This method is deprecated.
`void`	`onAttachFragment(Fragment childFragment)` This method is deprecated.
`void`	`onConfigurationChanged(Configuration newConfig)` This method is deprecated.
`boolean`	`onContextItemSelected(MenuItem item)` This method is deprecated.
`void`	`onCreate(Bundle savedInstanceState)` This method is deprecated.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` This method is deprecated.
`void`	`onCreateContextMenu( ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo )` This method is deprecated.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` This method is deprecated.
`View`	`onCreateView( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroy()` This method is deprecated.
`void`	`onDestroyOptionsMenu()` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`void`	`onDetach()` This method is deprecated.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` This method is deprecated.
`void`	`onHiddenChanged(boolean hidden)` This method is deprecated.
`void`	`onInflate( Activity activity, AttributeSet attrs, Bundle savedInstanceState )` This method is deprecated.
`void`	`onLowMemory()` This method is deprecated.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` This method is deprecated.
`boolean`	`onOptionsItemSelected(MenuItem item)` This method is deprecated.
`void`	`onOptionsMenuClosed(Menu menu)` This method is deprecated.
`void`	`onPause()` This method is deprecated.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` This method is deprecated.
`void`	`onPrepareOptionsMenu(Menu menu)` This method is deprecated.
`void`	`onRequestPermissionsResult( int requestCode, String[] permissions, int[] grantResults )` This method is deprecated.
`void`	`onResume()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`onStart()` This method is deprecated.
`void`	`onStop()` This method is deprecated.
`void`	`onTrimMemory(int level)` This method is deprecated.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` This method is deprecated.
`void`	`onViewStateRestored(Bundle savedInstanceState)` This method is deprecated.
`void`	`postponeEnterTransition()` This method is deprecated.
`void`	`registerForContextMenu(View view)` This method is deprecated.
`final void`	`requestPermissions(String[] permissions, int requestCode)` This method is deprecated.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` This method is deprecated.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` This method is deprecated.
`void`	`setArguments(Bundle args)` This method is deprecated.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` This method is deprecated.
`void`	`setEnterTransition(Transition transition)` This method is deprecated.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` This method is deprecated.
`void`	`setExitTransition(Transition transition)` This method is deprecated.
`void`	`setHasOptionsMenu(boolean hasMenu)` This method is deprecated.
`void`	`setInitialSavedState(Fragment.SavedState state)` This method is deprecated.
`void`	`setMenuVisibility(boolean menuVisible)` This method is deprecated.
`void`	`setReenterTransition(Transition transition)` This method is deprecated.
`void`	`setRetainInstance(boolean retain)` This method is deprecated.
`void`	`setReturnTransition(Transition transition)` This method is deprecated.
`void`	`setSharedElementEnterTransition(Transition transition)` This method is deprecated.
`void`	`setSharedElementReturnTransition(Transition transition)` This method is deprecated.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` This method is deprecated.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` This method is deprecated.
`void`	`startActivity(Intent intent)` This method is deprecated.
`void`	`startActivityForResult(Intent intent, int requestCode)` This method is deprecated.
`void`	`startIntentSenderForResult( IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options )` This method is deprecated.
`void`	`startPostponedEnterTransition()` This method is deprecated.
`String`	`toString()` This method is deprecated.
`void`	`unregisterForContextMenu(View view)` This method is deprecated.

Public constructors

HeadersFragment

Added in 1.1.0

Deprecated in 1.1.0

public HeadersFragment()

Public methods

getAdapter

Added in 1.1.0

Deprecated in 1.1.0

public final ObjectAdapter getAdapter()

Returns the Adapter that represents list of rows.

Returns
`ObjectAdapter`	Adapter that represents list of rows.

getBridgeAdapter

Added in 1.1.0

Deprecated in 1.1.0

public final ItemBridgeAdapter getBridgeAdapter()

Returns the RecyclerView.Adapter that wraps getAdapter.

Returns
`ItemBridgeAdapter`	The RecyclerView.Adapter that wraps `getAdapter`.

getPresenterSelector

Added in 1.1.0

Deprecated in 1.1.0

public final PresenterSelector getPresenterSelector()

Get the presenter selector used to create and bind views.

getSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

public int getSelectedPosition()

Gets position of currently selected row.

Returns
`int`	Position of currently selected row.

getVerticalGridView

Added in 1.1.0

Deprecated in 1.1.0

public final VerticalGridView getVerticalGridView()

isScrolling

Added in 1.1.0

Deprecated in 1.1.0

public boolean isScrolling()

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

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

onDestroyView

Added in 1.1.0

Deprecated in 1.1.0

public void onDestroyView()

onSaveInstanceState

Added in 1.1.0

Deprecated in 1.1.0

public void onSaveInstanceState(Bundle outState)

onTransitionEnd

Added in 1.1.0

Deprecated in 1.1.0

public void onTransitionEnd()

onTransitionPrepare

Added in 1.1.0

Deprecated in 1.1.0

public boolean onTransitionPrepare()

onTransitionStart

Added in 1.1.0

Deprecated in 1.1.0

public void onTransitionStart()

onViewCreated

Added in 1.1.0

Deprecated in 1.1.0

public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)

Added in 1.1.0

Deprecated in 1.1.0

public final void setAdapter(ObjectAdapter rowsAdapter)

Sets the adapter that represents a list of rows.

Parameters
`ObjectAdapter rowsAdapter`	Adapter that represents list of rows.

setAlignment

Added in 1.1.0

Deprecated in 1.1.0

public void setAlignment(int windowAlignOffsetTop)

setOnHeaderClickedListener

Added in 1.1.0

Deprecated in 1.1.0

public void setOnHeaderClickedListener(
    HeadersFragment.OnHeaderClickedListener listener
)

setOnHeaderViewSelectedListener

Added in 1.1.0

Deprecated in 1.1.0

public void setOnHeaderViewSelectedListener(
    HeadersFragment.OnHeaderViewSelectedListener listener
)

Added in 1.1.0

Deprecated in 1.1.0

public final void setPresenterSelector(PresenterSelector presenterSelector)

Set the presenter selector used to create and bind views.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

public void setSelectedPosition(int position)

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

public void setSelectedPosition(int position, boolean smooth)

Sets the selected row position.