您的应用程序可能为用户提供多步骤任务。 例如,您的应用可能需要引导用户购买额外的内容,或设置复杂的配置设置,或者只是确认一个决定。 所有这些任务都需要通过一个或多个有序的步骤或决定来步行用户。
v17 Leanback支持库提供了实现多步用户任务的类。 本课讨论如何使用GuidedStepFragment
类来指导用户完成一系列任务。 GuidedStepFragment
使用电视用户界面最佳做法,使多步骤任务易于理解并在电视设备上导航。
提供一个步骤的详细信息
GuidedStepFragment
代表一系列步骤中的一个步骤。 在视觉上,它提供了左侧的步骤信息的指导视图。 在右侧, GuidedStepFragment
提供了一个包含此步骤的可能操作或决定列表的视图。
对于多步骤任务中的每一步,请扩展GuidedStepFragment
并提供有关用户可采取的步骤和操作的上下文信息。重写onCreateGuidance()
并返回一个新的GuidanceStylist.Guidance
,其中包含上下文信息,如步骤标题,描述和图标。
@Override public GuidanceStylist.Guidance onCreateGuidance(Bundle savedInstanceState) { String title = getString(R.string.guidedstep_first_title); String breadcrumb = getString(R.string.guidedstep_first_breadcrumb); String description = getString(R.string.guidedstep_first_description); Drawable icon = getActivity().getDrawable(R.drawable.guidedstep_main_icon_1); return new GuidanceStylist.Guidance(title, description, breadcrumb, icon); }
通过在您的activity的onCreate()
方法中调用GuidedStepFragment.add()
,将GuidedStepFragment
子类添加到所需的活动中。 如果您的活动仅包含GuidedStepFragment
对象,请使用GuidedStepFragment.addAsRoot()
而不是add()
添加第一个GuidedStepFragment
。 使用addAsRoot()
可确保如果用户在查看第一个GuidedStepFragment
时按下电视遥控器上的后退按钮,则GuidedStepFragment
和父活动都将关闭。
注意: GuidedStepFragment
编程方式添加GuidedStepFragment
对象,而不是在布局XML文件中。
创建并处理用户操作
通过覆盖onCreateActions()
添加用户操作。 在您的重写中,为每个操作项目添加一个新的GuidedAction
,并提供操作字符串,描述和标识。 使用GuidedAction.Builder
添加新的操作。
@Override public void onCreateActions(List<GuidedAction> actions, Bundle savedInstanceState) { // Add "Continue" user action for this step actions.add(new GuidedAction.Builder() .id(CONTINUE) .title(getString(R.string.guidedstep_continue)) .description(getString(R.string.guidedstep_letsdoit)) .hasNext(true) .build()); ...
操作不限于单行选择。 以下是您可以创建的其他类型的操作:
- 通过设置
infoOnly(true)
添加信息标签操作。 如果将infoOnly
设置为true,则用户无法选择操作。 要提供有关用户选择的其他信息,请使用标签操作。 - 通过设置
editable(true)
添加可编辑文本操作。 如果editable
是真的,当选择操作时,用户可以使用遥控器或连接的键盘输入文本。 覆盖onGuidedActionEdited()
或onGuidedActionEditedAndProceed()
以获取用户输入的修改后的文本。 - 通过使用具有公共ID值的
checkSetId()
将操作分组为一组,可添加一组具有可检查单选按钮的操作。 具有相同检查集ID的同一列表中的所有操作都被视为链接。 当用户选择该组中的一个动作时,该动作将被检查,而所有其他动作变为未选中状态。 - 在
onCreateActions()
使用GuidedDatePickerAction.Builder
而不是GuidedAction.Builder
添加日期选择器操作。 覆盖onGuidedActionEdited()
或onGuidedActionEditedAndProceed()
以获取用户输入的修改日期值。 - 添加一个动作,使用子动作让用户从扩展的选择列表中选择。 子动作在Add子动作中描述。
- 添加一个按钮动作,出现在动作列表的右侧,并且可以轻松访问。 按钮操作在添加按钮操作中进行了描述。
您还可以添加一个可视指示器来指示选择操作导致新的步骤 - 通过设置hasNext(true)
。 对于您可以设置的所有不同属性,请参阅GuidedAction
。
要响应操作,请覆盖onGuidedActionClicked()
并处理传入的GuidedAction
。 通过检查GuidedAction.getId()
来识别选定的操作。
添加子动作
某些操作可能需要为用户提供一组额外的选择。 GuidedAction
可以指定显示为子操作下拉列表的子操作列表。
子动作列表可以包含常规动作或单选按钮动作,但不包含日期选择器或可编辑的文本动作。 此外,由于系统不支持多个级别的子动作,所以子动作不能拥有自己的一组子动作。 深层嵌套的操作会导致糟糕的用户体验。
要添加子动作,请首先创建并填充充当子动作的GuidedActions
列表:
List<GuidedAction> subActions = new ArrayList<GuidedAction>(); subActions.add(new GuidedAction.Builder() .id(SUBACTION1) .title(getString(R.string.guidedstep_subaction1_title)) .description(getString(R.string.guidedstep_subaction1_desc)) .build()); ...
在onCreateActions()
,创建一个顶级GuidedAction
,它将在选择时显示子动作列表:
@Override public void onCreateActions(List<GuidedAction> actions, Bundle savedInstanceState) { ... actions.add(new GuidedAction.Builder() .id(SUBACTIONS) .title(getString(R.string.guidedstep_subactions_title)) .description(getString(R.string.guidedstep_subactions_desc)) .subActions(subActions) .build()); ... }
最后,通过重写onSubGuidedActionClicked()
来响应子操作选择:
@Override public boolean onSubGuidedActionClicked(GuidedAction action) { // Check for which action was clicked, and handle as needed if (action.getId() == SUBACTION1) { // Subaction 1 selected } // Return true to collapse the subactions drop-down list, or // false to keep the drop-down list expanded. return true; }
添加按钮操作
如果您的指导步骤中有大量操作,用户可能需要滚动列表才能访问最常用的操作。 使用按钮操作将常用操作与操作列表分开。 按钮操作显示在操作列表的右侧并易于导航到。
按钮动作的创建和处理就像常规动作一样,但是您可以在onCreateButtonActions()
而不是onCreateActions()
创建按钮动作。 回应onGuidedActionClicked()
按钮操作。
对简单操作使用按钮操作,例如步骤之间的导航操作。 不要将日期选取器操作或其他可编辑操作用作按钮操作。另外,按钮动作不能有子动作。
将引导步骤分组为引导序列
GuidedStepFragment
代表一个单独的步骤,但是您可能会按照有序顺序执行几个步骤。 使用GuidedStepFragment.add()
将多个GuidedStepFragment
对象组合在一起,以将序列中的下一个步骤添加到片段堆栈中。
@Override public void onGuidedActionClicked(GuidedAction action) { FragmentManager fm = getFragmentManager(); if (action.getId() == CONTINUE) { GuidedStepFragment.add(fm, new SecondStepFragment()); } ...
如果用户按下电视遥控器上的后退按钮,设备将在片段堆栈中显示前一个GuidedStepFragment
。 如果您决定提供返回上一步的GuidedAction
,则可以通过调用getFragmentManager().popBackStack()
来实现Back行为。 如果您需要将用户返回到序列中更早的步骤,请使用popBackStackToGuidedStepFragment()
返回片段堆栈中的特定GuidedStepFragment
。
当用户完成序列中的最后一步时,使用finishGuidedStepFragments()
从当前堆栈中删除所有GuidedStepFragments
并返回到原始父活动。 如果使用addAsRoot()
添加第一个GuidedStepFragment
,则调用finishGuidedStepFragments()
将关闭父活动。
自定义步骤演示文稿
GuidedStepFragment
类可以使用控制表示方面的自定义主题,例如标题文本格式或步骤转换动画。 自定义主题必须继承自Theme_Leanback_GuidedStep
,并且可以为GuidanceStylist
和GuidedActionsStylist
定义的属性提供重写值。
要将自定义主题应用于GuidedStepFragment,请执行以下操作之一:
- 通过将
android:theme
属性设置为Android清单中的activity元素,将主题应用于父活动。 设置此属性将主题应用于所有子视图,并且是父活动仅包含GuidedStepFragment
对象时应用自定义主题的最简单方法。 - 如果您的活动已使用自定义主题,并且您不想将
GuidedStepFragment
样式应用于活动中的其他视图,请将LeanbackGuidedStepTheme_guidedStepTheme
属性添加到您现有的自定义活动主题中。 此属性指向只有活动中的GuidedStepFragment
对象使用的自定义主题。 - 如果在作为同一整体多步骤任务的不同活动中使用
GuidedStepFragment
对象并希望在所有步骤中使用一致的视觉主题,请覆盖GuidedStepFragment.onProvideTheme()
并返回您的自定义主题。
有关如何添加样式和主题的更多信息,请参阅样式和主题 。
GuidedStepFragment
类使用特殊的设计师类来访问和应用主题属性。 GuidanceStylist
类使用主题信息来控制左指导视图的呈现,而GuidedActionsStylist
类使用主题信息来控制正确操作视图的呈现。
要定制超出自定义主题可以提供的步骤的视觉样式,请在GuidedStepFragment.onCreateGuidanceStylist()
或GuidedStepFragment.onCreateActionsStylist()
中GuidedStepFragment.onCreateGuidanceStylist()
GuidanceStylist
或GuidedActionsStylist
并返回您的子类。 有关您可以在这些子类中进行自定义的详细信息,请参阅GuidanceStylist
和GuidedActionsStylist
的文档。