OnboardingFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

abstract class OnboardingFragment : Fragment

kotlin.Any
↳	android.app.Fragment
	↳	androidx.leanback.app.OnboardingFragment

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:

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:

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

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

OnboardingFragment 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 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.) onboardingThemeonboardingHeaderStyleonboardingTitleStyleonboardingDescriptionStyleonboardingNavigatorContainerStyleonboardingPageIndicatorStyleonboardingStartButtonStyleonboardingLogoStyle

Summary

Public constructors
`OnboardingFragment()`

Public functions
`@ColorInt Int`	`getArrowBackgroundColor()` Returns the background color of the arrow if it's set through `setArrowBackgroundColor`.
`@ColorInt Int`	`getArrowColor()` Returns the color of the arrow if it's set through `setArrowColor`.
`@ColorInt Int`	`getDescriptionViewTextColor()` Returns the text color of DescriptionView if it's set through `setDescriptionViewTextColor`.
`@ColorInt Int`	`getDotBackgroundColor()` Returns the background color of the dot if it's set through `setDotBackgroundColor`.
`Int`	`getIconResourceId()` Returns the resource id of the main icon.
`Int`	`getLogoResourceId()` Returns the resource ID of the splash logo image.
`CharSequence?`	`getStartButtonText()` Returns the start button text if it's set through `setStartButtonText`}.
`@ColorInt Int`	`getTitleViewTextColor()` Returns the text color of TitleView if it's set through `setTitleViewTextColor`.
`View?`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup?, savedInstanceState: Bundle! )` This function is deprecated.
`Int`	`onProvideTheme()` Returns the theme used for styling the fragment.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`Unit`	`onViewCreated(view: View, savedInstanceState: Bundle?)` This function is deprecated.
`Unit`	`setArrowBackgroundColor(color: @ColorInt Int)` Sets the background color of the arrow.
`Unit`	`setArrowColor(color: @ColorInt Int)` Sets the color of the arrow.
`Unit`	`setDescriptionViewTextColor(color: @ColorInt Int)` Sets the text color for DescriptionView.
`Unit`	`setDotBackgroundColor(color: @ColorInt Int)` Sets the background color of the dots.
`Unit`	`setIconResouceId(resourceId: Int)` Sets the resource id for the main icon.
`Unit`	`setLogoResourceId(id: Int)` Sets the resource ID of the splash logo image.
`Unit`	`setStartButtonText(text: CharSequence?)` Sets the text on the start button text.
`Unit`	`setTitleViewTextColor(color: @ColorInt Int)` Sets the text color for TitleView.

Protected functions
`Int`	`getCurrentPageIndex()` Returns the index of the current page.
`abstract Int`	`getPageCount()` 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`	`isLogoAnimationFinished()` Returns whether the logo enter animation is finished.
`Unit`	`moveToNextPage()` Navigates to the next page.
`Unit`	`moveToPreviousPage()` Navigates to the previous page.
`abstract View?`	`onCreateBackgroundView(inflater: LayoutInflater, container: ViewGroup)` 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.
`Animator`	`onCreateDescriptionAnimator()` Provides the entry animation for description view.
`Animator?`	`onCreateEnterAnimation()` Called to have the inherited class create its enter animation.
`abstract View?`	`onCreateForegroundView(inflater: LayoutInflater, container: ViewGroup)` 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.
`Unit`	`onFinishFragment()` Called when the onboarding flow finishes.
`Unit`	`onLogoAnimationFinished()` Called immediately after the logo animation is complete or no logo animation is specified.
`Unit`	`onPageChanged(newPage: Int, previousPage: Int)` Called when the page has been changed.
`Unit`	`startEnterAnimation(force: Boolean)` Called to start entrance transition.

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80` This property is deprecated.
`const Int`	`TRIM_MEMORY_MODERATE = 60` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This property is deprecated.
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited functions

From android.app.Fragment

`Unit`	`dump( prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>! )` This function is deprecated.
`Boolean`	`equals(o: Any!)` This function is deprecated.
`Activity!`	`getActivity()` This function is deprecated.
`Boolean`	`getAllowEnterTransitionOverlap()` This function is deprecated.
`Boolean`	`getAllowReturnTransitionOverlap()` This function is deprecated.
`Bundle!`	`getArguments()` This function is deprecated.
`FragmentManager!`	`getChildFragmentManager()` This function is deprecated.
`Context!`	`getContext()` This function is deprecated.
`Transition!`	`getEnterTransition()` This function is deprecated.
`Transition!`	`getExitTransition()` This function is deprecated.
`FragmentManager!`	`getFragmentManager()` This function is deprecated.
`Any!`	`getHost()` This function is deprecated.
`Int`	`getId()` This function is deprecated.
`LayoutInflater!`	`getLayoutInflater()` This function is deprecated.
`LoaderManager!`	`getLoaderManager()` This function is deprecated.
`Fragment!`	`getParentFragment()` This function is deprecated.
`Transition!`	`getReenterTransition()` This function is deprecated.
`Resources!`	`getResources()` This function is deprecated.
`Boolean`	`getRetainInstance()` This function is deprecated.
`Transition!`	`getReturnTransition()` This function is deprecated.
`Transition!`	`getSharedElementEnterTransition()` This function is deprecated.
`Transition!`	`getSharedElementReturnTransition()` This function is deprecated.
`String!`	`getString(resId: Int)` This function is deprecated.
`String!`	`getTag()` This function is deprecated.
`Fragment!`	`getTargetFragment()` This function is deprecated.
`Int`	`getTargetRequestCode()` This function is deprecated.
`CharSequence!`	`getText(resId: Int)` This function is deprecated.
`Boolean`	`getUserVisibleHint()` This function is deprecated.
`View!`	`getView()` This function is deprecated.
`Int`	`hashCode()` This function is deprecated.
`java-static Fragment!`	`instantiate(context: Context!, fname: String!)` This function is deprecated.
`Boolean`	`isAdded()` This function is deprecated.
`Boolean`	`isDetached()` This function is deprecated.
`Boolean`	`isHidden()` This function is deprecated.
`Boolean`	`isInLayout()` This function is deprecated.
`Boolean`	`isRemoving()` This function is deprecated.
`Boolean`	`isResumed()` This function is deprecated.
`Boolean`	`isStateSaved()` This function is deprecated.
`Boolean`	`isVisible()` This function is deprecated.
`Unit`	`onActivityCreated(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)` This function is deprecated.
`Unit`	`onAttach(activity: Activity!)` This function is deprecated.
`Unit`	`onAttachFragment(childFragment: Fragment!)` This function is deprecated.
`Unit`	`onConfigurationChanged(newConfig: Configuration!)` This function is deprecated.
`Boolean`	`onContextItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onCreate(savedInstanceState: Bundle!)` This function is deprecated.
`Animator!`	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` This function is deprecated.
`Unit`	`onCreateContextMenu( menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo! )` This function is deprecated.
`Unit`	`onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)` This function is deprecated.
`Unit`	`onDestroy()` This function is deprecated.
`Unit`	`onDestroyOptionsMenu()` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`onDetach()` This function is deprecated.
`LayoutInflater!`	`onGetLayoutInflater(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onHiddenChanged(hidden: Boolean)` This function is deprecated.
`Unit`	`onInflate( activity: Activity!, attrs: AttributeSet!, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onLowMemory()` This function is deprecated.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` This function is deprecated.
`Boolean`	`onOptionsItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onOptionsMenuClosed(menu: Menu!)` This function is deprecated.
`Unit`	`onPause()` This function is deprecated.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` This function is deprecated.
`Unit`	`onPrepareOptionsMenu(menu: Menu!)` This function is deprecated.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>!, grantResults: IntArray! )` This function is deprecated.
`Unit`	`onResume()` This function is deprecated.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onStop()` This function is deprecated.
`Unit`	`onTrimMemory(level: Int)` This function is deprecated.
`Unit`	`onViewStateRestored(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`postponeEnterTransition()` This function is deprecated.
`Unit`	`registerForContextMenu(view: View!)` This function is deprecated.
`Unit`	`requestPermissions(permissions: Array<String!>!, requestCode: Int)` This function is deprecated.
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setArguments(args: Bundle!)` This function is deprecated.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setExitTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated.
`Unit`	`setInitialSavedState(state: Fragment.SavedState!)` This function is deprecated.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` This function is deprecated.
`Unit`	`setReenterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated.
`Unit`	`setReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setTargetFragment(fragment: Fragment!, requestCode: Int)` This function is deprecated.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String!)` This function is deprecated.
`Unit`	`startActivity(intent: Intent!)` This function is deprecated.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` This function is deprecated.
`Unit`	`startIntentSenderForResult( intent: IntentSender!, requestCode: Int, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle! )` This function is deprecated.
`Unit`	`startPostponedEnterTransition()` This function is deprecated.
`String!`	`toString()` This function is deprecated.
`Unit`	`unregisterForContextMenu(view: View!)` This function is deprecated.

Public constructors

OnboardingFragment

Added in 1.1.0

Deprecated in 1.1.0

OnboardingFragment()

Public functions

getArrowBackgroundColor

Added in 1.1.0

Deprecated in 1.1.0

fun getArrowBackgroundColor(): @ColorInt Int

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

getArrowColor

Added in 1.1.0

Deprecated in 1.1.0

fun getArrowColor(): @ColorInt Int

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

getDescriptionViewTextColor

Added in 1.1.0

Deprecated in 1.1.0

fun getDescriptionViewTextColor(): @ColorInt Int

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

getDotBackgroundColor

Added in 1.1.0

Deprecated in 1.1.0

fun getDotBackgroundColor(): @ColorInt Int

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

getIconResourceId

Added in 1.1.0

Deprecated in 1.1.0

fun getIconResourceId(): Int

Returns the resource id of the main icon.

getLogoResourceId

Added in 1.1.0

Deprecated in 1.1.0

fun getLogoResourceId(): Int

Returns the resource ID of the splash logo image.

Returns
`Int`	The resource ID of the splash logo image.

getStartButtonText

Added in 1.1.0

Deprecated in 1.1.0

fun getStartButtonText(): CharSequence?

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

getTitleViewTextColor

Added in 1.1.0

Deprecated in 1.1.0

