GuidedStepSupportFragment

Added in 1.1.0

Kotlin |Java

class GuidedStepSupportFragment : Fragment

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, to be called during Activity onCreate, adds GuidedStepSupportFragment as the first Fragment in activity.
add or add, 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 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 Theme_Leanback_GuidedStep, 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 LeanbackGuidedStepTheme_guidedStepTheme. 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 onProvideTheme 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 onCreateActionsStylist 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.guidedStepThemeguidedStepBackgroundguidedActionContentWidthWeightguidedActionContentWidthWeightTwoPanelsguidedActionsBackgroundguidedActionsBackgroundDarkguidedActionsElevation

See also
`GuidanceStylist`
`GuidanceStylist.Guidance`
`GuidedAction`
`GuidedActionsStylist`

Summary

Constants
`const String!`	`EXTRA_UI_STYLE = "uiStyle"` Fragment argument name for UI style.
`const Int`	`UI_STYLE_ACTIVITY_ROOT = 2` One possible value of argument `EXTRA_UI_STYLE`.
`const Int`	`UI_STYLE_DEFAULT = 0` This property is deprecated. Same value as `UI_STYLE_REPLACE`.
`const Int`	`UI_STYLE_ENTRANCE = 1` Default value for argument `EXTRA_UI_STYLE`.
`const Int`	`UI_STYLE_REPLACE = 0` This is the case that we use GuidedStepSupportFragment to replace another existing GuidedStepSupportFragment when moving forward to next step.

Public constructors
`GuidedStepSupportFragment()`

