GuidedStepFragment

const val EXTRA_UI_STYLE = "uiStyle": String!

Fragment argument name for UI style. The argument value is persisted in fragment state and used to select fragment transition. The value is initially UI_STYLE_ENTRANCE and might be changed in one of the three helper functions:

• addAsRoot sets to UI_STYLE_ACTIVITY_ROOT
• add or add sets it to UI_STYLE_REPLACE if there is already a GuidedStepFragment on stack.
• finishGuidedStepFragments changes current GuidedStepFragment to UI_STYLE_ENTRANCE for the non activity case. This is a special case that changes the transition settings after fragment has been created, in order to force current GuidedStepFragment run a return transition of UI_STYLE_ENTRANCE

Argument value can be either:

• UI_STYLE_REPLACE
• UI_STYLE_ENTRANCE
• UI_STYLE_ACTIVITY_ROOT

const val UI_STYLE_ACTIVITY_ROOT = 2: Int

One possible value of argument EXTRA_UI_STYLE. This is the case that we show first GuidedStepFragment in a separate activity. The default behavior of this style:

• Enter transition is assigned null (will rely on activity transition), exit transition is same as UI_STYLE_ENTRANCE. Note: Changing exit transition by UI style is not working because fragment transition asks for exit transition before UI style is restored in Fragment.onCreate().

const val UI_STYLE_ENTRANCE = 1: Int

Default value for argument EXTRA_UI_STYLE. The default value is assigned in GuidedStepFragment constructor. This is the case that we show GuidedStepFragment on top of other content. The default behavior of this style:

• Enter transition slides in from two sides, exit transition slide out to START(left). Background will be faded in. Note: Changing exit transition by UI style is not working because fragment transition asks for exit transition before UI style is restored in Fragment .onCreate().

const val UI_STYLE_REPLACE = 0: Int

This is the case that we use GuidedStepFragment to replace another existing GuidedStepFragment when moving forward to next step. Default behavior of this style is:

• Enter transition slides in from END(right), exit transition same as UI_STYLE_ENTRANCE.

java-static fun add(fragmentManager: FragmentManager, fragment: GuidedStepFragment): Int

Adds the specified GuidedStepFragment to the fragment stack, replacing any existing GuidedStepFragments in the stack, and configuring the fragment-to-fragment custom transitions. A backstack entry is added, so the fragment will be dismissed when BACK key is pressed.

• If current fragment on stack is GuidedStepFragment: assign UI_STYLE_REPLACE
• If current fragment on stack is not GuidedStepFragment: assign UI_STYLE_ENTRANCE

Note: currently fragments added using this method must be created programmatically rather than via XML.

java-static fun add(
    fragmentManager: FragmentManager,
    fragment: GuidedStepFragment,
    id: Int
): Int

Adds the specified GuidedStepFragment to the fragment stack, replacing any existing GuidedStepFragments in the stack, and configuring the fragment-to-fragment custom transitions. A backstack entry is added, so the fragment will be dismissed when BACK key is pressed.

• If current fragment on stack is GuidedStepFragment: assign UI_STYLE_REPLACE and onAddSharedElementTransition will be called to perform shared element transition between GuidedStepFragments.
• If current fragment on stack is not GuidedStepFragment: assign UI_STYLE_ENTRANCE

Note: currently fragments added using this method must be created programmatically rather than via XML.

java-static fun addAsRoot(activity: Activity, fragment: GuidedStepFragment, id: Int): Int

Adds the specified GuidedStepFragment as content of Activity; no backstack entry is added so the activity will be dismissed when BACK key is pressed. The method is typically called in Activity.onCreate() when savedInstanceState is null. When savedInstanceState is not null, the Activity is being restored, do not call addAsRoot() to duplicate the Fragment restored by FragmentManager. UI_STYLE_ACTIVITY_ROOT is assigned. Note: currently fragments added using this method must be created programmatically rather than via XML.

fun collapseAction(withTransition: Boolean): Unit

Collapse action which either has a sub actions list or action with hasEditableActivatorView is true.

fun collapseSubActions(): Unit

Collapse sub actions list.

fun expandAction(action: GuidedAction, withTransition: Boolean): Unit

Expand a given action with sub actions list or hasEditableActivatorView is true. The method must be called after onCreateView creates fragment view.

fun expandSubActions(action: GuidedAction): Unit

