OnboardingFragment

<init>

OnboardingFragment()

Deprecated: use OnboardingSupportFragment

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

Building the screen

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

• getPageCount to provide the number of pages.
• getPageTitle to provide the title of the page.
• getPageDescription to provide the description of the page.

Note that the information is used in onCreateView, so should be initialized before calling super.onCreateView.

Animation

Logo Splash Animation

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 to show the default logo animation. This method should be called in Fragment#onCreateView.
• 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

Page change animation

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

getArrowBackgroundColor

@ColorInt fun getArrowBackgroundColor(): Int

Returns the background color of the arrow if it's set through setArrowBackgroundColor(int). If no color was set, transparent is returned.

getArrowColor

@ColorInt fun getArrowColor(): Int

Returns the color of the arrow if it's set through setArrowColor(int). If no color was set, transparent is returned.

getDescriptionViewTextColor

@ColorInt fun getDescriptionViewTextColor(): Int

Returns the text color of DescriptionView if it's set through setDescriptionViewTextColor(int). If no color was set, transparent is returned.

getDotBackgroundColor

@ColorInt fun getDotBackgroundColor(): Int

Returns the background color of the dot if it's set through setDotBackgroundColor(int). If no color was set, transparent is returned.

getIconResourceId

fun getIconResourceId(): Int

Returns the resource id of the main icon.

getLogoResourceId

fun getLogoResourceId(): Int

Returns the resource ID of the splash logo image.

getStartButtonText

fun getStartButtonText(): CharSequence!

Returns the start button text if it's set through setStartButtonText(CharSequence)}. If no string was set, null is returned.

getTitleViewTextColor

@ColorInt fun getTitleViewTextColor(): Int

Returns the text color of TitleView if it's set through setTitleViewTextColor(int). If no color was set, transparent is returned.

onCreateView

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

onProvideTheme

open fun onProvideTheme(): Int

Returns the theme used for styling the fragment. The default returns -1, indicating that the host Activity's theme should be used.

onSaveInstanceState

open fun onSaveInstanceState(outState: Bundle!): Unit

onViewCreated

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

setArrowBackgroundColor

open fun setArrowBackgroundColor(@ColorInt color: Int): Unit

Sets the background color of the arrow. If not set, the default color from attr R.styleable#PagingIndicator_arrowBgColor in the theme will be used.

setArrowColor

open fun setArrowColor(@ColorInt color: Int): Unit

Sets the color of the arrow. This color will supersede the color set in the theme attribute R.styleable#PagingIndicator_arrowColor if provided. If none of these two are set, the arrow will have its original bitmap color.

setDescriptionViewTextColor

open fun setDescriptionViewTextColor(@ColorInt color: Int): Unit

Sets the text color for DescriptionView. If not set, the default textColor set in style referenced by attr R.attr#onboardingDescriptionStyle will be used.

setDotBackgroundColor

open fun setDotBackgroundColor(@ColorInt color: Int): Unit

Sets the background color of the dots. If not set, the default color from attr R.styleable#PagingIndicator_dotBgColor in the theme will be used.

setIconResouceId

fun setIconResouceId(resourceId: Int): Unit

Sets the resource id for the main icon.

setLogoResourceId

fun setLogoResourceId(id: Int): Unit

Sets the resource ID of the splash logo image. If the logo resource id set, the default logo splash animation will be played.

setStartButtonText

open fun setStartButtonText(text: CharSequence!): Unit

Sets the text on the start button text. If not set, the default text set in R.styleable#LeanbackOnboardingTheme_onboardingStartButtonStyle will be used.

setTitleViewTextColor

open fun setTitleViewTextColor(@ColorInt color: Int): Unit

Sets the text color for TitleView. If not set, the default textColor set in style referenced by attr R.attr#onboardingTitleStyle will be used.

getCurrentPageIndex

protected fun getCurrentPageIndex(): Int

Returns the index of the current page.

getPageCount

protected abstract fun getPageCount(): Int

Returns the page count.

getPageDescription

protected abstract fun getPageDescription(pageIndex: Int): CharSequence!

Returns the description of the given page.

getPageTitle

protected abstract fun getPageTitle(pageIndex: Int): CharSequence!

Returns the title of the given page.

isLogoAnimationFinished

protected fun isLogoAnimationFinished(): Boolean

Returns whether the logo enter animation is finished.

moveToNextPage

protected open fun moveToNextPage(): Unit

Navigates to the next page.

moveToPreviousPage

protected open fun moveToPreviousPage(): Unit

Navigates to the previous page.

onCreateBackgroundView

@Nullable protected abstract fun onCreateBackgroundView(
    inflater: LayoutInflater!, 
    container: ViewGroup!
): View?

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.

onCreateContentView

@Nullable protected abstract fun onCreateContentView(
    inflater: LayoutInflater!, 
    container: ViewGroup!
): View?

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.

The content view would be located at the center of the screen.

onCreateDescriptionAnimator

protected open fun onCreateDescriptionAnimator(): Animator!

Provides the entry animation for description view. This allows users to override the default fade and slide animation. Returning null will disable the animation.

onCreateEnterAnimation

@Nullable protected open fun onCreateEnterAnimation(): Animator?

Called to have the inherited class create its enter animation. The start animation runs after logo animation ends.

onCreateForegroundView

@Nullable protected abstract fun onCreateForegroundView(
    inflater: LayoutInflater!, 
    container: ViewGroup!
): View?

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.

This foreground view would have the highest z-order.

onCreateLogoAnimation

@Nullable protected open fun onCreateLogoAnimation(): Animator?

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. If this returns null, the logo animation is skipped.

onCreateTitleAnimator

protected open fun onCreateTitleAnimator(): Animator!

Provides the entry animation for title view. This allows users to override the default fade and slide animation. Returning null will disable the animation.

onFinishFragment

protected open fun onFinishFragment(): Unit

Called when the onboarding flow finishes.

onLogoAnimationFinished

protected open fun onLogoAnimationFinished(): Unit

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

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

Called when the page has been changed.

startEnterAnimation

protected fun startEnterAnimation(force: Boolean): Unit

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.