Most visited

Recently visited

Results for

GuidedStepFragment

public class GuidedStepFragment
extends Fragment

java.lang.Object
↳	android.app.Fragment
	↳	android.support.v17.leanback.app.GuidedStepFragment

GuidedStepFragment用于指导用户完成一个决策或一系列决策。它由左侧的指导视图和右侧的视图组成，其中包含可能的操作列表。

Basic Usage

GuidedStepFragment的客户端必须创建一个自定义子类以附加到他们的活动。此自定义子类提供构建用户界面和响应用户操作所需的信息。至少，子类应该覆盖：

onCreateGuidance(Bundle), to provide instructions to the user
onCreateActions(List , Bundle), to provide a set of GuidedActions the user can take
onGuidedActionClicked(GuidedAction), to respond to those actions

客户使用以下帮助函数将GuidedStepFragment添加到Activity或FragmentManager：

addAsRoot(Activity, GuidedStepFragment, int), to be called during Activity onCreate, adds GuidedStepFragment as the first Fragment in activity.
add(FragmentManager, GuidedStepFragment) or add(FragmentManager, GuidedStepFragment, int), to add GuidedStepFragment on top of existing Fragments or replacing existing GuidedStepFragment when moving forward to next step.
finishGuidedStepFragments() can either finish the activity or pop all GuidedStepFragment from stack.
If app chooses not to use the helper function, it is the app's responsibility to call setUiStyle(int) to select fragment transition and remember the stack entry where it need pops to.

Theming and Stylists

GuidedStepFragment将其视觉样式委托给称为设计师的类。 GuidanceStylist负责左侧指导视图，而GuidedActionsStylist负责正确操作视图。造型师使用主题属性来派生与演示文稿相关的值，例如颜色，动画等.GuidanceStylist和GuidedActionsStylist的大多数简单视觉方面都可以通过主题进行自定义; 请参阅其文档以获取更多信息。

GuidedStepFragments必须能够访问适当的主题才能让设计师正常运作。具体来说，该片段必须接收Theme_Leanback_GuidedStep ，或者其父级被设置为该主题的主题。可以通过以下三种方式之一提供主题：

The simplest way is to set the theme for the host Activity to the GuidedStep 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 LeanbackGuidedStepTheme_guidedStepTheme. If present, this theme will be used by GuidedStepFragment as an overlay to the Activity's theme.
Finally, custom subclasses of GuidedStepFragment may provide a theme through the onProvideTheme() method. This can be useful if a subclass is used across multiple Activities.

如果主题以多种方式提供，则onProvideTheme覆盖优先，然后是Activty的主题。（父主题已经设置为引导步骤主题的主题不需要设置guidedStepTheme属性;如果设置，它将被忽略。）

如果主题没有提供足够的可定制性，那么设计师可以通过onCreateGuidanceStylist()和onCreateActionsStylist()方法将其分类并提供给onCreateActionsStylist() 。造型师有简单的挂钩，以便子类可以覆盖布局文件; 子类也可能有更复杂的逻辑来确定样式。

Guided sequences

GuidedStepFragments可以组合在一起以提供指导序列。 GuidedStepFragments按序列使用由GuidanceStylist和GuidedActionsStylist （或子类）在步骤之间转换期间提供的自定义动画。客户端应该使用add(FragmentManager, GuidedStepFragment)将后续GuidedFragments放置到片段堆栈上，以便自定义动画得到正确配置。（当片段堆栈随后被任何正常机制弹出时，自动触发自定义动画。）

注意：目前以这种方式分组的GuidedStepFragments都必须以编程方式定义，而不是以XML格式定义。 将来可能会取消此限制。

也可以看看：

Summary

XML attributes
`android.support.v17.leanback:guidedActionContentWidthWeight`	Theme attribute used for the weight of actions.
`android.support.v17.leanback:guidedActionContentWidthWeightTwoPanels`	Theme attribute used for the weight of actions when there are two panels.
`android.support.v17.leanback:guidedActionsBackground`	Theme attribute for the background of GuidedActions.
`android.support.v17.leanback:guidedActionsBackgroundDark`	Theme attribute for the dark version background of GuidedActions.
`android.support.v17.leanback:guidedActionsElevation`	Theme attribute for the shadow elevation of GuidedActions.
`android.support.v17.leanback:guidedStepBackground`	Theme attribute of background drawable used by GuidedStepFragment.
`android.support.v17.leanback:guidedStepTheme`	Theme attribute for the overall theme used in a GuidedStepFragment.