Expand a given action's sub actions list.

fun findActionById(id: Long): GuidedAction?

Find GuidedAction by Id.

fun findActionPositionById(id: Long): Int

Find GuidedAction position in array by Id.

fun findButtonActionById(id: Long): GuidedAction?

Find button GuidedAction by Id.

fun findButtonActionPositionById(id: Long): Int

Find button GuidedAction position in array by Id.

fun finishGuidedStepFragments(): Unit

Convenient method to close GuidedStepFragments on top of other content or finish Activity if GuidedStepFragments were started in a separate activity. Pops all stack entries including UI_STYLE_ENTRANCE; if UI_STYLE_ENTRANCE is not found, finish the activity. Note that this method must be paired with add which sets up the stack entry name for finding which fragment we need to pop back to.

fun getActionItemView(position: Int): View?

Returns the view corresponding to the action at the indicated position in the list of actions for this fragment.

fun getActions(): (Mutable)List<GuidedAction!>

Returns the list of GuidedActions that the user may take in this fragment.

fun getButtonActionItemView(position: Int): View?

Returns the view corresponding to the button action at the indicated position in the list of actions for this fragment.

fun getButtonActions(): (Mutable)List<GuidedAction!>

Returns the list of button GuidedActions that the user may take in this fragment.

java-static fun getCurrentGuidedStepFragment(fm: FragmentManager): GuidedStepFragment?

Returns the current GuidedStepFragment on the fragment transaction stack.

fun getGuidanceStylist(): GuidanceStylist

Returns the GuidanceStylist that displays guidance information for the user.

fun getGuidedActionsStylist(): GuidedActionsStylist

Returns the GuidedActionsStylist that displays the actions the user may take.

fun getGuidedButtonActionsStylist(): GuidedActionsStylist

Returns the GuidedActionsStylist that displays the button actions the user may take.

fun getSelectedActionPosition(): Int

Returns the position if the currently selected GuidedAction.

fun getSelectedButtonActionPosition(): Int

Returns the position if the currently selected button GuidedAction.

fun getUiStyle(): Int

Read UI style from fragment arguments. Default value is UI_STYLE_ENTRANCE when fragment is first initialized. UI style is used to choose different fragment transition animations and determine if this is the first GuidedStepFragment on backstack.

fun isFocusOutEndAllowed(): Boolean

Returns true if allows focus out of end edge of GuidedStepFragment, false otherwise. Default value is false, the reason is to disable FocusFinder to find focusable views beneath content of GuidedStepFragment. Subclass may override.

fun isFocusOutStartAllowed(): Boolean

Returns true if allows focus out of start edge of GuidedStepFragment, false otherwise. Default value is false, the reason is to disable FocusFinder to find focusable views beneath content of GuidedStepFragment. Subclass may override.

fun notifyActionChanged(position: Int): Unit

Notify an action has changed and update its UI.

fun notifyButtonActionChanged(position: Int): Unit

Notify an button action has changed and update its UI.

fun onCreateActions(
    actions: (Mutable)List<GuidedAction!>,
    savedInstanceState: Bundle?
): Unit

Fills out the set of actions available to the user. This hook is called during onCreate. The default leaves the list of actions empty; subclasses should override.

fun onCreateActionsStylist(): GuidedActionsStylist

Creates the presenter used to style the guided actions panel. The default implementation returns a basic GuidedActionsStylist.

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

Called by onCreateView to inflate background view. Default implementation loads view from lb_guidedstep_background which holds a reference to guidedStepBackground.

fun onCreateButtonActions(
    actions: (Mutable)List<GuidedAction!>,
    savedInstanceState: Bundle?
): Unit

Fills out the set of actions shown at right available to the user. This hook is called during onCreate. The default leaves the list of actions empty; subclasses may override.

fun onCreateButtonActionsStylist(): GuidedActionsStylist

Creates the presenter used to style a sided actions panel for button only. The default implementation returns a basic GuidedActionsStylist.

fun onCreateGuidance(savedInstanceState: Bundle?): GuidanceStylist.Guidance

Returns the information required to provide guidance to the user. This hook is called during onCreateView. May be overridden to return a custom subclass of GuidanceStylist.Guidance for use in a subclass of GuidanceStylist. The default returns a Guidance object with empty fields; subclasses should override.

fun onCreateGuidanceStylist(): GuidanceStylist

