GuidedStepSupportFragment

Kotlin |Java

open class GuidedStepSupportFragment : Fragment, FocusListener

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.leanback.app.GuidedStepSupportFragment

A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions. It is composed of a guidance view on the left and a view on the right containing a list of possible actions.

Basic Usage

Clients of GuidedStepSupportFragment must create a custom subclass to attach to their Activities. This custom subclass provides the information necessary to construct the user interface and respond to user actions. At a minimum, subclasses should override:

onCreateGuidance, to provide instructions to the user
onCreateActions, to provide a set of GuidedActions the user can take
onGuidedActionClicked, to respond to those actions

Clients use following helper functions to add GuidedStepSupportFragment to Activity or FragmentManager:

addAsRoot(FragmentActivity, GuidedStepSupportFragment, int), to be called during Activity onCreate, adds GuidedStepSupportFragment as the first Fragment in activity.
add(FragmentManager, GuidedStepSupportFragment) or add(FragmentManager, * GuidedStepSupportFragment, int), to add GuidedStepSupportFragment on top of existing Fragments or replacing existing GuidedStepSupportFragment when moving forward to next step.
finishGuidedStepSupportFragments() can either finish the activity or pop all GuidedStepSupportFragment 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

GuidedStepSupportFragment delegates its visual styling to classes called stylists. The is responsible for the left guidance view, while the is responsible for the right actions view. The stylists use theme attributes to derive values associated with the presentation, such as colors, animations, etc. Most simple visual aspects of GuidanceStylist and GuidedActionsStylist can be customized via theming; see their documentation for more information.

GuidedStepSupportFragments must have access to an appropriate theme in order for the stylists to function properly. Specifically, the fragment must receive , or a theme whose parent is 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 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 . If present, this theme will be used by GuidedStepSupportFragment as an overlay to the Activity's theme.
Finally, custom subclasses of GuidedStepSupportFragment may provide a theme through the 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 guided step theme do not need to set the guidedStepTheme attribute; if set, it will be ignored.)

If themes do not provide enough customizability, the stylists themselves may be subclassed and provided to the GuidedStepSupportFragment through the onCreateGuidanceStylist and methods. The stylists have simple hooks so that subclasses may override layout files; subclasses may also have more complex logic to determine styling.

Guided sequences

GuidedStepSupportFragments can be grouped together to provide a guided sequence. GuidedStepSupportFragments grouped as a sequence use custom animations provided by GuidanceStylist and GuidedActionsStylist (or subclasses) during transitions between steps. Clients should use #add to place subsequent GuidedFragments onto the fragment stack so that custom animations are properly configured. (Custom animations are triggered automatically when the fragment stack is subsequently popped by any normal mechanism.)

Note: Currently GuidedStepSupportFragments grouped in this way must all be defined programmatically, rather than in XML. This restriction may be removed in the future. androidx.leanback.R.attr#guidedStepTheme androidx.leanback.R.attr#guidedStepBackground androidx.leanback.R.attr#guidedActionContentWidthWeight androidx.leanback.R.attr#guidedActionContentWidthWeightTwoPanels androidx.leanback.R.attr#guidedActionsBackground androidx.leanback.R.attr#guidedActionsBackgroundDark androidx.leanback.R.attr#guidedActionsElevation

Summary

Constants
static String	`EXTRA_UI_STYLE` Fragment argument name for UI style.
static Int	`UI_STYLE_ACTIVITY_ROOT` One possible value of argument `EXTRA_UI_STYLE`.
static Int	`UI_STYLE_DEFAULT`
static Int	`UI_STYLE_ENTRANCE` Default value for argument `EXTRA_UI_STYLE`.
static Int	`UI_STYLE_REPLACE` This is the case that we use GuidedStepSupportFragment to replace another existing GuidedStepSupportFragment when moving forward to next step.

Public constructors
`<init>()`

