HeadersFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

class HeadersFragment : Fragment

kotlin.Any
↳	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
`interface HeadersFragment.OnHeaderClickedListener` This interface is deprecated. use `HeadersSupportFragment`
`interface HeadersFragment.OnHeaderViewSelectedListener` This interface is deprecated. use `HeadersSupportFragment`

Nested types

interface HeadersFragment.OnHeaderClickedListener

This interface is deprecated.

use HeadersSupportFragment

interface HeadersFragment.OnHeaderViewSelectedListener

This interface is deprecated.

use HeadersSupportFragment

Public constructors
`HeadersFragment()`

Public functions
`ObjectAdapter!`	`getAdapter()` Returns the Adapter that represents list of rows.
`ItemBridgeAdapter!`	`getBridgeAdapter()` Returns the RecyclerView.Adapter that wraps `getAdapter`.
`PresenterSelector!`	`getPresenterSelector()` Get the presenter selector used to create and bind views.
`Int`	`getSelectedPosition()` Gets position of currently selected row.
`VerticalGridView!`	`getVerticalGridView()`
`Boolean`	`isScrolling()`
`View?`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup?, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`Unit`	`onTransitionEnd()`
`Boolean`	`onTransitionPrepare()`
`Unit`	`onTransitionStart()`
`Unit`	`onViewCreated(view: View, savedInstanceState: Bundle?)` This function is deprecated.
`Unit`	`setAdapter(rowsAdapter: ObjectAdapter!)` Sets the adapter that represents a list of rows.
`Unit`	`setAlignment(windowAlignOffsetTop: Int)`
`Unit`	`setOnHeaderClickedListener( listener: HeadersFragment.OnHeaderClickedListener! )`
`Unit`	`setOnHeaderViewSelectedListener( listener: HeadersFragment.OnHeaderViewSelectedListener! )`
`Unit`	`setPresenterSelector(presenterSelector: PresenterSelector!)` Set the presenter selector used to create and bind views.
`Unit`	`setSelectedPosition(position: Int)` Sets the selected row position with smooth animation.
`Unit`	`setSelectedPosition(position: Int, smooth: Boolean)` Sets the selected row position.

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80`
`const Int`	`TRIM_MEMORY_MODERATE = 60`
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15`
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10`
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5`
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited functions

From android.app.Fragment

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

Public constructors

HeadersFragment

Added in 1.1.0

Deprecated in 1.1.0

HeadersFragment()

Public functions

getAdapter

Added in 1.1.0

Deprecated in 1.1.0

fun getAdapter(): ObjectAdapter!

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

fun getBridgeAdapter(): ItemBridgeAdapter!

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

fun getPresenterSelector(): PresenterSelector!

Get the presenter selector used to create and bind views.

getSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

fun getSelectedPosition(): Int

Gets position of currently selected row.

Returns
`Int`	Position of currently selected row.

getVerticalGridView

Added in 1.1.0

Deprecated in 1.1.0

fun getVerticalGridView(): VerticalGridView!

isScrolling

Added in 1.1.0

Deprecated in 1.1.0

fun isScrolling(): Boolean

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

fun onCreateView(
    inflater: LayoutInflater!,
    container: ViewGroup?,
    savedInstanceState: Bundle!
): View?

onDestroyView

Added in 1.1.0

Deprecated in 1.1.0

fun onDestroyView(): Unit

onSaveInstanceState

Added in 1.1.0

Deprecated in 1.1.0

fun onSaveInstanceState(outState: Bundle!): Unit

onTransitionEnd

Added in 1.1.0

Deprecated in 1.1.0

fun onTransitionEnd(): Unit

onTransitionPrepare

Added in 1.1.0

Deprecated in 1.1.0

fun onTransitionPrepare(): Boolean

onTransitionStart

Added in 1.1.0

Deprecated in 1.1.0

fun onTransitionStart(): Unit

onViewCreated

Added in 1.1.0

Deprecated in 1.1.0

fun onViewCreated(view: View, savedInstanceState: Bundle?): Unit

Added in 1.1.0

Deprecated in 1.1.0

fun setAdapter(rowsAdapter: ObjectAdapter!): Unit

Sets the adapter that represents a list of rows.

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

setAlignment

Added in 1.1.0

Deprecated in 1.1.0

fun setAlignment(windowAlignOffsetTop: Int): Unit

setOnHeaderClickedListener

Added in 1.1.0

Deprecated in 1.1.0

fun setOnHeaderClickedListener(
    listener: HeadersFragment.OnHeaderClickedListener!
): Unit

setOnHeaderViewSelectedListener

Added in 1.1.0

Deprecated in 1.1.0

fun setOnHeaderViewSelectedListener(
    listener: HeadersFragment.OnHeaderViewSelectedListener!
): Unit

Added in 1.1.0

Deprecated in 1.1.0

fun setPresenterSelector(presenterSelector: PresenterSelector!): Unit

Set the presenter selector used to create and bind views.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

fun setSelectedPosition(position: Int): Unit

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

fun setSelectedPosition(position: Int, smooth: Boolean): Unit

Sets the selected row position.