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 androidx.leanback.R.style#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 androidx.leanback.R.styleable#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 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 ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE. 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. FragmentManager? getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any? getHost() Return the host object of this fragment. May return null if the fragment isn't currently being hosted. Int getId() Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment. LayoutInflater getLayoutInflater() Returns the cached LayoutInflater used to inflate Views of this Fragment. If onGetLayoutInflater(Bundle) has not been called onGetLayoutInflater(Bundle) will be called with a null argument and that value will be cached. The cached LayoutInflater will be replaced immediately prior to onCreateView(LayoutInflater, ViewGroup, Bundle) and cleared immediately after onDetach(). Lifecycle getLifecycle() Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made final in a future version of Fragment. LoaderManager getLoaderManager() Return the LoaderManager for this fragment. Fragment? getParentFragment() Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null. FragmentManager getParentFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any? getReenterTransition() Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If nothing is set, the default will be to use the same transition as getExitTransition(). Resources getResources() Return requireActivity().getResources(). Boolean getRetainInstance() Returns true if this fragment instance's state will be retained across configuration changes, and false if it will not. 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If nothing is set, the default will be to use the same transition as getEnterTransition(). SavedStateRegistry getSavedStateRegistry() Any? getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. Any? getSharedElementReturnTransition() Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as setSharedElementEnterTransition(Object). String getString(@StringRes resId: Int) Return a localized string from the application's package's default string table. String getString(@StringRes resId: Int, @Nullable vararg formatArgs: 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 java.lang.String#format. String? getTag() Get the tag name of the fragment, if specified. Fragment? getTargetFragment() Return the target fragment set by setTargetFragment. Int getTargetRequestCode() Return the target request code set by setTargetFragment. CharSequence getText(@StringRes resId: Int) Return a localized, styled CharSequence from the application's package's default string table. Boolean getUserVisibleHint() View? getView() Get the root view for the fragment's layout (the one returned by onCreateView), if provided. LifecycleOwner getViewLifecycleOwner() Get a LifecycleOwner that represents the Fragment's View lifecycle. In most cases, this mirrors the lifecycle of the Fragment itself, but in cases of detached Fragments, the lifecycle of the Fragment can be considerably longer than the lifecycle of the View itself. Namely, the lifecycle of the Fragment's View is: created after onViewStateRestored(Bundle) started after onStart() resumed after onResume() paused before onPause() stopped before onStop() destroyed before onDestroyView() The first method where it is safe to access the view lifecycle is onCreateView(LayoutInflater, ViewGroup, Bundle) under the condition that you must return a non-null view (an IllegalStateException will be thrown if you access the view lifecycle but don't return a non-null view). The view lifecycle remains valid through the call to onDestroyView(), after which getView() will return null, the view lifecycle will be destroyed, and this method will throw an IllegalStateException. Consider using getViewLifecycleOwnerLiveData() or FragmentTransaction#runOnCommit(Runnable) to receive a callback for when the Fragment's view lifecycle is available. This should only be called on the main thread. Overriding this method is no longer supported and this method will be made final in a future version of Fragment. LiveData<LifecycleOwner!> getViewLifecycleOwnerLiveData() Retrieve a LiveData which allows you to observe the lifecycle of the Fragment's View. This will be set to the new LifecycleOwner after onCreateView returns a non-null View and will set to null after onDestroyView(). Overriding this method is no longer supported and this method will be made final in a future version of Fragment. ViewModelStore getViewModelStore() Returns the ViewModelStore associated with this Fragment Overriding this method is no longer supported and this method will be made final in a future version of Fragment. Int hashCode() Subclasses can not override hashCode(). Fragment instantiate(@NonNull context: Context, @NonNull fname: String) Like instantiate(Context, String, Bundle) but with a null argument Bundle. Fragment instantiate(@NonNull context: Context, @NonNull fname: String, @Nullable args: Bundle?) Create a new instance of a Fragment with the given class name. This is the same as calling its empty constructor, setting the ClassLoader on the supplied arguments, then calling setArguments(Bundle). 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. That is, FragmentTransaction.detach(Fragment) has been used on it. Boolean isHidden() Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with onHiddenChanged. Note that the hidden state is orthogonal to other states -- that is, to be visible to the user, a fragment must be both started and not hidden. Boolean isInLayout() Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. This will always be true when fragments are created through the <fragment> tag, except in the case where an old fragment is restored from a previous state and it does not appear in the layout of the current state. Boolean isRemoving() Return true if this fragment is currently being removed from its activity. This is not whether its activity is finishing, but rather whether it is in the process of being removed from its activity. Boolean isResumed() Return true if the fragment is in the resumed state. This is true for the duration of onResume() and onPause() as well. Boolean isStateSaved() Returns true if this fragment is added and its state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true, and some operations such as setArguments(Bundle) will fail. Boolean isVisible() Return true if the fragment is currently visible to the user. This means it: (1) has been added, (2) has its view attached to the window, and (3) is not hidden. Unit onActivityCreated(@Nullable savedInstanceState: Bundle?) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. It can be used to do final initialization once these pieces are in place, such as retrieving views or restoring state. It is also useful for fragments that use setRetainInstance(boolean) to retain their instance, as this callback tells the fragment when it is fully associated with the new activity instance. This is called after onCreateView and before onViewStateRestored(Bundle). Unit onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?) Receive the result from a previous call to startActivityForResult(Intent, int). This follows the related Activity API as described there in Activity#onActivityResult(int, int, Intent). Unit onAttach(@NonNull context: Context) Called when a fragment is first attached to its context. onCreate(Bundle) will be called after this. Unit onAttach(@NonNull activity: Activity) Called when a fragment is first attached to its activity. onCreate(Bundle) will be called after this. Unit onAttachFragment(@NonNull childFragment: Fragment) Called when a fragment is attached as a child of this fragment. This is called after the attached fragment's onAttach and before the attached fragment's onCreate if the fragment has not yet had a previous call to onCreate. Unit onConfigurationChanged(@NonNull newConfig: Configuration) Boolean onContextItemSelected(@NonNull item: MenuItem) This hook is called whenever an item in a context menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Use MenuItem#getMenuInfo() to get extra information set by the View that added this menu item. Derived classes should call through to the base class for it to perform the default menu handling. Animation? onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int) Called when a fragment loads an animation. Note that if FragmentTransaction#setCustomAnimations(int, int) was called with Animator resources instead of Animation resources, nextAnim will be an animator resource. Animator? onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int) Called when a fragment loads an animator. This will be called when onCreateAnimation(int, boolean, int) returns null. Note that if FragmentTransaction#setCustomAnimations(int, int) was called with Animation resources instead of Animator resources, nextAnim will be an animation resource. Unit onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenuInfo?) Called when a context menu for the view is about to be shown. Unlike onCreateOptionsMenu, this will be called every time the context menu is about to be shown and should be populated for the view (or item inside the view for AdapterView subclasses, this can be found in the menuInfo)). Use onContextItemSelected(android.view.MenuItem) to know when an item has been selected. The default implementation calls up to Activity.onCreateContextMenu, though you can not call this implementation if you don't want that behavior. It is not safe to hold onto the context menu after this method returns. Unit onCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater) Initialize the contents of the Fragment host's standard options menu. You should place your menu items in to menu. For this method to be called, you must have first called setHasOptionsMenu. See Activity.onCreateOptionsMenu for more information. Unit onDestroy() Called when the fragment is no longer in use. This is called after onStop() and before onDetach(). Unit onDestroyOptionsMenu() Called when this fragment's option menu items are no longer being included in the overall options menu. Receiving this call means that the menu needed to be rebuilt, but this fragment's items were not included in the newly built menu (its onCreateOptionsMenu(Menu, MenuInflater) was not called). Unit onDetach() Called when the fragment is no longer attached to its activity. This is called after onDestroy(). LayoutInflater onGetLayoutInflater(@Nullable savedInstanceState: Bundle?) Returns the LayoutInflater used to inflate Views of this Fragment. The default implementation will throw an exception if the Fragment is not attached. Unit onHiddenChanged(hidden: Boolean) Called when the hidden state (as returned by isHidden() of the fragment has changed. Fragments start out not hidden; this will be called whenever the fragment changes state from that. Unit onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable 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. This may be called immediately after the fragment is created from a FragmentContainerView in a layout file. Note this is before the fragment's onAttach(Context) has been called; all you should do here is parse the attributes and save them away. This is called the first time the fragment is inflated. If it is being inflated into a new instance with saved state, this method will not be called a second time for the restored state fragment. Here is a typical implementation of a fragment that can take parameters both through attributes supplied here as well from getArguments(): Note that parsing the XML attributes uses a "styleable" resource. The declaration for the styleable used here is: The fragment can then be declared within its activity's content layout through a tag like this: This fragment can also be created dynamically from arguments given at runtime in the arguments Bundle; here is an example of doing so at creation of the containing activity: Unit onInflate(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable 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 onLowMemory() Unit onMultiWindowModeChanged(isInMultiWindowMode: Boolean) Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to Activity#onMultiWindowModeChanged of the containing Activity. Boolean onOptionsItemSelected(@NonNull item: MenuItem) This hook is called whenever an item in your options menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Derived classes should call through to the base class for it to perform the default menu handling. Unit onOptionsMenuClosed(@NonNull menu: Menu) This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected). Unit onPause() Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle. Unit onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean) Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to Activity#onPictureInPictureModeChanged of the containing Activity. Unit onPrepareOptionsMenu(@NonNull menu: Menu) Prepare the Fragment host's standard options menu to be displayed. This is called right before the menu is shown, every time it is shown. You can use this method to efficiently enable/disable items or otherwise dynamically modify the contents. See Activity.onPrepareOptionsMenu for more information. Unit onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean) Callback for when the primary navigation state of this Fragment has changed. This can be the result of the getParentFragmentManager() containing FragmentManager} having its primary navigation fragment changed via androidx.fragment.app.FragmentTransaction#setPrimaryNavigationFragment or due to the primary navigation fragment changing in a parent FragmentManager. Unit onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String!>, @NonNull grantResults: IntArray) Callback for the result from requesting permissions. This method is invoked for every call on requestPermissions(String[], int). Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation. Unit onStart() Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle. Unit onStop() Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle. Unit onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?) Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point. Unit onViewStateRestored(@Nullable savedInstanceState: Bundle?) Called when all saved state has been restored into the view hierarchy of the fragment. This can be used to do initialization based on saved state that you are letting the view hierarchy track itself, such as whether check box widgets are currently checked. This is called after onViewCreated(View, Bundle) and before onStart(). Unit postponeEnterTransition() Postpone the entering Fragment transition until startPostponedEnterTransition() or FragmentManager#executePendingTransactions() has been called. This method gives the Fragment the ability to delay Fragment animations until all data is loaded. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called startPostponedEnterTransition(). This method should be called before being added to the FragmentTransaction or in onCreate(Bundle), onAttach(Context), or onCreateView(LayoutInflater, ViewGroup, Bundle)}. startPostponedEnterTransition() must be called to allow the Fragment to start the transitions. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if FragmentTransaction reordering is enabled. Unit postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit) Postpone the entering Fragment transition for a given amount of time and then call startPostponedEnterTransition(). This method gives the Fragment the ability to delay Fragment animations for a given amount of time. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called startPostponedEnterTransition(). This method should be called before being added to the FragmentTransaction or in onCreate(Bundle), onAttach(Context), or onCreateView(LayoutInflater, ViewGroup, Bundle)}. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if FragmentTransaction reordering is enabled. ActivityResultLauncher<I> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>) Register a request to start an activity for result, designated by the given contract. This creates a record in the registry associated wit this caller, managing request code, as well as conversions to/from Intent under the hood. This *must* be called unconditionally, as part of initialization path, typically as a field initializer of an Activity or Fragment. If the host of this fragment is an ActivityResultRegistryOwner the ActivityResultRegistry of the host will be used. Otherwise, this will use the registry of the Fragment's Activity. ActivityResultLauncher<I> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>) Unit registerForContextMenu(@NonNull view: View) Registers a context menu to be shown for the given view (multiple views can show the context menu). This method will set the OnCreateContextMenuListener on the view to this fragment, so onCreateContextMenu(ContextMenu, View, ContextMenuInfo) will be called when it is time to show the context menu. Unit requestPermissions(@NonNull permissions: Array<String!>, requestCode: Int) Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level #PROTECTION_DANGEROUS dangerous, regardless whether they are declared by the platform or a third-party app. Normal permissions android.content.pm.PermissionInfo#PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions android.content.pm.PermissionInfo#PROTECTION_SIGNATURE are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions. If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on reporting whether the permissions were granted or not. Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission. This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to . When checking whether you have a permission you should use . Calling this API for permissions already granted to your app would show UI to the user to decided whether the app can still hold these permissions. This can be useful if the way your app uses the data guarded by the permissions changes significantly. A sample permissions request looks like this: <code><p> private void showContacts() { if (getActivity().checkSelfPermission(Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED) { requestPermissions(new String[]{Manifest.permission.READ_CONTACTS}, PERMISSIONS_REQUEST_READ_CONTACTS); } else { doShowContacts(); } } @Override public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) { if (requestCode == PERMISSIONS_REQUEST_READ_CONTACTS &amp;&amp; grantResults[0] == PackageManager.PERMISSION_GRANTED) { doShowContacts(); } } </p></code> 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() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). 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. 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. Unit setAllowReturnTransitionOverlap(allow: Boolean) Sets 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. Unit setArguments(@Nullable args: Bundle?) Supply the construction arguments for this fragment. The arguments supplied here will be retained across fragment destroy and creation. This method cannot be called if the fragment is added to a FragmentManager and if isStateSaved() would return true. Unit setEnterSharedElementCallback(@Nullable 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(@Nullable transition: Any?) Sets 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 ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE. If transition is null, entering Views will remain unaffected. Unit setExitSharedElementCallback(@Nullable 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(@Nullable 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. Unit setHasOptionsMenu(hasMenu: Boolean) Report that this fragment would like to participate in populating the options menu by receiving a call to onCreateOptionsMenu and related methods. Unit setInitialSavedState(@Nullable 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. This is useful if you know that a fragment has been placed in your view hierarchy so that the user can not currently seen it, so any menu items it has should also not be shown. Unit setReenterTransition(@Nullable transition: Any?) Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as getExitTransition(). Unit setRetainInstance(retain: Boolean) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). If set, the fragment lifecycle will be slightly different when an activity is recreated: onDestroy() will not be called (but onDetach() still will be, because the fragment is being detached from its current activity). onCreate(Bundle) will not be called since the fragment is not being re-created. onAttach(Activity) and onActivityCreated(Bundle) will still be called. Unit setReturnTransition(@Nullable 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, entering Views will remain unaffected. If nothing is set, the default will be to use the same value as set in setEnterTransition(Object). Unit setSharedElementEnterTransition(@Nullable transition: Any?) Sets the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. Unit setSharedElementReturnTransition(@Nullable transition: Any?) Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as setSharedElementEnterTransition(Object). Unit setTargetFragment(@Nullable fragment: Fragment?, requestCode: Int) Optional target for this fragment. This may be used, for example, if this fragment is being started by another, and when done wants to give a result back to the first. The target set here is retained across instances via FragmentManager.putFragment(). Unit setUserVisibleHint(isVisibleToUser: Boolean) Set a hint to the system about whether this fragment's UI is currently visible to the user. This hint defaults to true and is persistent across fragment instance state save and restore. An app may set this to false to indicate that the fragment's UI is scrolled out of visibility or is otherwise not directly visible to the user. This may be used by the system to prioritize operations such as fragment lifecycle updates or loader ordering behavior. Note: This method may be called outside of the fragment lifecycle. and thus has no ordering guarantees with regard to fragment lifecycle method calls. Boolean shouldShowRequestPermissionRationale(@NonNull permission: String) Gets whether you should show UI with rationale for requesting a permission. You should do this only if you do not have the permission and the context in which the permission is requested does not clearly communicate to the user what would be the benefit from granting this permission. For example, if you write a camera app, requesting the camera permission would be expected by the user and no rationale for why it is requested is needed. If however, the app needs location for tagging photos then a non-tech savvy user may wonder how location is related to taking photos. In this case you may choose to show UI with rationale of requesting this permission. Unit startActivity(intent: Intent!) Call Activity#startActivity(Intent) from the fragment's containing Activity. Unit startActivity(intent: Intent!, @Nullable options: Bundle?) Call Activity#startActivity(Intent, Bundle) from the fragment's containing Activity. Unit startActivityForResult(intent: Intent!, requestCode: Int) Call Activity#startActivityForResult(Intent, int) from the fragment's containing Activity. Unit startActivityForResult(intent: Intent!, requestCode: Int, @Nullable options: Bundle?) Call Activity#startActivityForResult(Intent, int, Bundle) from the fragment's containing Activity. Unit startIntentSenderForResult(intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?) Call Activity#startIntentSenderForResult(IntentSender, int, Intent, int, int, int, * Bundle) from the fragment's containing Activity. Unit startPostponedEnterTransition() Begin postponed transitions after postponeEnterTransition() was called. If postponeEnterTransition() was called, you must call startPostponedEnterTransition() or FragmentManager#executePendingTransactions() to complete the FragmentTransaction. If postponement was interrupted with FragmentManager#executePendingTransactions(), before startPostponedEnterTransition(), animations may not run or may execute improperly. String toString() Unit unregisterForContextMenu(@NonNull view: View) Prevents a context menu to be shown for the given view. This method will remove the OnCreateContextMenuListener on the view.