Public functions
`java-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.
`java-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.
`java-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.
`Unit`	`collapseAction(withTransition: Boolean)` Collapse action which either has a sub actions list or action with `hasEditableActivatorView` is true.
`Unit`	`collapseSubActions()` Collapse sub actions list.
`Unit`	`expandAction(action: GuidedAction, withTransition: Boolean)` Expand a given action with sub actions list or `hasEditableActivatorView` is true.
`Unit`	`expandSubActions(action: GuidedAction)` Expand a given action's sub actions list.
`GuidedAction?`	`findActionById(id: Long)` Find GuidedAction by Id.
`Int`	`findActionPositionById(id: Long)` Find GuidedAction position in array by Id.
`GuidedAction?`	`findButtonActionById(id: Long)` Find button GuidedAction by Id.
`Int`	`findButtonActionPositionById(id: Long)` Find button GuidedAction position in array by Id.
`Unit`	`finishGuidedStepSupportFragments()` Convenient method to close GuidedStepSupportFragments on top of other content or finish Activity if GuidedStepSupportFragments were started in a separate activity.
`View?`	`getActionItemView(position: Int)` Returns the view corresponding to the action at the indicated position in the list of actions for this fragment.
`(Mutable)List<GuidedAction!>`	`getActions()` Returns the list of GuidedActions that the user may take in this fragment.
`View?`	`getButtonActionItemView(position: Int)` Returns the view corresponding to the button action at the indicated position in the list of actions for this fragment.
`(Mutable)List<GuidedAction!>`	`getButtonActions()` Returns the list of button GuidedActions that the user may take in this fragment.
`java-static GuidedStepSupportFragment?`	`getCurrentGuidedStepSupportFragment(fm: FragmentManager)` Returns the current GuidedStepSupportFragment on the fragment transaction stack.
`GuidanceStylist`	`getGuidanceStylist()` Returns the GuidanceStylist that displays guidance information for the user.
`GuidedActionsStylist`	`getGuidedActionsStylist()` Returns the GuidedActionsStylist that displays the actions the user may take.
`GuidedActionsStylist`	`getGuidedButtonActionsStylist()` Returns the GuidedActionsStylist that displays the button actions the user may take.
`Int`	`getSelectedActionPosition()` Returns the position if the currently selected GuidedAction.
`Int`	`getSelectedButtonActionPosition()` Returns the position if the currently selected button GuidedAction.
`Int`	`getUiStyle()` Read UI style from fragment arguments.
`Boolean`	`isExpanded()`
`Boolean`	`isFocusOutEndAllowed()` Returns true if allows focus out of end edge of GuidedStepSupportFragment, false otherwise.
`Boolean`	`isFocusOutStartAllowed()` Returns true if allows focus out of start edge of GuidedStepSupportFragment, false otherwise.
`Boolean`	`isSubActionsExpanded()`
`Unit`	`notifyActionChanged(position: Int)` Notify an action has changed and update its UI.
`Unit`	`notifyButtonActionChanged(position: Int)` Notify an button action has changed and update its UI.
`Unit`	`onCreate(savedInstanceState: Bundle?)` Called to do initial creation of a fragment.
`Unit`	`onCreateActions( actions: (Mutable)List<GuidedAction!>, savedInstanceState: Bundle? )` Fills out the set of actions available to the user.
`GuidedActionsStylist`	`onCreateActionsStylist()` Creates the presenter used to style the guided actions panel.
`View?`	`onCreateBackgroundView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` Called by onCreateView to inflate background view.
`Unit`	`onCreateButtonActions( actions: (Mutable)List<GuidedAction!>, savedInstanceState: Bundle? )` Fills out the set of actions shown at right available to the user.
`GuidedActionsStylist`	`onCreateButtonActionsStylist()` Creates the presenter used to style a sided actions panel for button only.
`GuidanceStylist.Guidance`	`onCreateGuidance(savedInstanceState: Bundle?)` Returns the information required to provide guidance to the user.
`GuidanceStylist`	`onCreateGuidanceStylist()` Creates the presenter used to style the guidance panel.
`View?`	`onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` Called to have the fragment instantiate its user interface view.
`Unit`	`onDestroyView()` Called when the view previously created by #onCreateView has been detached from the fragment.
`Unit`	`onGuidedActionClicked(action: GuidedAction)` Callback invoked when an action is taken by the user.
`Unit`	`onGuidedActionEditCanceled(action: GuidedAction)` Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key.
`Unit`	`onGuidedActionEdited(action: GuidedAction!)` This function is deprecated. Override `onGuidedActionEditedAndProceed` and/or `onGuidedActionEditCanceled`.
`Long`	`onGuidedActionEditedAndProceed(action: GuidedAction)` Callback invoked when an action has been edited, for example when user clicks confirm button in IME window.
`Unit`	`onGuidedActionFocused(action: GuidedAction)` Callback invoked when an action is focused (made to be the current selection) by the user.
`Int`	`onProvideTheme()` Returns the theme used for styling the fragment.
`Unit`	`onResume()` Called when the fragment is visible to the user and actively running.
`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.
`Boolean`	`onSubGuidedActionClicked(action: GuidedAction)` Callback invoked when an action in sub actions is taken by the user.
`Unit`	`openInEditMode(action: GuidedAction?)` Opens the provided action in edit mode and raises ime.
`Unit`	`popBackStackToGuidedStepSupportFragment( guidedStepFragmentClass: Class<Any!>, flags: Int )` Convenient method to pop to fragment with Given class.
`Unit`	`setActions(actions: (Mutable)List<GuidedAction!>)` Sets the list of GuidedActions that the user may take in this fragment.
`Unit`	`setActionsDiffCallback(diffCallback: DiffCallback<GuidedAction!>?)` Sets the RecyclerView DiffCallback used when `setActions` is called.
`Unit`	`setButtonActions(actions: (Mutable)List<GuidedAction!>)` Sets the list of button GuidedActions that the user may take in this fragment.
`Unit`	`setSelectedActionPosition(position: Int)` Scrolls the action list to the position indicated, selecting that action's view.
`Unit`	`setSelectedButtonActionPosition(position: Int)` Scrolls the action list to the position indicated, selecting that button action's view.
`Unit`	`setUiStyle(style: Int)` Set UI style to fragment arguments.