Public methods
open static Int	`add(fragmentManager: FragmentManager!, fragment: GuidedStepSupportFragment!)` Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions.
open static Int	`add(fragmentManager: FragmentManager!, fragment: GuidedStepSupportFragment!, id: Int)` Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions.
open static Int	`addAsRoot(activity: FragmentActivity!, fragment: GuidedStepSupportFragment!, id: Int)` Adds the specified GuidedStepSupportFragment as content of Activity; no backstack entry is added so the activity will be dismissed when BACK key is pressed.
open Unit	`collapseAction(withTransition: Boolean)` Collapse action which either has a sub actions list or action with `GuidedAction#hasEditableActivatorView()` is true.
open Unit	`collapseSubActions()` Collapse sub actions list.
open Unit	`expandAction(action: GuidedAction!, withTransition: Boolean)` Expand a given action with sub actions list or `GuidedAction#hasEditableActivatorView()` is true.
open Unit	`expandSubActions(action: GuidedAction!)` Expand a given action's sub actions list.
open GuidedAction!	`findActionById(id: Long)` Find GuidedAction by Id.
open Int	`findActionPositionById(id: Long)` Find GuidedAction position in array by Id.
open GuidedAction!	`findButtonActionById(id: Long)` Find button GuidedAction by Id.
open Int	`findButtonActionPositionById(id: Long)` Find button GuidedAction position in array by Id.
open Unit	`finishGuidedStepSupportFragments()` Convenient method to close GuidedStepSupportFragments on top of other content or finish Activity if GuidedStepSupportFragments were started in a separate activity.
open View!	`getActionItemView(position: Int)` Returns the view corresponding to the action at the indicated position in the list of actions for this fragment.
open MutableList<GuidedAction!>!	`getActions()` Returns the list of GuidedActions that the user may take in this fragment.
open View!	`getButtonActionItemView(position: Int)` Returns the view corresponding to the button action at the indicated position in the list of actions for this fragment.
open MutableList<GuidedAction!>!	`getButtonActions()` Returns the list of button GuidedActions that the user may take in this fragment.
open static GuidedStepSupportFragment!	`getCurrentGuidedStepSupportFragment(fm: FragmentManager!)` Returns the current GuidedStepSupportFragment on the fragment transaction stack.
open GuidanceStylist!	`getGuidanceStylist()` Returns the GuidanceStylist that displays guidance information for the user.
open GuidedActionsStylist!	`getGuidedActionsStylist()` Returns the GuidedActionsStylist that displays the actions the user may take.
open GuidedActionsStylist!	`getGuidedButtonActionsStylist()` Returns the GuidedActionsStylist that displays the button actions the user may take.
open Int	`getSelectedActionPosition()` Returns the position if the currently selected GuidedAction.
open Int	`getSelectedButtonActionPosition()` Returns the position if the currently selected button GuidedAction.
open Int	`getUiStyle()` Read UI style from fragment arguments.
open Boolean	`isExpanded()`
open Boolean	`isFocusOutEndAllowed()` Returns true if allows focus out of end edge of GuidedStepSupportFragment, false otherwise.
open Boolean	`isFocusOutStartAllowed()` Returns true if allows focus out of start edge of GuidedStepSupportFragment, false otherwise.
open Boolean	`isSubActionsExpanded()`
open Unit	`notifyActionChanged(position: Int)` Notify an action has changed and update its UI.
open Unit	`notifyButtonActionChanged(position: Int)` Notify an button action has changed and update its UI.
open Unit	`onCreate(savedInstanceState: Bundle?)` Called to do initial creation of a fragment.
open Unit	`onCreateActions(@NonNull actions: MutableList<GuidedAction!>, savedInstanceState: Bundle!)` Fills out the set of actions available to the user.
open GuidedActionsStylist!	`onCreateActionsStylist()` Creates the presenter used to style the guided actions panel.
open View!	`onCreateBackgroundView(inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle!)` Called by onCreateView to inflate background view.
open Unit	`onCreateButtonActions(@NonNull actions: MutableList<GuidedAction!>, savedInstanceState: Bundle!)` Fills out the set of actions shown at right available to the user.
open GuidedActionsStylist!	`onCreateButtonActionsStylist()` Creates the presenter used to style a sided actions panel for button only.
open GuidanceStylist.Guidance	`onCreateGuidance(savedInstanceState: Bundle!)` Returns the information required to provide guidance to the user.
open GuidanceStylist!	`onCreateGuidanceStylist()` Creates the presenter used to style the guidance panel.
open View?	`onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?)` Called to have the fragment instantiate its user interface view.
open Unit	`onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
open Unit	`onGuidedActionClicked(action: GuidedAction!)` Callback invoked when an action is taken by the user.
open Unit	`onGuidedActionEditCanceled(action: GuidedAction!)` Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key.
open Unit	`onGuidedActionEdited(action: GuidedAction!)` Callback invoked when an action's title or description has been edited, this happens either when user clicks confirm button in IME or user closes IME window by BACK key.
open Long	`onGuidedActionEditedAndProceed(action: GuidedAction!)` Callback invoked when an action has been edited, for example when user clicks confirm button in IME window.
open Unit	`onGuidedActionFocused(action: GuidedAction!)` Callback invoked when an action is focused (made to be the current selection) by the user.
open Int	`onProvideTheme()` Returns the theme used for styling the fragment.
open Unit	`onResume()`
open Unit	`onSaveInstanceState(outState: Bundle)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
open Boolean	`onSubGuidedActionClicked(action: GuidedAction!)` Callback invoked when an action in sub actions is taken by the user.
open Unit	`openInEditMode(action: GuidedAction!)` Opens the provided action in edit mode and raises ime.
open Unit	`popBackStackToGuidedStepSupportFragment(guidedStepFragmentClass: Class<*>!, flags: Int)` Convenient method to pop to fragment with Given class.
open Unit	`setActions(actions: MutableList<GuidedAction!>!)` Sets the list of GuidedActions that the user may take in this fragment.
open Unit	`setActionsDiffCallback(diffCallback: DiffCallback<GuidedAction!>!)` Sets the RecyclerView DiffCallback used when `setActions(List)` is called.
open Unit	`setButtonActions(actions: MutableList<GuidedAction!>!)` Sets the list of button GuidedActions that the user may take in this fragment.
open Unit	`setSelectedActionPosition(position: Int)` Scrolls the action list to the position indicated, selecting that action's view.
open Unit	`setSelectedButtonActionPosition(position: Int)` Scrolls the action list to the position indicated, selecting that button action's view.
open Unit	`setUiStyle(style: Int)` Set UI style to fragment arguments.

Protected methods
open Unit	`onAddSharedElementTransition(ft: FragmentTransaction!, disappearing: GuidedStepSupportFragment!)` Called when this fragment is added to FragmentTransaction with `UI_STYLE_REPLACE` (aka when the GuidedStepSupportFragment replacing an existing GuidedStepSupportFragment).
open Unit	`onProvideFragmentTransitions()` Called by Constructor to provide fragment transitions.

Inherited functions

From class Fragment

`Unit`	`dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?)` Print the Fragments's state into the given stream.
`Boolean`	`equals(@Nullable other: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with. May return `null` if the fragment is associated with a `Context` instead.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.
`Bundle?`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context?`	`getContext()` Return the `Context` this fragment is currently associated with.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors. The `Fragment's arguments` when this is first called will be used as the defaults to any `androidx.lifecycle.SavedStateHandle` passed to a view model created using this factory.
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have