Constants

EXTRA_UI_STYLE

static val EXTRA_UI_STYLE: 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(FragmentActivity, GuidedStepSupportFragment, int) sets to UI_STYLE_ACTIVITY_ROOT
• add(FragmentManager, GuidedStepSupportFragment) or add(FragmentManager, * GuidedStepSupportFragment, int) 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_REPLACE
• UI_STYLE_ENTRANCE
• UI_STYLE_ACTIVITY_ROOT

Value: "uiStyle"

UI_STYLE_ACTIVITY_ROOT

static val UI_STYLE_ACTIVITY_ROOT: 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().

Value: 2

UI_STYLE_DEFAULT

static val UI_STYLE_DEFAULT: Int

Deprecated: Same value as UI_STYLE_REPLACE.

Value: 0

UI_STYLE_ENTRANCE

static val UI_STYLE_ENTRANCE: 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.

Value: 1

UI_STYLE_REPLACE

static val UI_STYLE_REPLACE: 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.

Value: 0

Public constructors

<init>

GuidedStepSupportFragment()

Public methods

add

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

Return
Int	The ID returned by the call FragmentTransaction.commit.

add

open static fun add(
    fragmentManager: FragmentManager!, 
    fragment: GuidedStepSupportFragment!, 
    id: Int
): 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 and onAddSharedElementTransition(FragmentTransaction, GuidedStepSupportFragment) 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.

