added in version 24.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

OnboardingSupportFragment

public abstract class OnboardingSupportFragment
extends Fragment

java.lang.Object
↳	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) to provide the background view. Background view has the same size as the screen and the lowest z-order.
onCreateContentView(LayoutInflater, ViewGroup) to provide the contents view. The content view is located in the content area at the center of the screen.
onCreateForegroundView(LayoutInflater, 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() to provide the number of pages.
getPageTitle(int) to provide the title of the page.
getPageDescription(int) to provide the description of the page.

Note that the information is used in onCreateView(LayoutInflater, ViewGroup, 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) to show the default logo animation. This method should be called in onCreateView(LayoutInflater, ViewGroup, Bundle).
If the logo animation is complex, then override onCreateLogoAnimation() and return the Animator 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() & onCreateDescriptionAnimator(). By default we don't animate the custom views but users can provide animation by overriding 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) to start the custom animations.

Finishing the screen

If the user finishes the onboarding screen after navigating all the pages, 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, 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. 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() 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`
`LeanbackOnboardingTheme_onboardingHeaderStyle`
`LeanbackOnboardingTheme_onboardingLogoStyle`
`LeanbackOnboardingTheme_onboardingNavigatorContainerStyle`
`LeanbackOnboardingTheme_onboardingPageIndicatorStyle`
`LeanbackOnboardingTheme_onboardingStartButtonStyle`
`LeanbackOnboardingTheme_onboardingTheme`
`LeanbackOnboardingTheme_onboardingTitleStyle`

Public constructors
`OnboardingSupportFragment()`

Public methods
`final int`	`getArrowBackgroundColor()` Returns the background color of the arrow if it's set through `setArrowBackgroundColor(int)`.
`final int`	`getArrowColor()` Returns the color of the arrow if it's set through `setArrowColor(int)`.
`final int`	`getDescriptionViewTextColor()` Returns the text color of DescriptionView if it's set through `setDescriptionViewTextColor(int)`.
`final int`	`getDotBackgroundColor()` Returns the background color of the dot if it's set through `setDotBackgroundColor(int)`.
`final int`	`getIconResourceId()` Returns the resource id of the main icon.
`final int`	`getLogoResourceId()` Returns the resource ID of the splash logo image.
`final CharSequence`	`getStartButtonText()` Returns the start button text if it's set through `setStartButtonText(CharSequence)`}.
`final int`	`getTitleViewTextColor()` Returns the text color of TitleView if it's set through `setTitleViewTextColor(int)`.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`int`	`onProvideTheme()` Returns the theme used for styling the fragment.
`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.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`setArrowBackgroundColor(int color)` Sets the background color of the arrow.
`void`	`setArrowColor(int color)` Sets the color of the arrow.
`void`	`setDescriptionViewTextColor(int color)` Sets the text color for DescriptionView.
`void`	`setDotBackgroundColor(int color)` Sets the background color of the dots.
`final void`	`setIconResouceId(int resourceId)` Sets the resource id for the main icon.
`final void`	`setLogoResourceId(int id)` Sets the resource ID of the splash logo image.
`void`	`setStartButtonText(CharSequence text)` Sets the text on the start button text.
`void`	`setTitleViewTextColor(int color)` Sets the text color for TitleView.

Protected methods
`final int`	`getCurrentPageIndex()` Returns the index of the current page.
`abstract int`	`getPageCount()` Returns the page count.
`abstract CharSequence`	`getPageDescription(int pageIndex)` Returns the description of the given page.
`abstract CharSequence`	`getPageTitle(int pageIndex)` Returns the title of the given page.
`final boolean`	`isLogoAnimationFinished()` Returns whether the logo enter animation is finished.
`void`	`moveToNextPage()` Navigates to the next page.
`void`	`moveToPreviousPage()` Navigates to the previous page.
`abstract View`	`onCreateBackgroundView(LayoutInflater inflater, ViewGroup container)` Called to have the inherited class create background view.
`abstract View`	`onCreateContentView(LayoutInflater inflater, ViewGroup container)` Called to have the inherited class create content view.
`Animator`	`onCreateDescriptionAnimator()` Provides the entry animation for description view.
`Animator`	`onCreateEnterAnimation()` Called to have the inherited class create its enter animation.
`abstract View`	`onCreateForegroundView(LayoutInflater inflater, ViewGroup container)` Called to have the inherited class create foreground view.
`Animator`	`onCreateLogoAnimation()` Called to have the inherited class create its own logo animation.
`Animator`	`onCreateTitleAnimator()` Provides the entry animation for title view.
`void`	`onFinishFragment()` Called when the onboarding flow finishes.
`void`	`onLogoAnimationFinished()` Called immediately after the logo animation is complete or no logo animation is specified.
`void`	`onPageChanged(int newPage, int previousPage)` Called when the page has been changed.
`final void`	`startEnterAnimation(boolean force)` Called to start entrance transition.

Inherited methods

From class


  
    android.support.v4.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final FragmentActivity`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`final Bundle`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`final FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context`	`getContext()` Return the `Context` this fragment is currently associated with.
`Object`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Object`	`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`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()`
`LoaderManager`	`getLoaderManager()` Return the LoaderManager for this fragment.
`final Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`Object`	`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`	`getResources()` Return `requireActivity().getResources()`.
`final boolean`	`getRetainInstance()`
`Object`	`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()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Object`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String`	`getString(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` and `format(String, Object...)`.
`final String`	`getString(int resId)` Return a localized string from the application's package's default string table.
`final String`	`getTag()` Get the tag name of the fragment, if specified.
`final Fragment`	`getTargetFragment()` Return the target fragment set by `setTargetFragment(Fragment, int)`.
`final int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment(Fragment, int)`.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()`
`View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
`ViewModelStore`	`getViewModelStore()`
`final int`	`hashCode()` Subclasses can not override hashCode().
`static Fragment`	`instantiate(Context context, String fname)` Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
`static Fragment`	`instantiate(Context context, String fname, Bundle args)` Create a new instance of a Fragment with the given class name.
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(Intent, int)`.
`void`	`onAttach(Activity activity)` This method was deprecated in API level 24.1.0. See `onAttach(Context)`.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void`	`onConfigurationChanged(Configuration newConfig)`
`boolean`	`onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animation`	`onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Fragment host's standard options menu.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void`	`onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 24.1.0. See `onInflate(Context, AttributeSet, Bundle)`.
`void`	`onInflate(Context context, AttributeSet attrs, Bundle 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()`
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(Menu 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()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`onPrepareOptionsMenu(Menu menu)` Prepare the Fragment host's standard options menu to be displayed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`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.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `executePendingTransactions()` has been called.
`void`	`registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`final FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final FragmentManager`	`requireFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`requireHost()` Return the host object of this fragment.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the the return transition and reenter transition overlap or not.
`void`	`setArguments(Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(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(Object transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(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(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(boolean hasMenu)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void`	`setInitialSavedState(Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(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(boolean retain)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
`void`	`setReturnTransition(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(Object transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(Object transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` Optional target for this fragment.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` Set a hint to the system about whether this fragment's UI is currently visible to the user.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale for requesting a permission.
`void`	`startActivity(Intent intent)` Call `startActivity(Intent)` from the fragment's containing Activity.
`void`	`startActivity(Intent intent, Bundle options)` Call `startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode)` Call `startActivityForResult(Intent, int)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode, Bundle options)` Call `startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called.
`String`	`toString()`
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class


  
    java.lang.Object

From interface


  
    android.content.ComponentCallbacks

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.arch.lifecycle.LifecycleOwner

From interface


  
    android.arch.lifecycle.ViewModelStoreOwner

XML attributes

LeanbackOnboardingTheme_onboardingDescriptionStyle

LeanbackOnboardingTheme_onboardingHeaderStyle

LeanbackOnboardingTheme_onboardingLogoStyle

LeanbackOnboardingTheme_onboardingNavigatorContainerStyle

LeanbackOnboardingTheme_onboardingPageIndicatorStyle

LeanbackOnboardingTheme_onboardingStartButtonStyle

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.

Parameters
`view`	`View`: The View returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Parameters
`newPage`	`int`: The new page.
`previousPage`	`int`: The previous page.

OnboardingSupportFragment

Building the screen

Page information

Animation

Logo Splash Animation

Page enter animation

Page change animation

Finishing the screen

Theming

Summary

XML attributes

Public constructors

Public methods

Protected methods

Inherited methods

XML attributes

LeanbackOnboardingTheme_onboardingDescriptionStyle

LeanbackOnboardingTheme_onboardingHeaderStyle

LeanbackOnboardingTheme_onboardingLogoStyle

LeanbackOnboardingTheme_onboardingNavigatorContainerStyle

LeanbackOnboardingTheme_onboardingPageIndicatorStyle

LeanbackOnboardingTheme_onboardingStartButtonStyle

LeanbackOnboardingTheme_onboardingTheme

LeanbackOnboardingTheme_onboardingTitleStyle

Public constructors