Protected functions
`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).
`Unit`	`onProvideFragmentTransitions()` Called by Constructor to provide fragment transitions.

Inherited functions

From androidx.activity.result.ActivityResultCaller

abstract ActivityResultLauncher<I!>!

<I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>!,
    callback: ActivityResultCallback<O!>!
)

From android.content.ComponentCallbacks

`abstract Unit`	`onConfigurationChanged(p: Configuration!)`
`abstract Unit`	`onLowMemory()`

From androidx.fragment.app.Fragment

`Unit`	`dump( prefix: String, fd: FileDescriptor?, writer: PrintWriter, args: Array<String!>? )` Print the Fragments's state into the given stream.
`Boolean`	`equals(o: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`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.
`CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()` 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 extra.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Any?`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`FragmentManager?`	`getFragmentManager()` This function is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`Any?`	`getHost()` Return the host object of this fragment.
`Int`	`getId()` Return the identifier this fragment is known by.
`LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()` Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`LoaderManager`	`getLoaderManager()` This function is deprecated. Use `LoaderManager.getInstance(this)`.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`Any?`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Resources`	`getResources()` Return `requireActivity().getResources()`.
`Boolean`	`getRetainInstance()` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`Any?`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`SavedStateRegistry`	`getSavedStateRegistry()`
`Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`String`	`getString(resId: @StringRes Int)` Return a localized string from the application's package's default string table.
`String`	`getString(resId: @StringRes Int, formatArgs: Array<Any!>?)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and format.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` This function is deprecated. Instead of using a target fragment to pass results, use `setFragmentResult` to deliver results to `FragmentResultListener` instances registered by other fragments via `setFragmentResultListener`.
`Int`	`getTargetRequestCode()` This function is deprecated. When using the target fragment replacement of `setFragmentResultListener` and `setFragmentResult`, consider using `setArguments` to pass a `requestKey` if you need to support dynamic request keys.
`CharSequence`	`getText(resId: @StringRes Int)` Return a localized, styled CharSequence from the application's package's default string table.
`Boolean`	`getUserVisibleHint()` This function is deprecated. Use `setMaxLifecycle` instead.
`View?`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`LifecycleOwner`	`@MainThread getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`LiveData<LifecycleOwner!>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment
`Int`	`hashCode()` Subclasses can not override hashCode().
`java-static Fragment`	`instantiate(context: Context, fname: String)` This function is deprecated. Use `getFragmentFactory` and `instantiate`
`java-static Fragment`	`instantiate(context: Context, fname: String, args: Bundle?)` This function is deprecated. Use `getFragmentFactory` and `instantiate`, manually calling `setArguments` on the returned Fragment.
`Boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`Boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`Boolean`	`isHidden()` Return true if the fragment has been hidden.
`Boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the tag.
`Boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`Boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`Boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`Boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`Unit`	`@MainThread @CallSuper onActivityCreated(savedInstanceState: Bundle?)` This function is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`@MainThread @CallSuper onAttach(activity: Activity)` This function is deprecated. See `onAttach`.
`Unit`	`@MainThread @CallSuper onAttach(context: Context)` Called when a fragment is first attached to its context.
`Unit`	`@MainThread onAttachFragment(childFragment: Fragment)` This function is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`Unit`	`@CallSuper onConfigurationChanged(newConfig: Configuration)`
`Boolean`	`@MainThread onContextItemSelected(item: MenuItem)` This hook is called whenever an item in a context menu is selected.
`Animation?`	`@MainThread onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
`Animator?`	`@MainThread onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator.
`Unit`	`@MainThread onCreateContextMenu( menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo? )` Called when a context menu for the `view` is about to be shown.
`Unit`	`@MainThread onCreateOptionsMenu(menu: Menu, inflater: MenuInflater)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`Unit`	`@MainThread @CallSuper onDestroy()` Called when the fragment is no longer in use.
`Unit`	`@MainThread onDestroyOptionsMenu()` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`Unit`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment.
`Unit`	`@MainThread onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`Unit`	`@UiThread @CallSuper onInflate( activity: Activity, attrs: AttributeSet, savedInstanceState: Bundle? )` This function is deprecated. See `onInflate`.
`Unit`	`@UiThread @CallSuper onInflate( context: Context, attrs: AttributeSet, savedInstanceState: Bundle? )` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`Unit`	`@MainThread @CallSuper onLowMemory()`
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`Boolean`	`@MainThread onOptionsItemSelected(item: MenuItem)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`Unit`	`@MainThread onOptionsMenuClosed(menu: Menu)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`Unit`	`@MainThread @CallSuper onPause()` Called when the Fragment is no longer resumed.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode.
`Unit`	`@MainThread onPrepareOptionsMenu(menu: Menu)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`Unit`	`@MainThread onPrimaryNavigationFragmentChanged( isPrimaryNavigationFragment: Boolean )` Callback for when the primary navigation state of this Fragment has changed.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>, grantResults: IntArray )` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`@MainThread @CallSuper onStart()` Called when the Fragment is visible to the user.
`Unit`	`@MainThread @CallSuper onStop()` Called when the Fragment is no longer started.
`Unit`	`@MainThread onViewCreated(view: View, savedInstanceState: Bundle?)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`Unit`	`@MainThread @CallSuper onViewStateRestored(savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment.
`Unit`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`Unit`	`postponeEnterTransition(duration: Long, timeUnit: TimeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, registry: ActivityResultRegistry, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`Unit`	`registerForContextMenu(view: View)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`Unit`	`requestPermissions(permissions: Array<String!>, requestCode: Int)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`FragmentManager`	`requireFragmentManager()` This function is deprecated. This has been renamed to `getParentFragmentManager()` to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.
`Any`	`requireHost()` Return the host object of this fragment.
`Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the the exit transition and enter transition overlap or not.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the the return transition and reenter transition overlap or not.
`Unit`	`setArguments(args: Bundle?)` Supply the construction arguments for this fragment.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback?)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`Unit`	`setEnterTransition(transition: Any?)` Sets the Transition that will be used to move Views into the initial scene.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback?)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`Unit`	`setExitTransition(transition: Any?)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated. This method is no longer needed when using a `MenuProvider` to provide a `Menu` to your activity, which replaces `onCreateOptionsMenu` as the recommended way to provide a consistent, optionally `Lifecycle`-aware, and modular way to handle menu creation and item selection.
`Unit`	`setInitialSavedState(state: Fragment.SavedState?)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible.
`Unit`	`setReenterTransition(transition: Any?)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`Unit`	`setReturnTransition(transition: Any?)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`Unit`	`setSharedElementEnterTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`Unit`	`setSharedElementReturnTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`Unit`	`setTargetFragment(fragment: Fragment?, requestCode: Int)` This function is deprecated. Instead of using a target fragment to pass results, the fragment requesting a result should use `setFragmentResultListener` to register a `FragmentResultListener` with a `requestKey` using its `parent fragment manager`.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`Unit`	`startActivity(intent: Intent)` Call startActivity from the fragment's containing Activity.
`Unit`	`startActivity(intent: Intent, options: Bundle?)` Call startActivity from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startIntentSenderForResult( intent: IntentSender, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle? )` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`String`	`toString()`
`Unit`	`unregisterForContextMenu(view: View)` Prevents a context menu to be shown for the given view.

From androidx.lifecycle.HasDefaultViewModelProviderFactory

`CreationExtras!`	`getDefaultViewModelCreationExtras()`
`abstract ViewModelProvider.Factory!`	`getDefaultViewModelProviderFactory()`

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle!

getLifecycle()

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry!

getSavedStateRegistry()

From android.view.View.OnCreateContextMenuListener

abstract Unit

onCreateContextMenu(
    p: ContextMenu!,
    p1: View!,
    p2: ContextMenu.ContextMenuInfo!
)

From androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore!

getViewModelStore()

Constants

EXTRA_UI_STYLE

Added in 1.1.0

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 GuidedStepSupportFragment on stack.
finishGuidedStepSupportFragments changes current GuidedStepSupportFragment 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 GuidedStepSupportFragment run a return transition of UI_STYLE_ENTRANCE

Argument value can be either:

UI_STYLE_ACTIVITY_ROOT

Added in 1.1.0

const val UI_STYLE_ACTIVITY_ROOT = 2: Int

One possible value of argument EXTRA_UI_STYLE. This is the case that we show first GuidedStepSupportFragment 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().

UI_STYLE_DEFAULT

Added in 1.1.0

Deprecated in 1.1.0

const val UI_STYLE_DEFAULT = 0: Int

UI_STYLE_ENTRANCE

Added in 1.1.0

const val UI_STYLE_ENTRANCE = 1: Int

Default value for argument EXTRA_UI_STYLE. The default value is assigned in GuidedStepSupportFragment constructor. This is the case that we show GuidedStepSupportFragment 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().

When popping multiple GuidedStepSupportFragment, finishGuidedStepSupportFragments also changes the top GuidedStepSupportFragment to UI_STYLE_ENTRANCE in order to run the return transition (reverse of enter transition) of UI_STYLE_ENTRANCE.

UI_STYLE_REPLACE

Added in 1.1.0

const val UI_STYLE_REPLACE = 0: Int

This is the case that we use GuidedStepSupportFragment to replace another existing GuidedStepSupportFragment 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.

Public constructors

GuidedStepSupportFragment

Added in 1.1.0

GuidedStepSupportFragment()

Public functions

add

Added in 1.1.0

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

Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments 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 GuidedStepSupportFragment: assign UI_STYLE_REPLACE
If current fragment on stack is not GuidedStepSupportFragment: assign UI_STYLE_ENTRANCE

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

Parameters
`fragmentManager: FragmentManager`	The FragmentManager to be used in the transaction.
`fragment: GuidedStepSupportFragment`	The GuidedStepSupportFragment to be inserted into the fragment stack.

Returns
`Int`	The ID returned by the call FragmentTransaction.commit.

add

Added in 1.1.0

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

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

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

Parameters
`fragmentManager: FragmentManager`	The FragmentManager to be used in the transaction.
`fragment: GuidedStepSupportFragment`	The GuidedStepSupportFragment to be inserted into the fragment stack.
`id: Int`	The id of container to add GuidedStepSupportFragment, can be android.R.id.content.

Returns
`Int`	The ID returned by the call FragmentTransaction.commit.

addAsRoot

Added in 1.1.0

java-static fun addAsRoot(
    activity: FragmentActivity,
    fragment: GuidedStepSupportFragment,
    id: Int
): 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. 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.

Parameters
`activity: FragmentActivity`	The Activity to be used to insert GuidedstepFragment.
`fragment: GuidedStepSupportFragment`	The GuidedStepSupportFragment to be inserted into the fragment stack.
`id: Int`	The id of container to add GuidedStepSupportFragment, can be android.R.id.content.

Returns
`Int`	The ID returned by the call FragmentTransaction.commit, or -1 there is already GuidedStepSupportFragment.

collapseAction

Added in 1.1.0

fun collapseAction(withTransition: Boolean): Unit

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

Parameters
`withTransition: Boolean`	True to run transition animation, false otherwise.

collapseSubActions

Added in 1.1.0

fun collapseSubActions(): Unit

Collapse sub actions list.

See also
`getSubActions`

Added in 1.1.0

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.

Parameters
`action: GuidedAction`	GuidedAction to expand.
`withTransition: Boolean`	True to run transition animation, false otherwise.

Added in 1.1.0

fun expandSubActions(action: GuidedAction): Unit

Expand a given action's sub actions list.

Parameters
`action: GuidedAction`	GuidedAction to expand.

See also
`expandAction`

findActionById

Added in 1.1.0

fun findActionById(id: Long): GuidedAction?

Find GuidedAction by Id.

Parameters
`id: Long`	Id of the action to search.

Returns
`GuidedAction?`	GuidedAction object or null if not found.

findActionPositionById

Added in 1.1.0

fun findActionPositionById(id: Long): Int

Find GuidedAction position in array by Id.

Parameters
`id: Long`	Id of the action to search.

Returns
`Int`	position of GuidedAction object in array or -1 if not found.

findButtonActionById

Added in 1.1.0

fun findButtonActionById(id: Long): GuidedAction?

Find button GuidedAction by Id.

Parameters
`id: Long`	Id of the button action to search.

Returns
`GuidedAction?`	GuidedAction object or null if not found.

findButtonActionPositionById

Added in 1.1.0

fun findButtonActionPositionById(id: Long): Int

Find button GuidedAction position in array by Id.

Parameters
`id: Long`	Id of the button action to search.

Returns
`Int`	position of GuidedAction object in array or -1 if not found.

finishGuidedStepSupportFragments

Added in 1.1.0

fun finishGuidedStepSupportFragments(): Unit

Convenient method to close GuidedStepSupportFragments on top of other content or finish Activity if GuidedStepSupportFragments 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.

getActionItemView

Added in 1.1.0

fun getActionItemView(position: Int): View?

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

Parameters
`position: Int`	The integer position of the action of interest.

Returns
`View?`	The View corresponding to the action at the indicated position, or null if that action is not currently onscreen.

getActions

Added in 1.1.0

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

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

Returns
`(Mutable)List<GuidedAction!>`	The list of GuidedActions for this fragment.

getButtonActionItemView

Added in 1.1.0

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.

Parameters
`position: Int`	The integer position of the button action of interest.

Returns
`View?`	The View corresponding to the button action at the indicated position, or null if that action is not currently onscreen.

getButtonActions

Added in 1.1.0

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

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

Returns
`(Mutable)List<GuidedAction!>`	The list of button GuidedActions for this fragment.

getCurrentGuidedStepSupportFragment

Added in 1.1.0

java-static fun getCurrentGuidedStepSupportFragment(fm: FragmentManager): GuidedStepSupportFragment?

Returns the current GuidedStepSupportFragment on the fragment transaction stack.

Returns
`GuidedStepSupportFragment?`	The current GuidedStepSupportFragment, if any, on the fragment transaction stack.

getGuidanceStylist

Added in 1.1.0

fun getGuidanceStylist(): GuidanceStylist

Returns the GuidanceStylist that displays guidance information for the user.

Returns
`GuidanceStylist`	The GuidanceStylist for this fragment.

getGuidedActionsStylist

Added in 1.1.0

fun getGuidedActionsStylist(): GuidedActionsStylist

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

Returns
`GuidedActionsStylist`	The GuidedActionsStylist for this fragment.

getGuidedButtonActionsStylist

Added in 1.1.0

fun getGuidedButtonActionsStylist(): GuidedActionsStylist

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

Returns
`GuidedActionsStylist`	The GuidedActionsStylist for this fragment.

getSelectedActionPosition

Added in 1.1.0

fun getSelectedActionPosition(): Int

Returns the position if the currently selected GuidedAction.

Returns
`Int`	position The integer position of the currently selected action.

getSelectedButtonActionPosition

Added in 1.1.0

fun getSelectedButtonActionPosition(): Int

Returns the position if the currently selected button GuidedAction.

Returns
`Int`	position The integer position of the currently selected button action.

getUiStyle

Added in 1.1.0

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 GuidedStepSupportFragment on backstack.

Returns
`Int`	`UI_STYLE_ACTIVITY_ROOTUI_STYLE_REPLACE` or `UI_STYLE_ENTRANCE`.

See also
`onProvideFragmentTransitions`

isExpanded

Added in 1.1.0

fun isExpanded(): Boolean

Returns
`Boolean`	True if is current expanded including subactions list or action with `hasEditableActivatorView` is true.

isFocusOutEndAllowed

Added in 1.1.0

fun isFocusOutEndAllowed(): Boolean

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

Returns
`Boolean`	True if allows focus out of end edge of GuidedStepSupportFragment.

isFocusOutStartAllowed

Added in 1.1.0

fun isFocusOutStartAllowed(): Boolean

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

Returns
`Boolean`	True if allows focus out of start edge of GuidedStepSupportFragment.

isSubActionsExpanded

Added in 1.1.0

fun isSubActionsExpanded(): Boolean

Returns
`Boolean`	True if the sub actions list is expanded, false otherwise.

notifyActionChanged

Added in 1.1.0

fun notifyActionChanged(position: Int): Unit

Notify an action has changed and update its UI.

Parameters
`position: Int`	Position of the GuidedAction in array.

notifyButtonActionChanged

Added in 1.1.0

fun notifyButtonActionChanged(position: Int): Unit

Notify an button action has changed and update its UI.

Parameters
`position: Int`	Position of the button GuidedAction in array.

onCreate

fun onCreate(savedInstanceState: Bundle?): Unit

Called to do initial creation of a fragment. This is called after #onAttach(Activity) and before #onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a on the activity's Lifecycle, removing it when it receives the Lifecycle.State#CREATED callback.

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Added in 1.1.0

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.

Parameters
`actions: (Mutable)List<GuidedAction!>`	A non-null, empty list ready to be populated.
`savedInstanceState: Bundle?`	The saved instance state from onCreate.

onCreateActionsStylist

Added in 1.1.0

fun onCreateActionsStylist(): GuidedActionsStylist

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

Returns
`GuidedActionsStylist`	The GuidedActionsStylist used in this fragment.

onCreateBackgroundView

Added in 1.1.0

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.

Parameters
`inflater: LayoutInflater`	LayoutInflater to load background view.
`container: ViewGroup?`	Parent view of background view.
`savedInstanceState: Bundle?`

Returns
`View?`	Created background view or null if no background.

Added in 1.1.0

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.

Parameters
`actions: (Mutable)List<GuidedAction!>`	A non-null, empty list ready to be populated.
`savedInstanceState: Bundle?`	The saved instance state from onCreate.

onCreateButtonActionsStylist

Added in 1.1.0

fun onCreateButtonActionsStylist(): GuidedActionsStylist

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

Returns
`GuidedActionsStylist`	The GuidedActionsStylist used in this fragment.

onCreateGuidance

Added in 1.1.0

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 for use in a subclass of GuidanceStylist. The default returns a Guidance object with empty fields; subclasses should override.

Parameters
`savedInstanceState: Bundle?`	The saved instance state from onCreateView.

Returns
`GuidanceStylist.Guidance`	The Guidance object representing the information used to guide the user.

onCreateGuidanceStylist

Added in 1.1.0

fun onCreateGuidanceStylist(): GuidanceStylist

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

Returns
`GuidanceStylist`	The GuidanceStylist used in this fragment.

onCreateView

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

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between #onCreate(Bundle) and #onViewCreated(View, Bundle).

A default View can be returned by calling #Fragment(int) in your constructor. Otherwise, this method returns null.

It is recommended to only inflate the layout in this method and move logic that operates on the returned View to #onViewCreated(View, Bundle).

If you return a View from here, you will later be called in #onDestroyView when the view is being released.

onDestroyView

fun onDestroyView(): Unit

Called when the view previously created by #onCreateView has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after #onStop() and before #onDestroy(). It is called regardless of whether #onCreateView returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

Added in 1.1.0

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.

Parameters
`action: GuidedAction`	The chosen action.

Added in 1.1.0

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.

Parameters
`action: GuidedAction`	The action which has been canceled editing.

Added in 1.1.0

Deprecated in 1.1.0

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.

Added in 1.1.0

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.

Parameters
`action: GuidedAction`	The action that has been edited.

Returns
`Long`	ID of the action will be focused or `ACTION_ID_NEXT`, `ACTION_ID_CURRENT`.

Added in 1.1.0

fun onGuidedActionFocused(action: GuidedAction): Unit

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

onProvideTheme

Added in 1.1.0

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.

Returns
`Int`	The theme resource ID of the theme to use in this fragment, or -1 to use the host Activity's theme.

onResume

fun onResume(): Unit

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

onSaveInstanceState

fun onSaveInstanceState(outState: Bundle): Unit

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. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to #onCreate(Bundle), #onCreateView(LayoutInflater, ViewGroup, Bundle), and #onViewCreated(View, Bundle).

This corresponds to Activity#onSaveInstanceState(Bundle) Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: this method may be called at any time before #onDestroy(). There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Added in 1.1.0

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.

Parameters
`action: GuidedAction`	The chosen action.

Returns
`Boolean`	true to collapse the sub actions list, false to keep it expanded.

Added in 1.1.0

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.

popBackStackToGuidedStepSupportFragment

Added in 1.1.0

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

Convenient method to pop to fragment with Given class.

Parameters
`guidedStepFragmentClass: Class<Any!>`	Name of the Class of GuidedStepSupportFragment to pop to.
`flags: Int`	Either 0 or `POP_BACK_STACK_INCLUSIVE`.

Added in 1.1.0

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.

Parameters
`actions: (Mutable)List<GuidedAction!>`	The list of GuidedActions for this fragment.

Added in 1.1.0

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

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

Parameters
`diffCallback: DiffCallback<GuidedAction!>?`	DiffCallback used in `setActions`.

Added in 1.1.0

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

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

Parameters
`actions: (Mutable)List<GuidedAction!>`	The list of button GuidedActions for this fragment.

setSelectedActionPosition

Added in 1.1.0

fun setSelectedActionPosition(position: Int): Unit

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

Parameters
`position: Int`	The integer position of the action of interest.

setSelectedButtonActionPosition

Added in 1.1.0

fun setSelectedButtonActionPosition(position: Int): Unit

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

Parameters
`position: Int`	The integer position of the button action of interest.

setUiStyle

Added in 1.1.0

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

Parameters
`style: Int`	`UI_STYLE_ACTIVITY_ROOTUI_STYLE_REPLACE` or `UI_STYLE_ENTRANCE`.

Protected functions

onAddSharedElementTransition

Added in 1.1.0

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

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

Parameters
`ft: FragmentTransaction`	The FragmentTransaction to add shared element.
`disappearing: GuidedStepSupportFragment`	The disappearing fragment.

See also
`GuidedActionsStylist`
`onProvideFragmentTransitions`

onProvideFragmentTransitions

Added in 1.1.0

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