Inherited XML attributes

From class android.app.Fragment

Constants
`String`	`EXTRA_UI_STYLE` 用户界面样式的片段参数名称。
`int`	`UI_STYLE_ACTIVITY_ROOT` 参数 `EXTRA_UI_STYLE`一个可能值。
`int`	`UI_STYLE_DEFAULT` 这个常数已被弃用。与`UI_STYLE_REPLACE`相同的值。
`int`	`UI_STYLE_ENTRANCE` 参数 `EXTRA_UI_STYLE`默认值。
`int`	`UI_STYLE_REPLACE` 这是我们使用GuidedStepFragment替换另一个现有的GuidedStepFragment的情况，当前进到下一步时。

Inherited constants

From interface android.content.ComponentCallbacks2

Public constructors
`GuidedStepFragment()`

Public methods
`static int`	`add(FragmentManager fragmentManager, GuidedStepFragment fragment, int id)` 将指定的GuidedStepFragment添加到片段堆栈，替换堆栈中的所有GuidedStepFragments，并配置片段到片段的自定义转场。
`static int`	`add(FragmentManager fragmentManager, GuidedStepFragment fragment)` 将指定的GuidedStepFragment添加到片段堆栈，替换堆栈中的所有GuidedStepFragments，并配置片段到片段的自定义转场。
`static int`	`addAsRoot(Activity activity, GuidedStepFragment fragment, int id)` 将指定的GuidedStepFragment添加为Activity的内容; 没有添加后台条目，因此当按下BACK键时，活动将被解除。
`void`	`collapseSubActions()` 折叠子动作列表。
`void`	`expandSubActions(GuidedAction action)` 展开给定动作的子动作列表。
`GuidedAction`	`findActionById(long id)` 通过Id查找GuidedAction。
`int`	`findActionPositionById(long id)` 按Id查找GuidedAction位置。
`GuidedAction`	`findButtonActionById(long id)` 按Id查找按钮GuidedAction。
`int`	`findButtonActionPositionById(long id)` 按Id查找按钮中的GuidedAction位置。
`void`	`finishGuidedStepFragments()` 在其他内容之上关闭GuidedStepFragments或完成活动（如果GuidedStepFragments是在单独的活动中启动的）。
`View`	`getActionItemView(int position)` 返回与此片段的动作列表中指定位置处的动作相对应的视图。
`List<GuidedAction>`	`getActions()` 返回用户在此片段中可能采用的GuidedActions的列表。
`View`	`getButtonActionItemView(int position)` 返回与此片段的动作列表中指定位置处的按钮动作对应的视图。
`List<GuidedAction>`	`getButtonActions()` 返回用户在此片段中可能采用的按钮GuidedActions的列表。
`static GuidedStepFragment`	`getCurrentGuidedStepFragment(FragmentManager fm)` 返回片段事务堆栈上的当前GuidedStepFragment。
`GuidanceStylist`	`getGuidanceStylist()` 返回显示用户指导信息的GuidanceStylist。
`GuidedActionsStylist`	`getGuidedActionsStylist()` 返回显示用户可以采取的操作的GuidedActionsStylist。
`GuidedActionsStylist`	`getGuidedButtonActionsStylist()` 返回显示用户可能采取的按钮操作的GuidedActionsStylist。
`int`	`getSelectedActionPosition()` 如果当前选择的GuidedAction返回位置。
`int`	`getSelectedButtonActionPosition()` 如果当前选定的按钮GuidedAction返回位置。
`int`	`getUiStyle()` 从片段参数中读取UI样式。
`boolean`	`isFocusOutEndAllowed()` 如果允许焦点超出GuidedStepFragment的结束边缘，则返回true，否则返回false。
`boolean`	`isFocusOutStartAllowed()` 如果允许焦点超出GuidedStepFragment的起始边缘，则返回true，否则返回false。
`boolean`	`isSubActionsExpanded()`
`void`	`notifyActionChanged(int position)` 通知某个操作已更改并更新其UI。
`void`	`notifyButtonActionChanged(int position)` 通知按钮操作已更改并更新其UI。
`void`	`onCreate(Bundle savedInstanceState)` 被调用来做一个片段的初始创建。
`void`	`onCreateActions(List<GuidedAction> actions, Bundle savedInstanceState)` 填写用户可用的一组操作。
`GuidedActionsStylist`	`onCreateActionsStylist()` 创建用于设置指导操作面板风格的演示者。
`View`	`onCreateBackgroundView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` 由onCreateView调用来膨胀背景视图。
`void`	`onCreateButtonActions(List<GuidedAction> actions, Bundle savedInstanceState)` 填写用户可用的右侧所示的一组操作。
`GuidedActionsStylist`	`onCreateButtonActionsStylist()` 创建用于仅为按钮设置双面动作面板的演示者。
`GuidanceStylist.Guidance`	`onCreateGuidance(Bundle savedInstanceState)` 返回向用户提供指导所需的信息。
`GuidanceStylist`	`onCreateGuidanceStylist()` 创建用于设置指导面板风格的演示者。
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` 调用以使片段实例化其用户界面视图。
`void`	`onDestroyView()` 当以前由 `onCreateView(LayoutInflater, ViewGroup, Bundle)`创建的视图已从片段中分离时调用。
`void`	`onGuidedActionClicked(GuidedAction action)` 用户执行操作时调用的回调函数。
`void`	`onGuidedActionEditCanceled(GuidedAction action)` 当某个操作已被取消编辑时，例如用户通过BACK键关闭IME窗口时调用的回调函数。
`void`	`onGuidedActionEdited(GuidedAction action)` 此方法已弃用。覆盖`onGuidedActionEditedAndProceed(GuidedAction)`和/或`onGuidedActionEditCanceled(GuidedAction)` 。
`long`	`onGuidedActionEditedAndProceed(GuidedAction action)` 在编辑操作时调用回调，例如，当用户在IME窗口中单击确认按钮时。
`void`	`onGuidedActionFocused(GuidedAction action)` 用户重点关注动作（作为当前选择）时调用的回调。
`int`	`onProvideTheme()` 返回用于样式化片段的主题。
`void`	`onResume()` 当片段对用户可见且正在积极运行时调用。
`void`	`onSaveInstanceState(Bundle outState)` 打电话询问片段以保存其当前的动态状态，以便稍后可以在重新启动其进程的新实例时重新构建它。
`boolean`	`onSubGuidedActionClicked(GuidedAction action)` 当用户采取子动作中的动作时调用回调。
`void`	`popBackStackToGuidedStepFragment(Class guidedStepFragmentClass, int flags)` 方便的方法弹出到给定类的片段。
`void`	`setActions(List<GuidedAction> actions)` 设置用户在这个片段中可以采用的GuidedActions的列表。
`void`	`setButtonActions(List<GuidedAction> actions)` 设置用户可以在此片段中采用的按钮GuidedActions的列表。
`void`	`setSelectedActionPosition(int position)` 将动作列表滚动到所指示的位置，选择该动作的视图。
`void`	`setSelectedButtonActionPosition(int position)` 将动作列表滚动到指定位置，选择该按钮动作的视图。
`void`	`setUiStyle(int style)` 将UI样式设置为片段参数。

Protected methods
`void`	`onAddSharedElementTransition(FragmentTransaction ft, GuidedStepFragment disappearing)` 当这个片段被添加到FragmentTransaction中时 `UI_STYLE_REPLACE` （也就是当GuidedStepFragment替换现有的GuidedStepFragment时）。
`void`	`onProvideFragmentTransitions()` 由构造函数调用以提供片段转换。

Inherited methods

From class android.app.Fragment

From class java.lang.Object

From interface android.content.ComponentCallbacks2

From interface android.view.View.OnCreateContextMenuListener

From interface android.content.ComponentCallbacks