Creates the presenter used to style the guidance panel. The default implementation returns a basic GuidanceStylist.

fun onGuidedActionClicked(action: GuidedAction): Unit

Callback invoked when an action is taken by the user. Subclasses should override in order to act on the user's decisions.

fun onGuidedActionEditCanceled(action: GuidedAction): Unit

Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key. Default implementation calls deprecated method onGuidedActionEdited.

fun onGuidedActionEdited(action: GuidedAction!): Unit

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.

fun onGuidedActionEditedAndProceed(action: GuidedAction): Long

Callback invoked when an action has been edited, for example when user clicks confirm button in IME window. Default implementation calls deprecated method onGuidedActionEdited and returns ACTION_ID_NEXT.

fun onGuidedActionFocused(action: GuidedAction): Unit

Callback invoked when an action is focused (made to be the current selection) by the user.

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.

fun onSubGuidedActionClicked(action: GuidedAction): Boolean

Callback invoked when an action in sub actions is taken by the user. Subclasses should override in order to act on the user's decisions. Default return value is true to close the sub actions list.

fun openInEditMode(action: GuidedAction?): Unit

Opens the provided action in edit mode and raises ime. This can be used to programmatically skip the extra click required to go into edit mode. This method can be invoked in onCreateView.

fun popBackStackToGuidedStepFragment(
    guidedStepFragmentClass: Class<Any!>,
    flags: Int
): Unit

Convenient method to pop to fragment with Given class.

fun setActions(actions: (Mutable)List<GuidedAction!>): Unit

Sets the list of GuidedActions that the user may take in this fragment. Uses DiffCallback set by setActionsDiffCallback.

fun setActionsDiffCallback(diffCallback: DiffCallback<GuidedAction!>?): Unit

Sets the RecyclerView DiffCallback used when setActions is called. By default GuidedStepFragment uses androidx.leanback.widget.GuidedActionDiffCallback. Sets it to null if app wants to refresh the whole list.

fun setButtonActions(actions: (Mutable)List<GuidedAction!>): Unit

Sets the list of button GuidedActions that the user may take in this fragment.

fun setSelectedActionPosition(position: Int): Unit

Scrolls the action list to the position indicated, selecting that action's view.

fun setSelectedButtonActionPosition(position: Int): Unit

Scrolls the action list to the position indicated, selecting that button action's view.

fun setUiStyle(style: Int): Unit

Set UI style to fragment arguments. Default value is UI_STYLE_ENTRANCE when fragment is first initialized. UI style is used to choose different fragment transition animations and determine if this is the first GuidedStepFragment on backstack. In most cases app does not directly call this method, app calls helper function add. However if the app creates Fragment transaction and controls backstack by itself, it would need call setUiStyle() to select the fragment transition to use.

protected fun onAddSharedElementTransition(
    ft: FragmentTransaction,
    disappearing: GuidedStepFragment
): Unit

Called when this fragment is added to FragmentTransaction with UI_STYLE_REPLACE (aka when the GuidedStepFragment replacing an existing GuidedStepFragment). Default implementation establishes connections between action background views to morph action background bounds change from disappearing GuidedStepFragment into this GuidedStepFragment. The default implementation heavily relies on GuidedActionsStylist's layout, app may override this method when modifying the default layout of GuidedActionsStylist.

protected fun onProvideFragmentTransitions(): Unit

Called by Constructor to provide fragment transitions. The default implementation assigns transitions based on getUiStyle:

• UI_STYLE_REPLACE Slide from/to end(right) for enter transition, slide from/to start(left) for exit transition, shared element enter transition is set to ChangeBounds.
• UI_STYLE_ENTRANCE Enter transition is set to slide from both sides, exit transition is same as UI_STYLE_REPLACE, no shared element enter transition.
• UI_STYLE_ACTIVITY_ROOT Enter transition is set to null and app should rely on activity transition, exit transition is same as UI_STYLE_REPLACE, no shared element enter transition.

The default implementation heavily relies on GuidedActionsStylist and GuidanceStylist layout, app may override this method when modifying the default layout of GuidedActionsStylist or GuidanceStylist.

TIP: because the fragment view is removed during fragment transition, in general app cannot use two Visibility transition together. Workaround is to create your own Visibility transition that controls multiple animators (e.g. slide and fade animation in one Transition class).