Return
Int	The ID returned by the call FragmentTransaction.commit.

addAsRoot

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

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

collapseAction

open fun collapseAction(withTransition: Boolean): Unit

Collapse action which either has a sub actions list or action with GuidedAction#hasEditableActivatorView() is true.

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

collapseSubActions

open fun collapseSubActions(): Unit

Collapse sub actions list.

See Also

• GuidedAction#getSubActions()

expandAction

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

Expand a given action with sub actions list or GuidedAction#hasEditableActivatorView() is true. The method must be called after onCreateView(LayoutInflater, ViewGroup, Bundle) creates fragment view.

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

expandSubActions

open fun expandSubActions(action: GuidedAction!): Unit

Expand a given action's sub actions list.

Parameters
action	GuidedAction!: GuidedAction to expand.

See Also

• #expandAction(GuidedAction, boolean)

findActionById

open fun findActionById(id: Long): GuidedAction!

Find GuidedAction by Id.

Parameters
id	Long: Id of the action to search.

Return
GuidedAction!	GuidedAction object or null if not found.

findActionPositionById

open fun findActionPositionById(id: Long): Int

Find GuidedAction position in array by Id.

Parameters
id	Long: Id of the action to search.

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

findButtonActionById

open fun findButtonActionById(id: Long): GuidedAction!

Find button GuidedAction by Id.

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

Return
GuidedAction!	GuidedAction object or null if not found.

findButtonActionPositionById

open fun findButtonActionPositionById(id: Long): Int

Find button GuidedAction position in array by Id.

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

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

finishGuidedStepSupportFragments

open 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(FragmentManager, GuidedStepSupportFragment, * int) which sets up the stack entry name for finding which fragment we need to pop back to.

getActionItemView

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

Return
View!	The View corresponding to the action at the indicated position, or null if that action is not currently onscreen.

getActions

open fun getActions(): MutableList<GuidedAction!>!

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

Return
MutableList<GuidedAction!>!	The list of GuidedActions for this fragment.

getButtonActionItemView

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

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

getButtonActions

open fun getButtonActions(): MutableList<GuidedAction!>!

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

Return
MutableList<GuidedAction!>!	The list of button GuidedActions for this fragment.

getCurrentGuidedStepSupportFragment

open static fun getCurrentGuidedStepSupportFragment(fm: FragmentManager!): GuidedStepSupportFragment!

Returns the current GuidedStepSupportFragment on the fragment transaction stack.

Return
GuidedStepSupportFragment!	The current GuidedStepSupportFragment, if any, on the fragment transaction stack.

getGuidanceStylist

open fun getGuidanceStylist(): GuidanceStylist!

Returns the GuidanceStylist that displays guidance information for the user.

Return
GuidanceStylist!	The GuidanceStylist for this fragment.

getGuidedActionsStylist

open fun getGuidedActionsStylist(): GuidedActionsStylist!

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

Return
GuidedActionsStylist!	The GuidedActionsStylist for this fragment.

getGuidedButtonActionsStylist

open fun getGuidedButtonActionsStylist(): GuidedActionsStylist!

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

Return
GuidedActionsStylist!	The GuidedActionsStylist for this fragment.

getSelectedActionPosition

open fun getSelectedActionPosition(): Int

Returns the position if the currently selected GuidedAction.

Return
Int	position The integer position of the currently selected action.

getSelectedButtonActionPosition

open fun getSelectedButtonActionPosition(): Int

Returns the position if the currently selected button GuidedAction.

Return
Int	position The integer position of the currently selected button action.

getUiStyle

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

Return
Int	UI_STYLE_ACTIVITY_ROOT UI_STYLE_REPLACE or UI_STYLE_ENTRANCE.

See Also

• #onProvideFragmentTransitions()

isExpanded

open fun isExpanded(): Boolean

Return
Boolean	True if is current expanded including subactions list or action with GuidedAction#hasEditableActivatorView() is true.

isFocusOutEndAllowed

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

Return
Boolean	True if allows focus out of end edge of GuidedStepSupportFragment.

isFocusOutStartAllowed

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

Return
Boolean	True if allows focus out of start edge of GuidedStepSupportFragment.

isSubActionsExpanded

open fun isSubActionsExpanded(): Boolean

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

notifyActionChanged

open fun notifyActionChanged(position: Int): Unit

Notify an action has changed and update its UI.

Parameters
position	Int: Position of the GuidedAction in array.

notifyButtonActionChanged

open 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

open 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 androidx.lifecycle.LifecycleObserver 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.

Parameters
savedInstanceState	Bundle?: If the fragment is being re-created from a previous saved state, this is the state.

onCreateActions

open fun onCreateActions(
    @NonNull actions: MutableList<GuidedAction!>, 
    savedInstanceState: Bundle!
): Unit

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

Parameters
actions	MutableList<GuidedAction!>: A non-null, empty list ready to be populated.
savedInstanceState	Bundle!: The saved instance state from onCreate.

onCreateActionsStylist

open fun onCreateActionsStylist(): GuidedActionsStylist!

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

Return
GuidedActionsStylist!	The GuidedActionsStylist used in this fragment.

onCreateBackgroundView

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

Called by onCreateView to inflate background view. Default implementation loads view from R.layout#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!:

