added in version 24.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

GuidedStepSupportFragment

public class GuidedStepSupportFragment
extends Fragment

java.lang.Object
↳	android.support.v4.app.Fragment
	↳	android.support.v17.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(Bundle), to provide instructions to the user
onCreateActions(List, Bundle), to provide a set of GuidedActions the user can take
onGuidedActionClicked(GuidedAction), to respond to those actions

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 GuidanceStylist is responsible for the left guidance view, while the GuidedActionsStylist 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(FragmentManager, GuidedStepSupportFragment) 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.

See also:

Summary

XML attributes
`LeanbackGuidedStepTheme_guidedActionContentWidthWeight`
`LeanbackGuidedStepTheme_guidedActionContentWidthWeightTwoPanels`
`LeanbackGuidedStepTheme_guidedActionsBackground`
`LeanbackGuidedStepTheme_guidedActionsBackgroundDark`
`LeanbackGuidedStepTheme_guidedActionsElevation`
`LeanbackGuidedStepTheme_guidedStepBackground`
`LeanbackGuidedStepTheme_guidedStepTheme`

Constants
`String`	`EXTRA_UI_STYLE` Fragment argument name for UI style.
`int`	`UI_STYLE_ACTIVITY_ROOT` One possible value of argument `EXTRA_UI_STYLE`.
`int`	`UI_STYLE_DEFAULT` This constant was deprecated in API level 24.1.0. Same value as `UI_STYLE_REPLACE`.
`int`	`UI_STYLE_ENTRANCE` Default value for argument `EXTRA_UI_STYLE`.
`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
`GuidedStepSupportFragment()`

Public methods
`static int`	`add(FragmentManager fragmentManager, GuidedStepSupportFragment fragment, int id)` Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions.
`static int`	`add(FragmentManager fragmentManager, GuidedStepSupportFragment fragment)` Adds the specified GuidedStepSupportFragment to the fragment stack, replacing any existing GuidedStepSupportFragments in the stack, and configuring the fragment-to-fragment custom transitions.
`static int`	`addAsRoot(FragmentActivity activity, GuidedStepSupportFragment fragment, int id)` Adds the specified GuidedStepSupportFragment as content of Activity; no backstack entry is added so the activity will be dismissed when BACK key is pressed.
`void`	`collapseAction(boolean withTransition)` Collapse action which either has a sub actions list or action with `hasEditableActivatorView()` is true.
`void`	`collapseSubActions()` Collapse sub actions list.
`void`	`expandAction(GuidedAction action, boolean withTransition)` Expand a given action with sub actions list or `hasEditableActivatorView()` is true.
`void`	`expandSubActions(GuidedAction action)` Expand a given action's sub actions list.
`GuidedAction`	`findActionById(long id)` Find GuidedAction by Id.
`int`	`findActionPositionById(long id)` Find GuidedAction position in array by Id.
`GuidedAction`	`findButtonActionById(long id)` Find button GuidedAction by Id.
`int`	`findButtonActionPositionById(long id)` Find button GuidedAction position in array by Id.
`void`	`finishGuidedStepSupportFragments()` Convenient method to close GuidedStepSupportFragments on top of other content or finish Activity if GuidedStepSupportFragments were started in a separate activity.
`View`	`getActionItemView(int position)` Returns the view corresponding to the action at the indicated position in the list of actions for this fragment.
`List<GuidedAction>`	`getActions()` Returns the list of GuidedActions that the user may take in this fragment.
`View`	`getButtonActionItemView(int position)` Returns the view corresponding to the button action at the indicated position in the list of actions for this fragment.
`List<GuidedAction>`	`getButtonActions()` Returns the list of button GuidedActions that the user may take in this fragment.
`static GuidedStepSupportFragment`	`getCurrentGuidedStepSupportFragment(FragmentManager fm)` 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()`
`void`	`notifyActionChanged(int position)` Notify an action has changed and update its UI.
`void`	`notifyButtonActionChanged(int position)` Notify an button action has changed and update its UI.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`void`	`onCreateActions(List<GuidedAction> actions, Bundle savedInstanceState)` Fills out the set of actions available to the user.
`GuidedActionsStylist`	`onCreateActionsStylist()` Creates the presenter used to style the guided actions panel.
`View`	`onCreateBackgroundView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called by onCreateView to inflate background view.
`void`	`onCreateButtonActions(List<GuidedAction> actions, Bundle savedInstanceState)` 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(Bundle savedInstanceState)` Returns the information required to provide guidance to the user.
`GuidanceStylist`	`onCreateGuidanceStylist()` Creates the presenter used to style the guidance panel.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onGuidedActionClicked(GuidedAction action)` Callback invoked when an action is taken by the user.
`void`	`onGuidedActionEditCanceled(GuidedAction action)` Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key.
`void`	`onGuidedActionEdited(GuidedAction action)` This method was deprecated in API level 24.1.0. Override `onGuidedActionEditedAndProceed(GuidedAction)` and/or `onGuidedActionEditCanceled(GuidedAction)`.
`long`	`onGuidedActionEditedAndProceed(GuidedAction action)` Callback invoked when an action has been edited, for example when user clicks confirm button in IME window.
`void`	`onGuidedActionFocused(GuidedAction action)` 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.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`boolean`	`onSubGuidedActionClicked(GuidedAction action)` Callback invoked when an action in sub actions is taken by the user.
`void`	`openInEditMode(GuidedAction action)` Opens the provided action in edit mode and raises ime.
`void`	`popBackStackToGuidedStepSupportFragment(Class guidedStepFragmentClass, int flags)` Convenient method to pop to fragment with Given class.
`void`	`setActions(List<GuidedAction> actions)` Sets the list of GuidedActions that the user may take in this fragment.
`void`	`setActionsDiffCallback(DiffCallback<GuidedAction> diffCallback)` Sets the RecyclerView DiffCallback used when `setActions(List)` is called.
`void`	`setButtonActions(List<GuidedAction> actions)` Sets the list of button GuidedActions that the user may take in this fragment.
`void`	`setSelectedActionPosition(int position)` Scrolls the action list to the position indicated, selecting that action's view.
`void`	`setSelectedButtonActionPosition(int position)` Scrolls the action list to the position indicated, selecting that button action's view.
`void`	`setUiStyle(int style)` Set UI style to fragment arguments.

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

Inherited methods

From class


  
    android.support.v4.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final 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.
`final Bundle`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`final 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.
`Object`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Object`	`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.
`final FragmentManager`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()`
`LoaderManager`	`getLoaderManager()` Return the LoaderManager for this fragment.
`final Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`Object`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final Resources`	`getResources()` Return `requireActivity().getResources()`.
`final boolean`	`getRetainInstance()`
`Object`	`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.
`Object`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Object`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String`	`getString(int resId, Object... formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
`final String`	`getString(int resId)` Return a localized string from the application's package's default string table.
`final String`	`getTag()` Get the tag name of the fragment, if specified.
`final Fragment`	`getTargetFragment()` Return the target fragment set by `setTargetFragment(Fragment, int)`.
`final int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment(Fragment, int)`.
`final CharSequence`	`getText(int resId)` 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(LayoutInflater, ViewGroup, Bundle)`), if provided.
`ViewModelStore`	`getViewModelStore()`
`final int`	`hashCode()` Subclasses can not override hashCode().
`static Fragment`	`instantiate(Context context, String fname)` Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
`static Fragment`	`instantiate(Context context, String fname, Bundle args)` Create a new instance of a Fragment with the given class name.
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(Intent, int)`.
`void`	`onAttach(Activity activity)` This method was deprecated in API level 24.1.0. See `onAttach(Context)`.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void`	`onConfigurationChanged(Configuration newConfig)`
`boolean`	`onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animation`	`onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Fragment host's standard options menu.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void`	`onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 24.1.0. See `onInflate(Context, AttributeSet, Bundle)`.
`void`	`onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(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).
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`onPrepareOptionsMenu(Menu menu)` Prepare the Fragment host's standard options menu to be displayed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `executePendingTransactions()` has been called.
`void`	`registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`final FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final FragmentManager`	`requireFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`requireHost()` Return the host object of this fragment.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the the return transition and reenter transition overlap or not.
`void`	`setArguments(Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` 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.
`void`	`setEnterTransition(Object transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` 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.
`void`	`setExitTransition(Object transition)` 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.
`void`	`setHasOptionsMenu(boolean hasMenu)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void`	`setInitialSavedState(Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(Object transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void`	`setRetainInstance(boolean retain)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
`void`	`setReturnTransition(Object transition)` 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.
`void`	`setSharedElementEnterTransition(Object transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(Object transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` Optional target for this fragment.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` Set a hint to the system about whether this fragment's UI is currently visible to the user.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale for requesting a permission.
`void`	`startActivity(Intent intent)` Call `startActivity(Intent)` from the fragment's containing Activity.
`void`	`startActivity(Intent intent, Bundle options)` Call `startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode)` Call `startActivityForResult(Intent, int)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode, Bundle options)` Call `startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called.
`String`	`toString()`
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class


  
    java.lang.Object

From interface


  
    android.content.ComponentCallbacks

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.arch.lifecycle.LifecycleOwner

From interface


  
    android.arch.lifecycle.ViewModelStoreOwner

XML attributes

LeanbackGuidedStepTheme_guidedActionContentWidthWeight

LeanbackGuidedStepTheme_guidedActionContentWidthWeightTwoPanels

LeanbackGuidedStepTheme_guidedActionsBackground

LeanbackGuidedStepTheme_guidedActionsBackgroundDark

LeanbackGuidedStepTheme_guidedActionsElevation

LeanbackGuidedStepTheme_guidedStepBackground

LeanbackGuidedStepTheme_guidedStepTheme

Constants

EXTRA_UI_STYLE

added in version 24.1.0

String EXTRA_UI_STYLE

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:

Constant Value: "uiStyle"

UI_STYLE_ACTIVITY_ROOT

added in version 24.1.0

int UI_STYLE_ACTIVITY_ROOT

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

Constant Value: 2 (0x00000002)

UI_STYLE_DEFAULT

added in version 24.1.0

int UI_STYLE_DEFAULT

This constant was deprecated in API level 24.1.0.
Same value as UI_STYLE_REPLACE.

Constant Value: 0 (0x00000000)

UI_STYLE_ENTRANCE

added in version 24.1.0

int UI_STYLE_ENTRANCE

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.

Constant Value: 1 (0x00000001)

UI_STYLE_REPLACE

added in version 24.1.0

int UI_STYLE_REPLACE

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.

Constant Value: 0 (0x00000000)

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.

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.

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

Parameters
`actions`	`List`: A non-null, empty list ready to be populated.
`savedInstanceState`	`Bundle`: The saved instance state from onCreate.

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

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.

Parameters
`guidedStepFragmentClass`	`Class`: Name of the Class of GuidedStepSupportFragment to pop to.
`flags`	`int`: Either 0 or `POP_BACK_STACK_INCLUSIVE`.

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

GuidedStepSupportFragment

Basic Usage

Theming and Stylists

Guided sequences

Summary

XML attributes

Constants

Public constructors

Public methods

Protected methods

Inherited methods

XML attributes

LeanbackGuidedStepTheme_guidedActionContentWidthWeight

LeanbackGuidedStepTheme_guidedActionContentWidthWeightTwoPanels

LeanbackGuidedStepTheme_guidedActionsBackground

LeanbackGuidedStepTheme_guidedActionsBackgroundDark

LeanbackGuidedStepTheme_guidedActionsElevation

LeanbackGuidedStepTheme_guidedStepBackground

LeanbackGuidedStepTheme_guidedStepTheme

Constants

EXTRA_UI_STYLE

UI_STYLE_ACTIVITY_ROOT

UI_STYLE_DEFAULT

UI_STYLE_ENTRANCE

UI_STYLE_REPLACE

Public constructors

GuidedStepSupportFragment

Public methods

add

add

addAsRoot

collapseAction

collapseSubActions

expandAction

expandSubActions

findActionById

findActionPositionById

findButtonActionById

findButtonActionPositionById

finishGuidedStepSupportFragments

getActionItemView

getActions

getButtonActionItemView

getButtonActions

getCurrentGuidedStepSupportFragment

getGuidanceStylist

getGuidedActionsStylist

getGuidedButtonActionsStylist

getSelectedActionPosition

getSelectedButtonActionPosition

getUiStyle

isExpanded

isFocusOutEndAllowed

isFocusOutStartAllowed

isSubActionsExpanded

notifyActionChanged

notifyButtonActionChanged

onCreate

onCreateActions

onCreateActionsStylist

onCreateBackgroundView

onCreateButtonActions

onCreateButtonActionsStylist

onCreateGuidance

onCreateGuidanceStylist

onCreateView

onDestroyView

onGuidedActionClicked

onGuidedActionEditCanceled

onGuidedActionEdited

onGuidedActionEditedAndProceed

onGuidedActionFocused

onProvideTheme

onResume

onSaveInstanceState

onSubGuidedActionClicked

openInEditMode

popBackStackToGuidedStepSupportFragment

setActions

setActionsDiffCallback