# OnboardingSupportFragment
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Summary:[XML Attrs](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#lattrs)\|[Ctors](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#pubmethods)\|[Protected Methods](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#promethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)
# OnboardingSupportFragment
| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).
`
public
abstract
class
OnboardingSupportFragment
`
`
``
extends `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)`
``
`
|---|---|------------------------------------------------------------|
| java.lang.Object |||
| ↳ | [android.support.v4.app.Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) ||
| | ↳ | android.support.v17.leanback.app.OnboardingSupportFragment |
*** ** * ** ***
An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications.
### Building the screen
The view structure of onboarding screen is composed of the common parts and custom parts. The common parts are composed of icon, title, description and page navigator and the custom parts are composed of background, contents and foreground.
To build the screen views, the inherited class should override:
- [onCreateBackgroundView(LayoutInflater, ViewGroup)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateBackgroundView(android.view.LayoutInflater, android.view.ViewGroup))to provide the background view. Background view has the same size as the screen and the lowest z-order.
- [onCreateContentView(LayoutInflater, ViewGroup)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateContentView(android.view.LayoutInflater, android.view.ViewGroup))to provide the contents view. The content view is located in the content area at the center of the screen.
- [onCreateForegroundView(LayoutInflater, ViewGroup)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateForegroundView(android.view.LayoutInflater, android.view.ViewGroup))to provide the foreground view. Foreground view has the same size as the screen and the highest z-order
Each of these methods can return`null`if the application doesn't want to provide it.
### Page information
The onboarding screen may have several pages which explain the functionality of the application. The inherited class should provide the page information by overriding the methods:
- [getPageCount()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getPageCount())to provide the number of pages.
- [getPageTitle(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getPageTitle(int))to provide the title of the page.
- [getPageDescription(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getPageDescription(int))to provide the description of the page.
Note that the information is used in[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)), so should be initialized before calling`super.onCreateView`.
### Animation
Onboarding screen has three kinds of animations:
#### Logo Splash Animation
When onboarding screen appears, the logo splash animation is played by default. The animation fades in the logo image, pauses in a few seconds and fades it out.
In most cases, the logo animation needs to be customized because the logo images of applications are different from each other, or some applications may want to show their own animations.
The logo animation can be customized in two ways:
- The simplest way is to provide the logo image by calling[setLogoResourceId(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setLogoResourceId(int))to show the default logo animation. This method should be called in[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)).
- If the logo animation is complex, then override[onCreateLogoAnimation()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateLogoAnimation())and return the[Animator](https://developer.android.com/reference/android/animation/Animator.html)object to run.
If the inherited class provides neither the logo image nor the animation, the logo animation will be omitted.
#### Page enter animation
After logo animation finishes, page enter animation starts, which causes the header section - title and description views to fade and slide in. Users can override the default fade + slide animation by overriding[onCreateTitleAnimator()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateTitleAnimator())\&[onCreateDescriptionAnimator()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateDescriptionAnimator()). By default we don't animate the custom views but users can provide animation by overriding[onCreateEnterAnimation()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateEnterAnimation()).
#### Page change animation
When the page changes, the default animations of the title and description are played. The inherited class can override[onPageChanged(int, int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onPageChanged(int, int))to start the custom animations.
### Finishing the screen
If the user finishes the onboarding screen after navigating all the pages,[onFinishFragment()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onFinishFragment())is called. The inherited class can override this method to show another fragment or activity, or just remove this fragment.
### Theming
OnboardingSupportFragment must have access to an appropriate theme. Specifically, the fragment must receive[Theme_Leanback_Onboarding](https://developer.android.com/reference/android/support/v17/leanback/R.style#Theme_Leanback_Onboarding), or a theme whose parent is set to that theme. Themes can be provided in one of three ways:
- The simplest way is to set the theme for the host Activity to the Onboarding theme or a theme that derives from it.
- If the Activity already has a theme and setting its parent theme is inconvenient, the existing Activity theme can have an entry added for the attribute[LeanbackOnboardingTheme_onboardingTheme](https://developer.android.com/reference/android/support/v17/leanback/R.styleable#LeanbackOnboardingTheme_onboardingTheme). If present, this theme will be used by OnboardingSupportFragment as an overlay to the Activity's theme.
- Finally, custom subclasses of OnboardingSupportFragment may provide a theme through the[onProvideTheme()](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onProvideTheme())method. This can be useful if a subclass is used across multiple Activities.
If the theme is provided in multiple ways, the onProvideTheme override has priority, followed by the Activity's theme. (Themes whose parent theme is already set to the onboarding theme do not need to set the onboardingTheme attribute; if set, it will be ignored.)
## Summary
| ### XML attributes ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [`LeanbackOnboardingTheme_onboardingDescriptionStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingDescriptionStyle) | |
| [`LeanbackOnboardingTheme_onboardingHeaderStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingHeaderStyle) | |
| [`LeanbackOnboardingTheme_onboardingLogoStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingLogoStyle) | |
| [`LeanbackOnboardingTheme_onboardingNavigatorContainerStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingNavigatorContainerStyle) | |
| [`LeanbackOnboardingTheme_onboardingPageIndicatorStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingPageIndicatorStyle) | |
| [`LeanbackOnboardingTheme_onboardingStartButtonStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingStartButtonStyle) | |
| [`LeanbackOnboardingTheme_onboardingTheme`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingTheme) | |
| [`LeanbackOnboardingTheme_onboardingTitleStyle`](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#attr_LeanbackOnboardingTheme_onboardingTitleStyle) | |
| ### Public constructors ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[OnboardingSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#OnboardingSupportFragment())`() ` |
| ### Public methods ||
|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` final int` | ` `[getArrowBackgroundColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getArrowBackgroundColor())`() ` Returns the background color of the arrow if it's set through[setArrowBackgroundColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setArrowBackgroundColor(int)). |
| ` final int` | ` `[getArrowColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getArrowColor())`() ` Returns the color of the arrow if it's set through[setArrowColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setArrowColor(int)). |
| ` final int` | ` `[getDescriptionViewTextColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getDescriptionViewTextColor())`() ` Returns the text color of DescriptionView if it's set through[setDescriptionViewTextColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setDescriptionViewTextColor(int)). |
| ` final int` | ` `[getDotBackgroundColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getDotBackgroundColor())`() ` Returns the background color of the dot if it's set through[setDotBackgroundColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setDotBackgroundColor(int)). |
| ` final int` | ` `[getIconResourceId](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getIconResourceId())`() ` Returns the resource id of the main icon. |
| ` final int` | ` `[getLogoResourceId](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getLogoResourceId())`() ` Returns the resource ID of the splash logo image. |
| ` final CharSequence` | ` `[getStartButtonText](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getStartButtonText())`() ` Returns the start button text if it's set through[setStartButtonText(CharSequence)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setStartButtonText(java.lang.CharSequence))}. |
| ` final int` | ` `[getTitleViewTextColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getTitleViewTextColor())`() ` Returns the text color of TitleView if it's set through[setTitleViewTextColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setTitleViewTextColor(int)). |
| ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateView](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called to have the fragment instantiate its user interface view. |
| ` int` | ` `[onProvideTheme](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onProvideTheme())`() ` Returns the theme used for styling the fragment. |
| ` void` | ` `[onSaveInstanceState](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onSaveInstanceState(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` outState) ` 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. |
| ` void` | ` `[onViewCreated](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onViewCreated(android.view.View, android.os.Bundle))`(`[View](https://developer.android.com/reference/android/view/View.html)` view, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called immediately after[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))has returned, but before any saved state has been restored in to the view. |
| ` void` | ` `[setArrowBackgroundColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setArrowBackgroundColor(int))`(int color) ` Sets the background color of the arrow. |
| ` void` | ` `[setArrowColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setArrowColor(int))`(int color) ` Sets the color of the arrow. |
| ` void` | ` `[setDescriptionViewTextColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setDescriptionViewTextColor(int))`(int color) ` Sets the text color for DescriptionView. |
| ` void` | ` `[setDotBackgroundColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setDotBackgroundColor(int))`(int color) ` Sets the background color of the dots. |
| ` final void` | ` `[setIconResouceId](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setIconResouceId(int))`(int resourceId) ` Sets the resource id for the main icon. |
| ` final void` | ` `[setLogoResourceId](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setLogoResourceId(int))`(int id) ` Sets the resource ID of the splash logo image. |
| ` void` | ` `[setStartButtonText](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setStartButtonText(java.lang.CharSequence))`(CharSequence text) ` Sets the text on the start button text. |
| ` void` | ` `[setTitleViewTextColor](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setTitleViewTextColor(int))`(int color) ` Sets the text color for TitleView. |
| ### Protected methods ||
|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` final int` | ` `[getCurrentPageIndex](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getCurrentPageIndex())`() ` Returns the index of the current page. |
| ` abstract int` | ` `[getPageCount](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getPageCount())`() ` Returns the page count. |
| ` abstract CharSequence` | ` `[getPageDescription](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getPageDescription(int))`(int pageIndex) ` Returns the description of the given page. |
| ` abstract CharSequence` | ` `[getPageTitle](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#getPageTitle(int))`(int pageIndex) ` Returns the title of the given page. |
| ` final boolean` | ` `[isLogoAnimationFinished](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#isLogoAnimationFinished())`() ` Returns whether the logo enter animation is finished. |
| ` void` | ` `[moveToNextPage](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#moveToNextPage())`() ` Navigates to the next page. |
| ` void` | ` `[moveToPreviousPage](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#moveToPreviousPage())`() ` Navigates to the previous page. |
| ` abstract `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateBackgroundView](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateBackgroundView(android.view.LayoutInflater, android.view.ViewGroup))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container) ` Called to have the inherited class create background view. |
| ` abstract `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateContentView](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateContentView(android.view.LayoutInflater, android.view.ViewGroup))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container) ` Called to have the inherited class create content view. |
| ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` `[onCreateDescriptionAnimator](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateDescriptionAnimator())`() ` Provides the entry animation for description view. |
| ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` `[onCreateEnterAnimation](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateEnterAnimation())`() ` Called to have the inherited class create its enter animation. |
| ` abstract `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateForegroundView](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateForegroundView(android.view.LayoutInflater, android.view.ViewGroup))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container) ` Called to have the inherited class create foreground view. |
| ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` `[onCreateLogoAnimation](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateLogoAnimation())`() ` Called to have the inherited class create its own logo animation. |
| ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` `[onCreateTitleAnimator](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateTitleAnimator())`() ` Provides the entry animation for title view. |
| ` void` | ` `[onFinishFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onFinishFragment())`() ` Called when the onboarding flow finishes. |
| ` void` | ` `[onLogoAnimationFinished](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onLogoAnimationFinished())`() ` Called immediately after the logo animation is complete or no logo animation is specified. |
| ` void` | ` `[onPageChanged](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onPageChanged(int, int))`(int newPage, int previousPage) ` Called when the page has been changed. |
| ` final void` | ` `[startEnterAnimation](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#startEnterAnimation(boolean))`(boolean force) ` Called to start entrance transition. |
| ### Inherited methods |
|-----------------------|---|
| [](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)From class` `[android.support.v4.app.Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)` ` |--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[dump](https://developer.android.com/reference/android/support/v4/app/Fragment#dump(java.lang.String, java.io.FileDescriptor, java.io.PrintWriter, java.lang.String[]))`(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) ` Print the Fragments's state into the given stream. | | ` final boolean` | ` `[equals](https://developer.android.com/reference/android/support/v4/app/Fragment#equals(java.lang.Object))`(Object o) ` Subclasses can not override equals(). | | ` final `[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity) | ` `[getActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#getActivity())`() ` Return the[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity)this fragment is currently associated with. | | ` boolean` | ` `[getAllowEnterTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#getAllowEnterTransitionOverlap())`() ` Returns whether the the exit transition and enter transition overlap or not. | | ` boolean` | ` `[getAllowReturnTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#getAllowReturnTransitionOverlap())`() ` Returns whether the the return transition and reenter transition overlap or not. | | ` final `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` `[getArguments](https://developer.android.com/reference/android/support/v4/app/Fragment#getArguments())`() ` Return the arguments supplied when the fragment was instantiated, if any. | | ` final `[FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) | ` `[getChildFragmentManager](https://developer.android.com/reference/android/support/v4/app/Fragment#getChildFragmentManager())`() ` Return a private FragmentManager for placing and managing Fragments inside of this Fragment. | | ` `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[getContext](https://developer.android.com/reference/android/support/v4/app/Fragment#getContext())`() ` Return the[Context](https://developer.android.com/reference/android/content/Context.html)this fragment is currently associated with. | | ` Object` | ` `[getEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getEnterTransition())`() ` Returns the Transition that will be used to move Views into the initial scene. | | ` Object` | ` `[getExitTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getExitTransition())`() ` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. | | ` final `[FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) | ` `[getFragmentManager](https://developer.android.com/reference/android/support/v4/app/Fragment#getFragmentManager())`() ` Return the FragmentManager for interacting with fragments associated with this fragment's activity. | | ` final Object` | ` `[getHost](https://developer.android.com/reference/android/support/v4/app/Fragment#getHost())`() ` Return the host object of this fragment. | | ` final int` | ` `[getId](https://developer.android.com/reference/android/support/v4/app/Fragment#getId())`() ` Return the identifier this fragment is known by. | | ` final `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html) | ` `[getLayoutInflater](https://developer.android.com/reference/android/support/v4/app/Fragment#getLayoutInflater())`() ` Returns the cached LayoutInflater used to inflate Views of this Fragment. | | ` Lifecycle` | ` `[getLifecycle](https://developer.android.com/reference/android/support/v4/app/Fragment#getLifecycle())`() ` | | ` `[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager) | ` `[getLoaderManager](https://developer.android.com/reference/android/support/v4/app/Fragment#getLoaderManager())`() ` Return the LoaderManager for this fragment. | | ` final `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[getParentFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#getParentFragment())`() ` Returns the parent Fragment containing this Fragment. | | ` Object` | ` `[getReenterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getReenterTransition())`() ` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. | | ` final `[Resources](https://developer.android.com/reference/android/content/res/Resources.html) | ` `[getResources](https://developer.android.com/reference/android/support/v4/app/Fragment#getResources())`() ` Return`requireActivity().getResources()`. | | ` final boolean` | ` `[getRetainInstance](https://developer.android.com/reference/android/support/v4/app/Fragment#getRetainInstance())`() ` | | ` Object` | ` `[getReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getReturnTransition())`() ` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. | | ` Object` | ` `[getSharedElementEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getSharedElementEnterTransition())`() ` Returns the Transition that will be used for shared elements transferred into the content Scene. | | ` Object` | ` `[getSharedElementReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getSharedElementReturnTransition())`() ` Return the Transition that will be used for shared elements transferred back during a pop of the back stack. | | ` final String` | ` `[getString](https://developer.android.com/reference/android/support/v4/app/Fragment#getString(int, java.lang.Object...))`(int resId, Object... formatArgs) ` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in[Formatter](https://developer.android.com/reference/java/util/Formatter)and[format(String, Object...)](https://developer.android.com/reference/java/lang/String#format(java.lang.String, java.lang.Object...)). | | ` final String` | ` `[getString](https://developer.android.com/reference/android/support/v4/app/Fragment#getString(int))`(int resId) ` Return a localized string from the application's package's default string table. | | ` final String` | ` `[getTag](https://developer.android.com/reference/android/support/v4/app/Fragment#getTag())`() ` Get the tag name of the fragment, if specified. | | ` final `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[getTargetFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#getTargetFragment())`() ` Return the target fragment set by[setTargetFragment(Fragment, int)](https://developer.android.com/reference/android/support/v4/app/Fragment#setTargetFragment(android.support.v4.app.Fragment, int)). | | ` final int` | ` `[getTargetRequestCode](https://developer.android.com/reference/android/support/v4/app/Fragment#getTargetRequestCode())`() ` Return the target request code set by[setTargetFragment(Fragment, int)](https://developer.android.com/reference/android/support/v4/app/Fragment#setTargetFragment(android.support.v4.app.Fragment, int)). | | ` final CharSequence` | ` `[getText](https://developer.android.com/reference/android/support/v4/app/Fragment#getText(int))`(int resId) ` Return a localized, styled CharSequence from the application's package's default string table. | | ` boolean` | ` `[getUserVisibleHint](https://developer.android.com/reference/android/support/v4/app/Fragment#getUserVisibleHint())`() ` | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[getView](https://developer.android.com/reference/android/support/v4/app/Fragment#getView())`() ` Get the root view for the fragment's layout (the one returned by[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))), if provided. | | ` ViewModelStore` | ` `[getViewModelStore](https://developer.android.com/reference/android/support/v4/app/Fragment#getViewModelStore())`() ` | | ` final int` | ` `[hashCode](https://developer.android.com/reference/android/support/v4/app/Fragment#hashCode())`() ` Subclasses can not override hashCode(). | | ` static `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[instantiate](https://developer.android.com/reference/android/support/v4/app/Fragment#instantiate(android.content.Context, java.lang.String))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, String fname) ` Like[instantiate(Context, String, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#instantiate(android.content.Context, java.lang.String, android.os.Bundle))but with a null argument Bundle. | | ` static `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[instantiate](https://developer.android.com/reference/android/support/v4/app/Fragment#instantiate(android.content.Context, java.lang.String, android.os.Bundle))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, String fname, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` args) ` Create a new instance of a Fragment with the given class name. | | ` final boolean` | ` `[isAdded](https://developer.android.com/reference/android/support/v4/app/Fragment#isAdded())`() ` Return true if the fragment is currently added to its activity. | | ` final boolean` | ` `[isDetached](https://developer.android.com/reference/android/support/v4/app/Fragment#isDetached())`() ` Return true if the fragment has been explicitly detached from the UI. | | ` final boolean` | ` `[isHidden](https://developer.android.com/reference/android/support/v4/app/Fragment#isHidden())`() ` Return true if the fragment has been hidden. | | ` final boolean` | ` `[isInLayout](https://developer.android.com/reference/android/support/v4/app/Fragment#isInLayout())`() ` Return true if the layout is included as part of an activity view hierarchy via the \ tag. | | ` final boolean` | ` `[isRemoving](https://developer.android.com/reference/android/support/v4/app/Fragment#isRemoving())`() ` Return true if this fragment is currently being removed from its activity. | | ` final boolean` | ` `[isResumed](https://developer.android.com/reference/android/support/v4/app/Fragment#isResumed())`() ` Return true if the fragment is in the resumed state. | | ` final boolean` | ` `[isStateSaved](https://developer.android.com/reference/android/support/v4/app/Fragment#isStateSaved())`() ` Returns true if this fragment is added and its state has already been saved by its host. | | ` final boolean` | ` `[isVisible](https://developer.android.com/reference/android/support/v4/app/Fragment#isVisible())`() ` Return true if the fragment is currently visible to the user. | | ` void` | ` `[onActivityCreated](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityCreated(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. | | ` void` | ` `[onActivityResult](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityResult(int, int, android.content.Intent))`(int requestCode, int resultCode, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` data) ` Receive the result from a previous call to[startActivityForResult(Intent, int)](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivityForResult(android.content.Intent, int)). | | ` void` | ` `[onAttach](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.app.Activity))`(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` activity) ` *This method was deprecated in API level 24.1.0. See[onAttach(Context)](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.content.Context)).* | | ` void` | ` `[onAttach](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Called when a fragment is first attached to its context. | | ` void` | ` `[onAttachFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttachFragment(android.support.v4.app.Fragment))`(`[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)` childFragment) ` Called when a fragment is attached as a child of this fragment. | | ` void` | ` `[onConfigurationChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onConfigurationChanged(android.content.res.Configuration))`(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` newConfig) ` | | ` boolean` | ` `[onContextItemSelected](https://developer.android.com/reference/android/support/v4/app/Fragment#onContextItemSelected(android.view.MenuItem))`(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` item) ` This hook is called whenever an item in a context menu is selected. | | ` void` | ` `[onCreate](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreate(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called to do initial creation of a fragment. | | ` `[Animation](https://developer.android.com/reference/android/view/animation/Animation.html) | ` `[onCreateAnimation](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateAnimation(int, boolean, int))`(int transit, boolean enter, int nextAnim) ` Called when a fragment loads an animation. | | ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` `[onCreateAnimator](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateAnimator(int, boolean, int))`(int transit, boolean enter, int nextAnim) ` Called when a fragment loads an animator. | | ` void` | ` `[onCreateContextMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateContextMenu(android.view.ContextMenu, android.view.View, android.view.ContextMenu.ContextMenuInfo))`(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` menu, `[View](https://developer.android.com/reference/android/view/View.html)` v, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` menuInfo) ` Called when a context menu for the`view`is about to be shown. | | ` void` | ` `[onCreateOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateOptionsMenu(android.view.Menu, android.view.MenuInflater))`(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` menu, `[MenuInflater](https://developer.android.com/reference/android/view/MenuInflater.html)` inflater) ` Initialize the contents of the Fragment host's standard options menu. | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateView](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called to have the fragment instantiate its user interface view. | | ` void` | ` `[onDestroy](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroy())`() ` Called when the fragment is no longer in use. | | ` void` | ` `[onDestroyOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroyOptionsMenu())`() ` Called when this fragment's option menu items are no longer being included in the overall options menu. | | ` void` | ` `[onDestroyView](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroyView())`() ` Called when the view previously created by[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))has been detached from the fragment. | | ` void` | ` `[onDetach](https://developer.android.com/reference/android/support/v4/app/Fragment#onDetach())`() ` Called when the fragment is no longer attached to its activity. | | ` `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html) | ` `[onGetLayoutInflater](https://developer.android.com/reference/android/support/v4/app/Fragment#onGetLayoutInflater(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Returns the LayoutInflater used to inflate Views of this Fragment. | | ` void` | ` `[onHiddenChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onHiddenChanged(boolean))`(boolean hidden) ` Called when the hidden state (as returned by[isHidden()](https://developer.android.com/reference/android/support/v4/app/Fragment#isHidden())of the fragment has changed. | | ` void` | ` `[onInflate](https://developer.android.com/reference/android/support/v4/app/Fragment#onInflate(android.app.Activity, android.util.AttributeSet, android.os.Bundle))`(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` activity, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` attrs, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` *This method was deprecated in API level 24.1.0. See[onInflate(Context, AttributeSet, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)).* | | ` void` | ` `[onInflate](https://developer.android.com/reference/android/support/v4/app/Fragment#onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` attrs, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. | | ` void` | ` `[onLowMemory](https://developer.android.com/reference/android/support/v4/app/Fragment#onLowMemory())`() ` | | ` void` | ` `[onMultiWindowModeChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onMultiWindowModeChanged(boolean))`(boolean isInMultiWindowMode) ` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. | | ` boolean` | ` `[onOptionsItemSelected](https://developer.android.com/reference/android/support/v4/app/Fragment#onOptionsItemSelected(android.view.MenuItem))`(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` item) ` This hook is called whenever an item in your options menu is selected. | | ` void` | ` `[onOptionsMenuClosed](https://developer.android.com/reference/android/support/v4/app/Fragment#onOptionsMenuClosed(android.view.Menu))`(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` menu) ` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected). | | ` void` | ` `[onPause](https://developer.android.com/reference/android/support/v4/app/Fragment#onPause())`() ` Called when the Fragment is no longer resumed. | | ` void` | ` `[onPictureInPictureModeChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onPictureInPictureModeChanged(boolean))`(boolean isInPictureInPictureMode) ` Called by the system when the activity changes to and from picture-in-picture mode. | | ` void` | ` `[onPrepareOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onPrepareOptionsMenu(android.view.Menu))`(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` menu) ` Prepare the Fragment host's standard options menu to be displayed. | | ` void` | ` `[onRequestPermissionsResult](https://developer.android.com/reference/android/support/v4/app/Fragment#onRequestPermissionsResult(int, java.lang.String[], int[]))`(int requestCode, String[] permissions, int[] grantResults) ` Callback for the result from requesting permissions. | | ` void` | ` `[onResume](https://developer.android.com/reference/android/support/v4/app/Fragment#onResume())`() ` Called when the fragment is visible to the user and actively running. | | ` void` | ` `[onSaveInstanceState](https://developer.android.com/reference/android/support/v4/app/Fragment#onSaveInstanceState(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` outState) ` 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. | | ` void` | ` `[onStart](https://developer.android.com/reference/android/support/v4/app/Fragment#onStart())`() ` Called when the Fragment is visible to the user. | | ` void` | ` `[onStop](https://developer.android.com/reference/android/support/v4/app/Fragment#onStop())`() ` Called when the Fragment is no longer started. | | ` void` | ` `[onViewCreated](https://developer.android.com/reference/android/support/v4/app/Fragment#onViewCreated(android.view.View, android.os.Bundle))`(`[View](https://developer.android.com/reference/android/view/View.html)` view, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called immediately after[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))has returned, but before any saved state has been restored in to the view. | | ` void` | ` `[onViewStateRestored](https://developer.android.com/reference/android/support/v4/app/Fragment#onViewStateRestored(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called when all saved state has been restored into the view hierarchy of the fragment. | | ` void` | ` `[postponeEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#postponeEnterTransition())`() ` Postpone the entering Fragment transition until[startPostponedEnterTransition()](https://developer.android.com/reference/android/support/v4/app/Fragment#startPostponedEnterTransition())or[executePendingTransactions()](https://developer.android.com/reference/android/support/v4/app/FragmentManager#executePendingTransactions())has been called. | | ` void` | ` `[registerForContextMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#registerForContextMenu(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` view) ` Registers a context menu to be shown for the given view (multiple views can show the context menu). | | ` final void` | ` `[requestPermissions](https://developer.android.com/reference/android/support/v4/app/Fragment#requestPermissions(java.lang.String[], int))`(String[] permissions, int requestCode) ` Requests permissions to be granted to this application. | | ` final `[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity) | ` `[requireActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#requireActivity())`() ` Return the[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity)this fragment is currently associated with. | | ` final `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[requireContext](https://developer.android.com/reference/android/support/v4/app/Fragment#requireContext())`() ` Return the[Context](https://developer.android.com/reference/android/content/Context.html)this fragment is currently associated with. | | ` final `[FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) | ` `[requireFragmentManager](https://developer.android.com/reference/android/support/v4/app/Fragment#requireFragmentManager())`() ` Return the FragmentManager for interacting with fragments associated with this fragment's activity. | | ` final Object` | ` `[requireHost](https://developer.android.com/reference/android/support/v4/app/Fragment#requireHost())`() ` Return the host object of this fragment. | | ` void` | ` `[setAllowEnterTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#setAllowEnterTransitionOverlap(boolean))`(boolean allow) ` Sets whether the the exit transition and enter transition overlap or not. | | ` void` | ` `[setAllowReturnTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#setAllowReturnTransitionOverlap(boolean))`(boolean allow) ` Sets whether the the return transition and reenter transition overlap or not. | | ` void` | ` `[setArguments](https://developer.android.com/reference/android/support/v4/app/Fragment#setArguments(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` args) ` Supply the construction arguments for this fragment. | | ` void` | ` `[setEnterSharedElementCallback](https://developer.android.com/reference/android/support/v4/app/Fragment#setEnterSharedElementCallback(android.support.v4.app.SharedElementCallback))`(`[SharedElementCallback](https://developer.android.com/reference/android/support/v4/app/SharedElementCallback)` callback) ` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack. | | ` void` | ` `[setEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setEnterTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views into the initial scene. | | ` void` | ` `[setExitSharedElementCallback](https://developer.android.com/reference/android/support/v4/app/Fragment#setExitSharedElementCallback(android.support.v4.app.SharedElementCallback))`(`[SharedElementCallback](https://developer.android.com/reference/android/support/v4/app/SharedElementCallback)` callback) ` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack. | | ` void` | ` `[setExitTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setExitTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. | | ` void` | ` `[setHasOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#setHasOptionsMenu(boolean))`(boolean hasMenu) ` Report that this fragment would like to participate in populating the options menu by receiving a call to[onCreateOptionsMenu(Menu, MenuInflater)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateOptionsMenu(android.view.Menu, android.view.MenuInflater))and related methods. | | ` void` | ` `[setInitialSavedState](https://developer.android.com/reference/android/support/v4/app/Fragment#setInitialSavedState(android.support.v4.app.Fragment.SavedState))`(`[Fragment.SavedState](https://developer.android.com/reference/android/support/v4/app/Fragment.SavedState)` state) ` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by[FragmentManager.saveFragmentInstanceState](https://developer.android.com/reference/android/support/v4/app/FragmentManager#saveFragmentInstanceState(android.support.v4.app.Fragment)). | | ` void` | ` `[setMenuVisibility](https://developer.android.com/reference/android/support/v4/app/Fragment#setMenuVisibility(boolean))`(boolean menuVisible) ` Set a hint for whether this fragment's menu should be visible. | | ` void` | ` `[setReenterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setReenterTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. | | ` void` | ` `[setRetainInstance](https://developer.android.com/reference/android/support/v4/app/Fragment#setRetainInstance(boolean))`(boolean retain) ` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). | | ` void` | ` `[setReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setReturnTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. | | ` void` | ` `[setSharedElementEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setSharedElementEnterTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used for shared elements transferred into the content Scene. | | ` void` | ` `[setSharedElementReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setSharedElementReturnTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. | | ` void` | ` `[setTargetFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#setTargetFragment(android.support.v4.app.Fragment, int))`(`[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)` fragment, int requestCode) ` Optional target for this fragment. | | ` void` | ` `[setUserVisibleHint](https://developer.android.com/reference/android/support/v4/app/Fragment#setUserVisibleHint(boolean))`(boolean isVisibleToUser) ` Set a hint to the system about whether this fragment's UI is currently visible to the user. | | ` boolean` | ` `[shouldShowRequestPermissionRationale](https://developer.android.com/reference/android/support/v4/app/Fragment#shouldShowRequestPermissionRationale(java.lang.String))`(String permission) ` Gets whether you should show UI with rationale for requesting a permission. | | ` void` | ` `[startActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivity(android.content.Intent))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent) ` Call[startActivity(Intent)](https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent))from the fragment's containing Activity. | | ` void` | ` `[startActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivity(android.content.Intent, android.os.Bundle))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` options) ` Call[startActivity(Intent, Bundle)](https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent, android.os.Bundle))from the fragment's containing Activity. | | ` void` | ` `[startActivityForResult](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivityForResult(android.content.Intent, int))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, int requestCode) ` Call[startActivityForResult(Intent, int)](https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int))from the fragment's containing Activity. | | ` void` | ` `[startActivityForResult](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivityForResult(android.content.Intent, int, android.os.Bundle))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, int requestCode, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` options) ` Call[startActivityForResult(Intent, int, Bundle)](https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int, android.os.Bundle))from the fragment's containing Activity. | | ` void` | ` `[startIntentSenderForResult](https://developer.android.com/reference/android/support/v4/app/Fragment#startIntentSenderForResult(android.content.IntentSender, int, android.content.Intent, int, int, int, android.os.Bundle))`(`[IntentSender](https://developer.android.com/reference/android/content/IntentSender.html)` intent, int requestCode, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` fillInIntent, int flagsMask, int flagsValues, int extraFlags, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` options) ` Call[startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)](https://developer.android.com/reference/android/app/Activity.html#startIntentSenderForResult(android.content.IntentSender, int, android.content.Intent, int, int, int, android.os.Bundle))from the fragment's containing Activity. | | ` void` | ` `[startPostponedEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#startPostponedEnterTransition())`() ` Begin postponed transitions after[postponeEnterTransition()](https://developer.android.com/reference/android/support/v4/app/Fragment#postponeEnterTransition())was called. | | ` String` | ` `[toString](https://developer.android.com/reference/android/support/v4/app/Fragment#toString())`() ` | | ` void` | ` `[unregisterForContextMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#unregisterForContextMenu(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` view) ` Prevents a context menu to be shown for the given view. | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)From interface` `[android.content.ComponentCallbacks](https://developer.android.com/reference/android/content/ComponentCallbacks.html)` ` |------------------|------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` onConfigurationChanged(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg0) ` | | ` abstract void` | ` onLowMemory() ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)From interface` `[android.view.View.OnCreateContextMenuListener](https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html)` ` |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` onCreateContextMenu(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` arg0, `[View](https://developer.android.com/reference/android/view/View.html)` arg1, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` arg2) ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)From interface` android.arch.lifecycle.LifecycleOwner ` |-----------------------|--------------------| | ` abstract Lifecycle` | ` getLifecycle() ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#)From interface` android.arch.lifecycle.ViewModelStoreOwner ` |----------------------------|-------------------------| | ` abstract ViewModelStore` | ` getViewModelStore() ` | ||
## XML attributes
### LeanbackOnboardingTheme_onboardingDescriptionStyle
### LeanbackOnboardingTheme_onboardingHeaderStyle
### LeanbackOnboardingTheme_onboardingLogoStyle
### LeanbackOnboardingTheme_onboardingNavigatorContainerStyle
### LeanbackOnboardingTheme_onboardingPageIndicatorStyle
### LeanbackOnboardingTheme_onboardingStartButtonStyle
### LeanbackOnboardingTheme_onboardingTheme
### LeanbackOnboardingTheme_onboardingTitleStyle
## Public constructors
### OnboardingSupportFragment
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
OnboardingSupportFragment ()
```
## Public methods
### getArrowBackgroundColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getArrowBackgroundColor ()
```
Returns the background color of the arrow if it's set through[setArrowBackgroundColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setArrowBackgroundColor(int)). If no color was set, transparent is returned.
| Returns ||
|-------|--------|
| `int` |
|
### getArrowColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getArrowColor ()
```
Returns the color of the arrow if it's set through[setArrowColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setArrowColor(int)). If no color was set, transparent is returned.
| Returns ||
|-------|--------|
| `int` |
|
### getDescriptionViewTextColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getDescriptionViewTextColor ()
```
Returns the text color of DescriptionView if it's set through[setDescriptionViewTextColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setDescriptionViewTextColor(int)). If no color was set, transparent is returned.
| Returns ||
|-------|--------|
| `int` |
|
### getDotBackgroundColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getDotBackgroundColor ()
```
Returns the background color of the dot if it's set through[setDotBackgroundColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setDotBackgroundColor(int)). If no color was set, transparent is returned.
| Returns ||
|-------|--------|
| `int` |
|
### getIconResourceId
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getIconResourceId ()
```
Returns the resource id of the main icon.
| Returns ||
|-------|--------|
| `int` |
|
### getLogoResourceId
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getLogoResourceId ()
```
Returns the resource ID of the splash logo image.
| Returns ||
|-------|--------------------------------------------------|
| `int` | The resource ID of the splash logo image.
|
### getStartButtonText
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
CharSequence getStartButtonText ()
```
Returns the start button text if it's set through[setStartButtonText(CharSequence)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setStartButtonText(java.lang.CharSequence))}. If no string was set, null is returned.
| Returns ||
|----------------|--------|
| `CharSequence` |
|
### getTitleViewTextColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getTitleViewTextColor ()
```
Returns the text color of TitleView if it's set through[setTitleViewTextColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setTitleViewTextColor(int)). If no color was set, transparent is returned.
| Returns ||
|-------|--------|
| `int` |
|
### onCreateView
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
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)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreate(android.os.Bundle))and[onActivityCreated(Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityCreated(android.os.Bundle)).
If you return a View from here, you will later be called in[onDestroyView()](https://developer.android.com/reference/android/support/v4/app/Fragment#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](https://developer.android.com/reference/android/view/View.html) | Return the View for the fragment's UI, or null.
|
### onProvideTheme
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int onProvideTheme ()
```
Returns the theme used for styling the fragment. The default returns -1, indicating that the host Activity's theme should be used.
| Returns ||
|-------|------------------------------------------------------------------------------------------------------------|
| `int` | The theme resource ID of the theme to use in this fragment, or -1 to use the host Activity's theme.
|
### onSaveInstanceState
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
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 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)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreate(android.os.Bundle)),[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)), and[onActivityCreated(Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityCreated(android.os.Bundle)).
This corresponds to[Activity.onSaveInstanceState(Bundle)](https://developer.android.com/reference/android/app/Activity.html#onSaveInstanceState(android.os.Bundle))and most of the discussion there applies here as well. Note however:*this method may be called at any time before[onDestroy()](https://developer.android.com/reference/android/support/v4/app/Fragment#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.
|
### onViewCreated
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onViewCreated (View view,
Bundle savedInstanceState)
```
Called immediately after[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.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)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)).
|
| `savedInstanceState` | `Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.
|
### setArrowBackgroundColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setArrowBackgroundColor (int color)
```
Sets the background color of the arrow. If not set, the default color from attr[PagingIndicator_arrowBgColor](https://developer.android.com/reference/android/support/v17/leanback/R.styleable#PagingIndicator_arrowBgColor)in the theme will be used.
| Parameters ||
|---------|-----------------------------------------------------|
| `color` | `int`: the color to use for arrow background
|
### setArrowColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setArrowColor (int color)
```
Sets the color of the arrow. This color will supersede the color set in the theme attribute[PagingIndicator_arrowColor](https://developer.android.com/reference/android/support/v17/leanback/R.styleable#PagingIndicator_arrowColor)if provided. If none of these two are set, the arrow will have its original bitmap color.
| Parameters ||
|---------|-----------------------------------------------------|
| `color` | `int`: the color to use for arrow background
|
### setDescriptionViewTextColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setDescriptionViewTextColor (int color)
```
Sets the text color for DescriptionView. If not set, the default textColor set in style referenced by attr[onboardingDescriptionStyle](https://developer.android.com/reference/android/support/v17/leanback/R.attr#onboardingDescriptionStyle)will be used.
| Parameters ||
|---------|----------------------------------------------------------------------|
| `color` | `int`: the color to use as the text color for DescriptionView
|
### setDotBackgroundColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setDotBackgroundColor (int color)
```
Sets the background color of the dots. If not set, the default color from attr[PagingIndicator_dotBgColor](https://developer.android.com/reference/android/support/v17/leanback/R.styleable#PagingIndicator_dotBgColor)in the theme will be used.
| Parameters ||
|---------|----------------------------------------------------|
| `color` | `int`: the color to use for dot backgrounds
|
### setIconResouceId
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setIconResouceId (int resourceId)
```
Sets the resource id for the main icon.
| Parameters ||
|--------------|--------------|
| `resourceId` | `int`
|
### setLogoResourceId
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setLogoResourceId (int id)
```
Sets the resource ID of the splash logo image. If the logo resource id set, the default logo splash animation will be played.
| Parameters ||
|------|--------------------------------------------------|
| `id` | `int`: The resource ID of the logo image.
|
### setStartButtonText
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setStartButtonText (CharSequence text)
```
Sets the text on the start button text. If not set, the default text set in[LeanbackOnboardingTheme_onboardingStartButtonStyle](https://developer.android.com/reference/android/support/v17/leanback/R.styleable#LeanbackOnboardingTheme_onboardingStartButtonStyle)will be used.
| Parameters ||
|--------|----------------------------------------------|
| `text` | `CharSequence`: the start button text
|
### setTitleViewTextColor
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setTitleViewTextColor (int color)
```
Sets the text color for TitleView. If not set, the default textColor set in style referenced by attr[onboardingTitleStyle](https://developer.android.com/reference/android/support/v17/leanback/R.attr#onboardingTitleStyle)will be used.
| Parameters ||
|---------|----------------------------------------------------------------|
| `color` | `int`: the color to use as the text color for TitleView
|
## Protected methods
### getCurrentPageIndex
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getCurrentPageIndex ()
```
Returns the index of the current page.
| Returns ||
|-------|---------------------------------------|
| `int` | The index of the current page.
|
### getPageCount
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
int getPageCount ()
```
Returns the page count.
| Returns ||
|-------|------------------------|
| `int` | The page count.
|
### getPageDescription
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
CharSequence getPageDescription (int pageIndex)
```
Returns the description of the given page.
| Parameters ||
|-------------|-------------------------------|
| `pageIndex` | `int`: The page index.
|
| Returns ||
|----------------|-------------------------------------|
| `CharSequence` | The description of the page.
|
### getPageTitle
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
CharSequence getPageTitle (int pageIndex)
```
Returns the title of the given page.
| Parameters ||
|-------------|-------------------------------|
| `pageIndex` | `int`: The page index.
|
| Returns ||
|----------------|-------------------------------|
| `CharSequence` | The title of the page.
|
### isLogoAnimationFinished
added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
boolean isLogoAnimationFinished ()
```
Returns whether the logo enter animation is finished.
| Returns ||
|-----------|------------------------------------------------------------------------|
| `boolean` | `true`if the logo enter transition is finished,`false`otherwise
|
### moveToNextPage
added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void moveToNextPage ()
```
Navigates to the next page.
### moveToPreviousPage
added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void moveToPreviousPage ()
```
Navigates to the previous page.
### onCreateBackgroundView
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
View onCreateBackgroundView (LayoutInflater inflater,
ViewGroup container)
```
Called to have the inherited class create background view. This is optional and the fragment which doesn't have the background view can return`null`. This is called inside[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)).
| Parameters ||
|-------------|-------------------------------------------------------------------------------------------------------------------------------|
| `inflater` | `LayoutInflater`: The LayoutInflater object that can be used to inflate the views,
|
| `container` | `ViewGroup`: The parent view that the additional views are attached to.The fragment should not add the view by itself.
|
| Returns ||
|------------------------------------------------------------------------|-----------------------------------------------------------------|
| [View](https://developer.android.com/reference/android/view/View.html) | The background view for the onboarding screen, or`null`.
|
### onCreateContentView
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
View onCreateContentView (LayoutInflater inflater,
ViewGroup container)
```
Called to have the inherited class create content view. This is optional and the fragment which doesn't have the content view can return`null`. This is called inside[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)).
The content view would be located at the center of the screen.
| Parameters ||
|-------------|-------------------------------------------------------------------------------------------------------------------------------|
| `inflater` | `LayoutInflater`: The LayoutInflater object that can be used to inflate the views,
|
| `container` | `ViewGroup`: The parent view that the additional views are attached to.The fragment should not add the view by itself.
|
| Returns ||
|------------------------------------------------------------------------|--------------------------------------------------------------|
| [View](https://developer.android.com/reference/android/view/View.html) | The content view for the onboarding screen, or`null`.
|
### onCreateDescriptionAnimator
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Animator onCreateDescriptionAnimator ()
```
Provides the entry animation for description view. This allows users to override the default fade and slide animation. Returning null will disable the animation.
| Returns ||
|-------------------------------------------------------------------------------------|--------|
| [Animator](https://developer.android.com/reference/android/animation/Animator.html) |
|
### onCreateEnterAnimation
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Animator onCreateEnterAnimation ()
```
Called to have the inherited class create its enter animation. The start animation runs after logo animation ends.
| Returns ||
|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| [Animator](https://developer.android.com/reference/android/animation/Animator.html) | The[Animator](https://developer.android.com/reference/android/animation/Animator.html)object which runs the page enter animation.
|
### onCreateForegroundView
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
View onCreateForegroundView (LayoutInflater inflater,
ViewGroup container)
```
Called to have the inherited class create foreground view. This is optional and the fragment which doesn't need the foreground view can return`null`. This is called inside[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)).
This foreground view would have the highest z-order.
| Parameters ||
|-------------|-------------------------------------------------------------------------------------------------------------------------------|
| `inflater` | `LayoutInflater`: The LayoutInflater object that can be used to inflate the views,
|
| `container` | `ViewGroup`: The parent view that the additional views are attached to.The fragment should not add the view by itself.
|
| Returns ||
|------------------------------------------------------------------------|-----------------------------------------------------------------|
| [View](https://developer.android.com/reference/android/view/View.html) | The foreground view for the onboarding screen, or`null`.
|
### onCreateLogoAnimation
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Animator onCreateLogoAnimation ()
```
Called to have the inherited class create its own logo animation.
This is called only if the logo image resource ID is not set by[setLogoResourceId(int)](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment#setLogoResourceId(int)). If this returns`null`, the logo animation is skipped.
| Returns ||
|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| [Animator](https://developer.android.com/reference/android/animation/Animator.html) | The[Animator](https://developer.android.com/reference/android/animation/Animator.html)object which runs the logo animation.
|
### onCreateTitleAnimator
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Animator onCreateTitleAnimator ()
```
Provides the entry animation for title view. This allows users to override the default fade and slide animation. Returning null will disable the animation.
| Returns ||
|-------------------------------------------------------------------------------------|--------|
| [Animator](https://developer.android.com/reference/android/animation/Animator.html) |
|
### onFinishFragment
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onFinishFragment ()
```
Called when the onboarding flow finishes.
### onLogoAnimationFinished
added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onLogoAnimationFinished ()
```
Called immediately after the logo animation is complete or no logo animation is specified. This method can also be called when the activity is recreated, i.e. when no logo animation are performed. By default, this method will hide the logo view and start the entrance animation for this fragment. Overriding subclasses can provide their own data loading logic as to when the entrance animation should be executed.
### onPageChanged
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onPageChanged (int newPage,
int previousPage)
```
Called when the page has been changed.
| Parameters ||
|----------------|----------------------------------|
| `newPage` | `int`: The new page.
|
| `previousPage` | `int`: The previous page.
|
### startEnterAnimation
added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void startEnterAnimation (boolean force)
```
Called to start entrance transition. This can be called by subclasses when the logo animation and data loading is complete. If force flag is set to false, it will only start the animation if it's not already done yet. Otherwise, it will always start the enter animation. In both cases, the logo view will hide and the rest of fragment views become visible after this call.
| Parameters ||
|---------|---------------------------------------------------------------------------------------------------------------------------------|
| `force` | `boolean`:`true`if enter animation has to be performed regardless of whether it's been done in the past,`false`otherwise
|
-
## Interfaces
- [BrowseFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentHost)
- [BrowseFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterProvider)
- [BrowseFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapterProvider)
- [BrowseSupportFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentHost)
- [BrowseSupportFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterProvider)
- [BrowseSupportFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapterProvider)
- [HeadersFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderClickedListener)
- [HeadersFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderViewSelectedListener)
- [HeadersSupportFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderClickedListener)
- [HeadersSupportFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderViewSelectedListener)
- [SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider)
- [SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.SearchResultProvider)
-
## Classes
- [BackgroundManager](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager)
- [BaseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseFragment)
- [BaseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseSupportFragment)
- [BrandedFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedFragment)
- [BrandedSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedSupportFragment)
- [BrowseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment)
- [BrowseFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.BrowseTransitionListener)
- [BrowseFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentFactory)
- [BrowseFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.ListRowFragmentFactory)
- [BrowseFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapter)
- [BrowseFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterRegistry)
- [BrowseFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapter)
- [BrowseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment)
- [BrowseSupportFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.BrowseTransitionListener)
- [BrowseSupportFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentFactory)
- [BrowseSupportFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.ListRowFragmentFactory)
- [BrowseSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapter)
- [BrowseSupportFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterRegistry)
- [BrowseSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapter)
- [DetailsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragment)
- [DetailsFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragmentBackgroundController)
- [DetailsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragment)
- [DetailsSupportFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragmentBackgroundController)
- [ErrorFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorFragment)
- [ErrorSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorSupportFragment)
- [GuidedStepFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepFragment)
- [GuidedStepSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepSupportFragment)
- [HeadersFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment)
- [HeadersSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment)
- [OnboardingFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingFragment)
- [OnboardingSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment)
- [PlaybackFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment)
- [PlaybackFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragmentGlueHost)
- [PlaybackSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragment)
- [PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragmentGlueHost)
- [ProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/ProgressBarManager)
- [RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment)
- [RowsFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentAdapter)
- [RowsFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentRowsAdapter)
- [RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment)
- [RowsSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentAdapter)
- [RowsSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentRowsAdapter)
- [SearchFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment)
- [SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment)
- [VerticalGridFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridFragment)
- [VerticalGridSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridSupportFragment)
- [VideoFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragment)
- [VideoFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragmentGlueHost)
- [VideoSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragment)
- [VideoSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragmentGlueHost)