OnboardingSupportFragment

public abstract class OnboardingSupportFragment
extends Fragment

OnboardingSupportFragment提供了一种通用且简单的方法来构建应用程序的入门屏幕。

Building the screen

要构建屏幕视图，应该覆盖继承的类：

• 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

如果应用程序不想提供它们，每种方法都可以返回 null 。

Page information

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

请注意，信息用于 onCreateView(LayoutInflater, ViewGroup, Bundle) ，因此应在调用 super.onCreateView之前进行初始化。

Animation

Logo Splash Animation

在大多数情况下，标志动画需要定制，因为应用程序的标志图像彼此不同，或者某些应用程序可能想要显示自己的动画。

标志动画可以通过两种方式进行定制：

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

如果继承的类不提供徽标图像和动画，则徽标动画将被忽略。

Page enter animation

Page change animation

Finishing the screen

如果用户在浏览所有页面后完成了onFinishFragment()屏幕，则调用onFinishFragment() 。 继承的类可以重写此方法以显示另一个片段或活动，或者仅删除此片段。

Theming

OnboardingSupportFragment必须有权访问适当的主题。 具体来说，片段必须接收Theme_Leanback_Onboarding ，或者其父项设置为该主题的主题。 可以通过以下三种方式之一提供主题：

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

如果以多种方式提供主题，则onProvideTheme覆盖优先，后跟Activity的主题。 （父主题已经设置为入门主题的主题不需要设置onboardingTheme属性;如果设置，它将被忽略。）

Summary

Inherited methods
From class android.support.v4.app.Fragment void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) 将片段的状态打印到给定的流中。 final boolean equals(Object o) 子类不能覆盖equals（）。 final FragmentActivity getActivity() 返回该片段当前与之关联的 FragmentActivity 。 boolean getAllowEnterTransitionOverlap() 返回退出转换和输入转换是否重叠。 boolean getAllowReturnTransitionOverlap() 返回返回转换和重新输入转换是否重叠。 final Bundle getArguments() 返回片段实例化时提供的参数，如果有的话。 final FragmentManager getChildFragmentManager() 返回一个专用的FragmentManager，用于放置和管理这个Fragment中的碎片。 Context getContext() 返回该片段当前与之关联的 Context 。 Object getEnterTransition() 返回将用于将Views移动到初始场景的Transition。 Object getExitTransition() 当不弹出背堆栈时，返回将用于将视图移出场景的过渡，当片段被移除，隐藏或分离时。 final FragmentManager getFragmentManager() 返回FragmentManager以与与该片段活动关联的片段进行交互。 final Object getHost() 返回这个片段的主机对象。 final int getId() 返回此片段已知的标识符。 LoaderManager getLoaderManager() 为这个片段返回LoaderManager，如果需要的话创建它。 final Fragment getParentFragment() 返回包含此片段的父片段。 Object getReenterTransition() 返回由于弹出背堆栈而返回的视图，以便将视图移动到场景中。 final Resources getResources() 返回 getActivity().getResources() 。 final boolean getRetainInstance() Object getReturnTransition() 当片段准备由于弹出背堆栈而被移除，隐藏或分离时，返回将用于将视图移出场景的Transition。 Object getSharedElementEnterTransition() 返回将用于传输到内容场景中的共享元素的转换。 Object getSharedElementReturnTransition() 返回将在返回堆栈弹出期间传回的共享元素的转换。 final String getString(int resId, Object... formatArgs) 从应用程序包的默认字符串表中返回一个本地化的格式化字符串，替换 Formatter和 format(String, Object...)定义的格式参数。 final String getString(int resId) 从应用程序包的默认字符串表中返回一个本地化的字符串。 final String getTag() 获取片段的标签名称（如果指定）。 final Fragment getTargetFragment() 返回由 setTargetFragment(Fragment, int)设置的目标片段。 final int getTargetRequestCode() 返回由 setTargetFragment(Fragment, int)设置的目标请求代码。 final CharSequence getText(int resId) 从应用程序包的默认字符串表中返回一个本地化的，风格化的CharSequence。 boolean getUserVisibleHint() View getView() 获取片段布局的根视图（由 onCreateView(LayoutInflater, ViewGroup, Bundle)返回），如果提供。 final int hashCode() 子类不能重写hashCode（）。 static Fragment instantiate(Context context, String fname) 像 instantiate(Context, String, Bundle)一样，但是有一个空参数Bundle。 static Fragment instantiate(Context context, String fname, Bundle args) 用给定的类名创建一个Fragment的新实例。 final boolean isAdded() 如果片段当前被添加到其活动中，则返回true。 final boolean isDetached() 如果片段已从UI中明确分离，则返回true。 final boolean isHidden() 如果片段已隐藏，则返回true。 final boolean isInLayout() 如果通过<fragment>标签将布局作为活动视图层次结构的一部分包含在内，则返回true。 final boolean isRemoving() 如果此片段当前正从其活动中移除，则返回true。 final boolean isResumed() 如果片段处于恢复状态，则返回true。 final boolean isVisible() 如果片段当前对用户可见，则返回true。 void onActivityCreated(Bundle savedInstanceState) 当片段的活动已经创建并且该片段的视图层次被实例化时调用。 void onActivityResult(int requestCode, int resultCode, Intent data) 接收先前调用 startActivityForResult(Intent, int)的结果。 void onAttach(Activity activity) 此方法已弃用。 见onAttach(Context) 。 void onAttach(Context context) 当片段首次附加到其上下文时调用。 void onAttachFragment(Fragment childFragment) 当片段附加为此片段的子元素时调用。 void onConfigurationChanged(Configuration newConfig) 设备配置在组件运行时发生更改时由系统调用。 boolean onContextItemSelected(MenuItem item) 只要选择了上下文菜单中的项目，就会调用该钩子。 void onCreate(Bundle savedInstanceState) 被调用来做一个片段的初始创建。 Animation onCreateAnimation(int transit, boolean enter, int nextAnim) 当片段加载动画时调用。 void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) 当即将显示 view的上下文菜单时调用。 void onCreateOptionsMenu(Menu menu, MenuInflater inflater) 初始化Fragment主机的标准选项菜单的内容。 View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) 调用以使片段实例化其用户界面视图。 void onDestroy() 当碎片不再使用时调用。 void onDestroyOptionsMenu() 当此片段的选项菜单项不再包含在总体选项菜单中时调用。 void onDestroyView() 当先前由 onCreateView(LayoutInflater, ViewGroup, Bundle)创建的视图已从片段中分离时调用。 void onDetach() 当片段不再附加到其活动时调用。 void onHiddenChanged(boolean hidden) 当隐藏状态（由片段 isHidden()返回时发生变化）调用。 void onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) 此方法已弃用。 见onInflate(Context, AttributeSet, Bundle) 。 void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState) 当片段被创建为视图布局膨胀的一部分时调用，通常通过设置活动的内容视图来调用。 void onLowMemory() 这在整个系统内存不足时调用，并且主动运行的进程应该修剪内存使用情况。 void onMultiWindowModeChanged(boolean isInMultiWindowMode) 当片段的活动从全屏模式更改为多窗口模式时调用，反之亦然。 boolean onOptionsItemSelected(MenuItem item) 只要选择了选项菜单中的项目，就会调用该钩子。 void onOptionsMenuClosed(Menu menu) 只要选项菜单被关闭（通过用户使用后退/菜单按钮取消菜单，或选择某个项目时），就会调用该钩子。 void onPause() 当碎片不再恢复时调用。 void onPictureInPictureModeChanged(boolean isInPictureInPictureMode) 当活动从画中画模式切换到画中画模式时由系统调用。 void onPrepareOptionsMenu(Menu menu) 准备要显示的Fragment主机的标准选项菜单。 void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) 从请求权限回调结果。 void onResume() 当片段对用户可见且正在积极运行时调用。 void onSaveInstanceState(Bundle outState) 打电话询问片段以保存其当前的动态状态，以便稍后可以在重新启动其进程的新实例时重新构建它。 void onStart() 当片段对用户可见时调用。 void onStop() 当片段不再启动时调用。 void onViewCreated(View view, Bundle savedInstanceState) 在 onCreateView(LayoutInflater, ViewGroup, Bundle)已返回之后立即调用，但在任何已保存的状态已恢复到视图之前调用。 void onViewStateRestored(Bundle savedInstanceState) 当所有保存的状态已恢复到片段的视图层次结构中时调用。 void registerForContextMenu(View view) 为给定视图注册一个上下文菜单（多个视图可以显示上下文菜单）。 final void requestPermissions(String[] permissions, int requestCode) 请求授予此应用程序的权限。 void setAllowEnterTransitionOverlap(boolean allow) 设置退出转换和输入转换是否重叠。 void setAllowReturnTransitionOverlap(boolean allow) 设置返回转换和重新输入转换是否重叠。 void setArguments(Bundle args) 为此片段提供构造参数。 void setEnterSharedElementCallback(SharedElementCallback callback) 当使用Fragments使用自定义转换时，当此片段在未弹出返回堆栈时连接或分离时，会调用enter转换回调。 void setEnterTransition(Object transition) 设置将用于将Views移动到初始场景的Transition。 void setExitSharedElementCallback(SharedElementCallback callback) 当自定义转换与碎片一起使用时，退出转换回调在弹出回栈时附加或分离时调用。 void setExitTransition(Object transition) 设置当片段被移除，隐藏或在未弹出背堆栈时分离时将用于将视图移出场景的Transition。 void setHasOptionsMenu(boolean hasMenu) 报告此片段希望通过接收对 onCreateOptionsMenu(Menu, MenuInflater)和相关方法的调用来参与填充选项菜单。 void setInitialSavedState(Fragment.SavedState state) 设置此片段应该从第一次构建时恢复的初始保存状态，由 FragmentManager.saveFragmentInstanceState返回。 void setMenuVisibility(boolean menuVisible) 设置该片段的菜单是否可见。 void setReenterTransition(Object transition) 设置用于在由于弹出背堆栈而返回时将Views移动到场景中的Transition。 void setRetainInstance(boolean retain) 控制是否在重新创建Activity时（例如从配置更改）保留片段实例。 void setReturnTransition(Object transition) 设置当片段准备由于弹出背堆栈而被移除，隐藏或分离时将用于将视图移出场景的Transition。 void setSharedElementEnterTransition(Object transition) 设置将用于共享元素转移到内容场景的转换。 void setSharedElementReturnTransition(Object transition) 设置将在回弹堆栈弹出期间回传的共享元素的转换。 void setTargetFragment(Fragment fragment, int requestCode) 此片段的可选目标。 void setUserVisibleHint(boolean isVisibleToUser) 为系统提供一个关于此片段的用户界面当前是否可见的提示。 boolean shouldShowRequestPermissionRationale(String permission) 获取是否应该以请求许可的理由显示UI。 void startActivity(Intent intent) 从片段的Activity中调用 startActivity(Intent) 。 void startActivity(Intent intent, Bundle options) 从片段的Activity中调用 startActivity(Intent, Bundle) 。 void startActivityForResult(Intent intent, int requestCode) 从片段的Activity中调用 startActivityForResult(Intent, int) 。 void startActivityForResult(Intent intent, int requestCode, Bundle options) 从包含Activity的片段调用 startActivityForResult(Intent, int, Bundle) 。 void startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) 从片段的Activity中调用 startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle) 。 String toString() 返回对象的字符串表示形式。 void unregisterForContextMenu(View view) 防止为给定视图显示上下文菜单。
From class java.lang.Object Object clone() 创建并返回此对象的副本。 boolean equals(Object obj) 指示其他某个对象是否“等于”这一个。 void finalize() 当垃圾收集确定没有更多对该对象的引用时，由对象上的垃圾回收器调用。 final Class<?> getClass() 返回此 Object的运行时类。 int hashCode() 返回对象的哈希码值。 final void notify() 唤醒正在等待该对象监视器的单个线程。 final void notifyAll() 唤醒在该对象监视器上等待的所有线程。 String toString() 返回对象的字符串表示形式。 final void wait(long millis, int nanos) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法，或其他某个线程中断当前线程或经过一定的实时时间。 final void wait(long millis) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法或经过了指定的时间量。 final void wait() 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法。
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration newConfig) 设备配置在组件运行时发生更改时由系统调用。 abstract void onLowMemory() 这在整个系统内存不足时调用，并且主动运行的进程应该修剪内存使用情况。
From interface android.view.View.OnCreateContextMenuListener abstract void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) 在构建此视图的上下文菜单时调用。

