Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

OnboardingSupportFragment

abstract class OnboardingSupportFragment : Fragment
kotlin.Any
   ↳ androidx.fragment.app.Fragment
   ↳ androidx.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 to provide the background view. Background view has the same size as the screen and the lowest z-order.
  • onCreateContentView to provide the contents view. The content view is located in the content area at the center of the screen.
  • onCreateForegroundView 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:

Note that the information is used in onCreateView, 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 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 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 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.) 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

Public constructors

An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications.

Public methods
Int

Returns the background color of the arrow if it's set through setArrowBackgroundColor(int).

Int

Returns the color of the arrow if it's set through setArrowColor(int).

Int

Returns the text color of DescriptionView if it's set through setDescriptionViewTextColor(int).

Int

Returns the background color of the dot if it's set through setDotBackgroundColor(int).

Int

Returns the resource id of the main icon.

Int

Returns the resource ID of the splash logo image.

CharSequence!

Returns the start button text if it's set through setStartButtonText(CharSequence)}.

Int

Returns the text color of TitleView if it's set through setTitleViewTextColor(int).

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

open Int

Returns the theme used for styling the fragment.

open Unit

open Unit
onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)

open Unit
setArrowBackgroundColor(@ColorInt color: Int)

Sets the background color of the arrow.

open Unit
setArrowColor(@ColorInt color: Int)

Sets the color of the arrow.

open Unit
setDescriptionViewTextColor(@ColorInt color: Int)

Sets the text color for DescriptionView.

open Unit
setDotBackgroundColor(@ColorInt color: Int)

Sets the background color of the dots.

Unit
setIconResouceId(resourceId: Int)

Sets the resource id for the main icon.

Unit

Sets the resource ID of the splash logo image.

open Unit

Sets the text on the start button text.

open Unit
setTitleViewTextColor(@ColorInt color: Int)

Sets the text color for TitleView.

Protected methods
Int

Returns the index of the current page.

abstract Int

Returns the page count.

abstract CharSequence!
getPageDescription(pageIndex: Int)

Returns the description of the given page.

abstract CharSequence!
getPageTitle(pageIndex: Int)

Returns the title of the given page.

Boolean

Returns whether the logo enter animation is finished.

open Unit

Navigates to the next page.

open Unit

Navigates to the previous page.

abstract View?

Called to have the inherited class create background view.

abstract View?
onCreateContentView(inflater: LayoutInflater!, container: ViewGroup!)

Called to have the inherited class create content view.

open Animator!

Provides the entry animation for description view.

open Animator?

Called to have the inherited class create its enter animation.

abstract View?

Called to have the inherited class create foreground view.

open Animator?

Called to have the inherited class create its own logo animation.

open Animator!

Provides the entry animation for title view.

open Unit

Called when the onboarding flow finishes.

open Unit

Called immediately after the logo animation is complete or no logo animation is specified.

open Unit
onPageChanged(newPage: Int, previousPage: Int)

Called when the page has been changed.

Unit

Called to start entrance transition.

Inherited functions