Return
View!	Created background view or null if no background.

onCreateButtonActions

open fun onCreateButtonActions(
    @NonNull actions: MutableList<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	MutableList<GuidedAction!>: A non-null, empty list ready to be populated.
savedInstanceState	Bundle!: The saved instance state from onCreate.

onCreateButtonActionsStylist

open fun onCreateButtonActionsStylist(): GuidedActionsStylist!

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

Return
GuidedActionsStylist!	The GuidedActionsStylist used in this fragment.

onCreateGuidance

@NonNull open 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.

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

onCreateGuidanceStylist

open fun onCreateGuidanceStylist(): GuidanceStylist!

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

Return
GuidanceStylist!	The GuidanceStylist used in this fragment.

onCreateView

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

Parameters
inflater	LayoutInflater: The LayoutInflater object that can be used to inflate any views in the fragment,
container	ViewGroup?: If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
savedInstanceState	Bundle?: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Return
View?	Return the View for the fragment's UI, or null.

onDestroyView

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

onGuidedActionClicked

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

onGuidedActionEditCanceled

open 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(GuidedAction).

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

onGuidedActionEdited

open fun onGuidedActionEdited(action: GuidedAction!): Unit

Deprecated: Override onGuidedActionEditedAndProceed(GuidedAction) and/or onGuidedActionEditCanceled(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.

onGuidedActionEditedAndProceed

open 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(GuidedAction) and returns GuidedAction#ACTION_ID_NEXT.

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

Return
Long	ID of the action will be focused or GuidedAction#ACTION_ID_NEXT, GuidedAction#ACTION_ID_CURRENT.

onGuidedActionFocused

open fun onGuidedActionFocused(action: GuidedAction!): Unit

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

onProvideTheme

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

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

onResume

open fun onResume(): Unit

onSaveInstanceState

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

Parameters
outState	Bundle: Bundle in which to place your saved state.

onSubGuidedActionClicked

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

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

openInEditMode

open 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(LayoutInflater, ViewGroup, Bundle).

popBackStackToGuidedStepSupportFragment

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

Convenient method to pop to fragment with Given class.

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

setActions

open fun setActions(actions: MutableList<GuidedAction!>!): Unit

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

Parameters
actions	MutableList<GuidedAction!>!: The list of GuidedActions for this fragment.

setActionsDiffCallback

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

Sets the RecyclerView DiffCallback used when setActions(List) 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(List).

setButtonActions

open fun setButtonActions(actions: MutableList<GuidedAction!>!): Unit

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

Parameters
actions	MutableList<GuidedAction!>!: The list of button GuidedActions for this fragment.

setSelectedActionPosition

open 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

open 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

open 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(FragmentManager, GuidedStepSupportFragment, int). 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_ROOT UI_STYLE_REPLACE or UI_STYLE_ENTRANCE.

Protected methods

onAddSharedElementTransition

protected open 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

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