XML attributes

android.support.v17.leanback:onboardingDescriptionStyle

主题属性，用于显示屏幕上的说明文字风格。 默认为Widget_Leanback_OnboardingDescriptionStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingHeaderStyle

主题属性，用于在入职屏幕上显示标题的样式。 默认是Widget_Leanback_OnboardingHeaderStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingLogoStyle

主题属性，用于在入职屏幕上显示徽标的样式。 默认是Widget_Leanback_OnboardingLogoStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingNavigatorContainerStyle

主题属性，用于导航屏幕上导航器容器的样式。 默认是Widget_Leanback_OnboardingNavigatorContainerStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingPageIndicatorStyle

主题属性用于页面指示器在入职屏幕上的样式。 默认是Widget_Leanback_OnboardingPageIndicatorStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingStartButtonStyle

主题属性用于开机按钮在开机屏幕上的样式。 默认是Widget_Leanback_OnboardingStartButtonStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingTheme

主题属性，用于入职时使用的整体主题。 Leanback主题为此设置了默认值，但不是从leanback主题派生的自定义主题可以将其设置为@style/Theme.Leanback.Onboarding以指定默认的OnboardingFragment样式。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

android.support.v17.leanback:onboardingTitleStyle

主题属性，用于在入职屏幕上标题文本的样式。 默认是Widget_Leanback_OnboardingTitleStyle 。

可能是另一种资源的引用，其形式为“ @[+][package:]type/name ”或形式为“一个主题属性 ?[package:]type/name ”。

Public constructors

OnboardingSupportFragment ()

Public methods

int getLogoResourceId ()

View onCreateView (LayoutInflater inflater, 
                ViewGroup container, 
                Bundle savedInstanceState)

int onProvideTheme ()

void onSaveInstanceState (Bundle outState)

void setLogoResourceId (int id)

Protected methods

int getCurrentPageIndex ()

int getPageCount ()

CharSequence getPageDescription (int pageIndex)

CharSequence getPageTitle (int pageIndex)

View onCreateBackgroundView (LayoutInflater inflater, 
                ViewGroup container)

View onCreateContentView (LayoutInflater inflater, 
                ViewGroup container)

Animator onCreateEnterAnimation ()

View onCreateForegroundView (LayoutInflater inflater, 
                ViewGroup container)

Animator onCreateLogoAnimation ()

void onFinishFragment ()

void onPageChanged (int newPage, 
                int previousPage)