fun getTitleViewTextColor(): @ColorInt Int

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

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

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

onProvideTheme

Added in 1.1.0

Deprecated in 1.1.0

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.

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 1.1.0

Deprecated in 1.1.0

fun onSaveInstanceState(outState: Bundle!): Unit

onViewCreated

Added in 1.1.0

Deprecated in 1.1.0

fun onViewCreated(view: View, savedInstanceState: Bundle?): Unit

setArrowBackgroundColor

Added in 1.1.0

Deprecated in 1.1.0

fun setArrowBackgroundColor(color: @ColorInt Int): Unit

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

Parameters
`color: @ColorInt Int`	the color to use for arrow background

setArrowColor

Added in 1.1.0

Deprecated in 1.1.0

fun setArrowColor(color: @ColorInt Int): Unit

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

Parameters
`color: @ColorInt Int`	the color to use for arrow background

setDescriptionViewTextColor

Added in 1.1.0

Deprecated in 1.1.0

fun setDescriptionViewTextColor(color: @ColorInt Int): Unit

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

Parameters
`color: @ColorInt Int`	the color to use as the text color for DescriptionView

setDotBackgroundColor

Added in 1.1.0

Deprecated in 1.1.0

fun setDotBackgroundColor(color: @ColorInt Int): Unit

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

Parameters
`color: @ColorInt Int`	the color to use for dot backgrounds

setIconResouceId

Added in 1.1.0

Deprecated in 1.1.0

fun setIconResouceId(resourceId: Int): Unit

Sets the resource id for the main icon.

setLogoResourceId

Added in 1.1.0

Deprecated in 1.1.0

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.

Parameters
`id: Int`	The resource ID of the logo image.

setStartButtonText

Added in 1.1.0

Deprecated in 1.1.0

fun setStartButtonText(text: CharSequence?): Unit

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

Parameters
`text: CharSequence?`	the start button text

setTitleViewTextColor

Added in 1.1.0

Deprecated in 1.1.0

fun setTitleViewTextColor(color: @ColorInt Int): Unit

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

Parameters
`color: @ColorInt Int`	the color to use as the text color for TitleView

Protected functions

getCurrentPageIndex

Added in 1.1.0

Deprecated in 1.1.0

protected fun getCurrentPageIndex(): Int

Returns the index of the current page.

Returns
`Int`	The index of the current page.

getPageCount

Added in 1.1.0

Deprecated in 1.1.0

protected abstract fun getPageCount(): Int

Returns the page count.

Returns
`Int`	The page count.

getPageDescription

Added in 1.1.0

Deprecated in 1.1.0

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

Returns the description of the given page.

Parameters
`pageIndex: Int`	The page index.

Returns
`CharSequence?`	The description of the page.

getPageTitle

Added in 1.1.0

Deprecated in 1.1.0

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

Returns the title of the given page.

Parameters
`pageIndex: Int`	The page index.

Returns
`CharSequence?`	The title of the page.

isLogoAnimationFinished

Added in 1.1.0

Deprecated in 1.1.0

protected fun isLogoAnimationFinished(): Boolean

Returns whether the logo enter animation is finished.

Returns
`Boolean`	`true` if the logo enter transition is finished, `false` otherwise

moveToNextPage

Added in 1.1.0

Deprecated in 1.1.0

protected fun moveToNextPage(): Unit

Navigates to the next page.

moveToPreviousPage

Added in 1.1.0

Deprecated in 1.1.0

protected fun moveToPreviousPage(): Unit

Navigates to the previous page.

onCreateBackgroundView

Added in 1.1.0

Deprecated in 1.1.0

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.

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?`	The background view for the onboarding screen, or `null`.

onCreateContentView

Added in 1.1.0

Deprecated in 1.1.0

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.

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?`	The content view for the onboarding screen, or `null`.

onCreateDescriptionAnimator

Added in 1.1.0

Deprecated in 1.1.0

protected 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

Added in 1.1.0

Deprecated in 1.1.0

protected fun onCreateEnterAnimation(): Animator?

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

Returns
`Animator?`	The `Animator` object which runs the page enter animation.

onCreateForegroundView

Added in 1.1.0

Deprecated in 1.1.0

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.

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?`	The foreground view for the onboarding screen, or `null`.

onCreateLogoAnimation

Added in 1.1.0

Deprecated in 1.1.0

protected 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.

Returns
`Animator?`	The `Animator` object which runs the logo animation.

onCreateTitleAnimator

Added in 1.1.0

Deprecated in 1.1.0

protected 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

Added in 1.1.0

Deprecated in 1.1.0

protected fun onFinishFragment(): Unit

Called when the onboarding flow finishes.

onLogoAnimationFinished

Added in 1.1.0

Deprecated in 1.1.0

protected 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

Added in 1.1.0

Deprecated in 1.1.0

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

Called when the page has been changed.

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

startEnterAnimation

Added in 1.1.0

Deprecated in 1.1.0

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.

Parameters
`force: Boolean`	`true` if enter animation has to be performed regardless of whether it's been done in the past, `false` otherwise