OnboardingFragment

public abstract class OnboardingFragment
extends Fragment

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


This class is deprecated.
use OnboardingSupportFragment

An OnboardingFragment 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:

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:

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:

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

OnboardingFragment must have access to an appropriate theme. Specifically, the fragment must receive 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 R.styleable.LeanbackOnboardingTheme_onboardingTheme. If present, this theme will be used by OnboardingFragment as an overlay to the Activity's theme.
  • Finally, custom subclasses of OnboardingFragment 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.) R.attr.onboardingTheme R.attr.onboardingHeaderStyle R.attr.onboardingTitleStyle R.attr.onboardingDescriptionStyle R.attr.onboardingNavigatorContainerStyle R.attr.onboardingPageIndicatorStyle R.attr.onboardingStartButtonStyle R.attr.onboardingLogoStyle

Summary

Inherited constants

Public constructors

OnboardingFragment()

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)
int onProvideTheme()

Returns the theme used for styling the fragment.

void onSaveInstanceState(Bundle outState)
void