GuidedStepFragment

Added in 1.1.0
Deprecated in 1.1.0

public class GuidedStepFragment extends Fragment


A GuidedStepFragment 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 GuidedStepFragment 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:

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

  • addAsRoot, to be called during Activity onCreate, adds GuidedStepFragment as the first Fragment in activity.
  • add or add, to add GuidedStepFragment on top of existing Fragments or replacing existing GuidedStepFragment when moving forward to next step.
  • finishGuidedStepFragments can either finish the activity or pop all GuidedStepFragment from stack.
  • If app chooses not to use the helper function, it is the app's responsibility to call setUiStyle to select fragment transition and remember the stack entry where it need pops to.

Theming and Stylists

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

GuidedStepFragments 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 GuidedStepFragment as an overlay to the Activity's theme.
  • Finally, custom subclasses of GuidedStepFragment 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 GuidedStepFragment 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

GuidedStepFragments can be grouped together to provide a guided sequence. GuidedStepFragments 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 GuidedStepFragments grouped in this way must all be defined programmatically, rather than in XML. This restriction may be removed in the future.guidedStepThemeguidedStepBackgroundguidedActionContentWidthWeightguidedActionContentWidthWeightTwoPanelsguidedActionsBackgroundguidedActionsBackgroundDarkguidedActionsElevation

Summary

Constants

static final String
EXTRA_UI_STYLE = "uiStyle"

Fragment argument name for UI style.

static final int

One possible value of argument EXTRA_UI_STYLE.

static final int

This field is deprecated.

Same value as UI_STYLE_REPLACE.

static final int

Default value for argument EXTRA_UI_STYLE.

static final int

This is the case that we use GuidedStepFragment to replace another existing GuidedStepFragment when moving forward to next step.

Public constructors

Public methods

static int
add(
    @NonNull FragmentManager fragmentManager,
    @NonNull GuidedStepFragment fragment
)

Adds the specified GuidedStepFragment to the fragment stack, replacing any existing GuidedStepFragments in the stack, and configuring the fragment-to-fragment custom transitions.

static int
add(
    @NonNull FragmentManager fragmentManager,
    @NonNull GuidedStepFragment fragment,
    int id
)

Adds the specified GuidedStepFragment to the fragment stack, replacing any existing GuidedStepFragments in the stack, and configuring the fragment-to-fragment custom transitions.

static int
addAsRoot(
    @NonNull Activity activity,
    @NonNull GuidedStepFragment fragment,
    int id
)

Adds the specified GuidedStepFragment 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

Collapse sub actions list.

void
expandAction(@NonNull GuidedAction action, boolean withTransition)

Expand a given action with sub actions list or hasEditableActivatorView is true.

void

Expand a given action's sub actions list.

@Nullable GuidedAction
findActionById(long id)

Find GuidedAction by Id.

int

Find GuidedAction position in array by Id.

@Nullable GuidedAction

Find button GuidedAction by Id.

int

Find button GuidedAction position in array by Id.

void

Convenient method to close GuidedStepFragments on top of other content or finish Activity if GuidedStepFragments were started in a separate activity.

@Nullable View
getActionItemView(int position)

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

@NonNull List<GuidedAction>

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

@Nullable View

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

@NonNull List<GuidedAction>

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

static @Nullable GuidedStepFragment

Returns the current GuidedStepFragment on the fragment transaction stack.

@NonNull GuidanceStylist

Returns the GuidanceStylist that displays guidance information for the user.

@NonNull GuidedActionsStylist

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

@NonNull GuidedActionsStylist

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

int

Returns the position if the currently selected GuidedAction.

int

Returns the position if the currently selected button GuidedAction.

int

Read UI style from fragment arguments.

boolean
boolean

Returns true if allows focus out of end edge of GuidedStepFragment, false otherwise.

boolean

Returns true if allows focus out of start edge of GuidedStepFragment, false otherwise.

boolean
void
notifyActionChanged(int position)

Notify an action has changed and update its UI.

void

Notify an button action has changed and update its UI.

void
onCreate(@Nullable Bundle savedInstanceState)
void
onCreateActions(
    @NonNull List<GuidedAction> actions,
    @Nullable Bundle savedInstanceState
)

Fills out the set of actions available to the user.

@NonNull GuidedActionsStylist

Creates the presenter used to style the guided actions panel.

@Nullable View
onCreateBackgroundView(
    @NonNull LayoutInflater inflater,
    @Nullable ViewGroup container,
    @Nullable Bundle savedInstanceState
)

Called by onCreateView to inflate background view.

void
onCreateButtonActions(
    @NonNull List<GuidedAction> actions,
    @Nullable Bundle savedInstanceState
)

Fills out the set of actions shown at right available to the user.

@NonNull GuidedActionsStylist

Creates the presenter used to style a sided actions panel for button only.

@NonNull GuidanceStylist.Guidance
onCreateGuidance(@Nullable Bundle savedInstanceState)

Returns the information required to provide guidance to the user.

@NonNull GuidanceStylist

Creates the presenter used to style the guidance panel.

@Nullable View
onCreateView(
    LayoutInflater inflater,
    @Nullable ViewGroup container,
    Bundle savedInstanceState
)
void
void

Callback invoked when an action is taken by the user.

void

Callback invoked when an action has been canceled editing, for example when user closes IME window by BACK key.

void

This method is deprecated.

Override onGuidedActionEditedAndProceed and/or onGuidedActionEditCanceled.

long

Callback invoked when an action has been edited, for example when user clicks confirm button in IME window.

void

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

int

Returns the theme used for styling the fragment.

void

This method is deprecated.

void
boolean

Callback invoked when an action in sub actions is taken by the user.

void

Opens the provided action in edit mode and raises ime.

void
popBackStackToGuidedStepFragment(
    @NonNull Class<Object> guidedStepFragmentClass,
    int flags
)

Convenient method to pop to fragment with Given class.

void

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

void

Sets the RecyclerView DiffCallback used when setActions is called.

void

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

void

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

void

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

Called when this fragment is added to FragmentTransaction with UI_STYLE_REPLACE (aka when the GuidedStepFragment replacing an existing GuidedStepFragment).

void

Called by Constructor to provide fragment transitions.

Inherited Constants

From android.content.ComponentCallbacks2
static final int
static final int
static final int
static final int
static final int
static final int
static final int

Inherited methods

From android.app.Fragment
void
dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)

This method is deprecated.

final boolean

This method is deprecated.

final Activity

This method is deprecated.

boolean

This method is deprecated.

boolean

This method is deprecated.

final Bundle

This method is deprecated.

final FragmentManager

This method is deprecated.

Context

This method is deprecated.

Transition

This method is deprecated.

Transition

This method is deprecated.

final FragmentManager

This method is deprecated.

final Object

This method is deprecated.

final int

This method is deprecated.

final LayoutInflater

This method is deprecated.

LoaderManager

This method is deprecated.

final Fragment

This method is deprecated.

Transition

This method is deprecated.

final Resources

This method is deprecated.

final boolean

This method is deprecated.

Transition

This method is deprecated.

Transition

This method is deprecated.

Transition

This method is deprecated.

final String
getString(int resId)

This method is deprecated.

final String

This method is deprecated.

final Fragment

This method is deprecated.

final int

This method is deprecated.

final CharSequence
getText(int resId)

This method is deprecated.

boolean

This method is deprecated.

View

This method is deprecated.

final int

This method is deprecated.

static Fragment
instantiate(Context context, String fname)

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

final boolean

This method is deprecated.

void
onActivityCreated(Bundle savedInstanceState)

This method is deprecated.

void
onActivityResult(int requestCode, int resultCode, Intent data)

This method is deprecated.

void
onAttach(Context context)

This method is deprecated.

void
onAttachFragment(Fragment childFragment)

This method is deprecated.

void

This method is deprecated.

boolean

This method is deprecated.

Animator
onCreateAnimator(int transit, boolean enter, int nextAnim)

This method is deprecated.

void
onCreateContextMenu(
    ContextMenu menu,
    View v,
    ContextMenu.ContextMenuInfo menuInfo
)

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

LayoutInflater
onGetLayoutInflater(Bundle savedInstanceState)

This method is deprecated.

void
onHiddenChanged(boolean hidden)

This method is deprecated.

void
onInflate(AttributeSet attrs, Bundle savedInstanceState)

This method is deprecated.

void

This method is deprecated.

void
onMultiWindowModeChanged(
    boolean isInMultiWindowMode,
    Configuration newConfig
)

This method is deprecated.

boolean

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void
onPictureInPictureModeChanged(
    boolean isInPictureInPictureMode,
    Configuration newConfig
)

This method is deprecated.

void

This method is deprecated.

void
onRequestPermissionsResult(
    int requestCode,
    String[] permissions,
    int[] grantResults
)

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void
onTrimMemory(int level)

This method is deprecated.

void
onViewCreated(View view, Bundle savedInstanceState)

This method is deprecated.

void
onViewStateRestored(Bundle savedInstanceState)

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

final void
requestPermissions(String[] permissions, int requestCode)

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void
setHasOptionsMenu(boolean hasMenu)

This method is deprecated.

void

This method is deprecated.

void
setMenuVisibility(boolean menuVisible)

This method is deprecated.

void

This method is deprecated.

void
setRetainInstance(boolean retain)

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void
setTargetFragment(Fragment fragment, int requestCode)

This method is deprecated.

void
setUserVisibleHint(boolean isVisibleToUser)

This method is deprecated.

boolean

This method is deprecated.

void

This method is deprecated.

void
startActivityForResult(Intent intent, int requestCode)

This method is deprecated.

void
startIntentSenderForResult(
    IntentSender intent,
    int requestCode,
    Intent fillInIntent,
    int flagsMask,
    int flagsValues,
    int extraFlags,
    Bundle options
)

This method is deprecated.

void

This method is deprecated.

String

This method is deprecated.

void

This method is deprecated.

Constants

EXTRA_UI_STYLE

Added in 1.1.0
Deprecated in 1.1.0
public static final String EXTRA_UI_STYLE = "uiStyle"

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:

Argument value can be either:

UI_STYLE_ACTIVITY_ROOT

Added in 1.1.0
Deprecated in 1.1.0
public static final int UI_STYLE_ACTIVITY_ROOT = 2

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

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

UI_STYLE_DEFAULT

Added in 1.1.0
Deprecated in 1.1.0
public static final int UI_STYLE_DEFAULT = 0

UI_STYLE_ENTRANCE

Added in 1.1.0
Deprecated in 1.1.0
public static final int UI_STYLE_ENTRANCE = 1

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

  • Enter transition slides in from two sides, exit transition slide out to START(left). Background will be faded in. Note: Changing exit transition by UI style is not working because fragment transition asks for exit transition before UI style is restored in Fragment .onCreate().
When popping multiple GuidedStepFragment, finishGuidedStepFragments also changes the top GuidedStepFragment to UI_STYLE_ENTRANCE in order to run the return transition (reverse of enter transition) of UI_STYLE_ENTRANCE.

UI_STYLE_REPLACE

Added in 1.1.0
Deprecated in 1.1.0
public static final int UI_STYLE_REPLACE = 0

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

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

Public constructors

GuidedStepFragment

Added in 1.1.0
Deprecated in 1.1.0
public GuidedStepFragment()

Public methods

add

Added in 1.1.0
Deprecated in 1.1.0
public static int add(
    @NonNull FragmentManager fragmentManager,
    @NonNull GuidedStepFragment fragment
)

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

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

Parameters
@NonNull FragmentManager fragmentManager

The FragmentManager to be used in the transaction.

@NonNull GuidedStepFragment fragment

The GuidedStepFragment to be inserted into the fragment stack.

Returns
int

The ID returned by the call FragmentTransaction.commit.

add

Added in 1.1.0
Deprecated in 1.1.0
public static int add(
    @NonNull FragmentManager fragmentManager,
    @NonNull GuidedStepFragment fragment,
    int id
)

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

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

Parameters
@NonNull FragmentManager fragmentManager

The FragmentManager to be used in the transaction.

@NonNull GuidedStepFragment fragment

The GuidedStepFragment to be inserted into the fragment stack.

int id

The id of container to add GuidedStepFragment, can be android.R.id.content.

Returns
int

The ID returned by the call FragmentTransaction.commit.

addAsRoot

Added in 1.1.0
Deprecated in 1.1.0
public static int addAsRoot(
    @NonNull Activity activity,
    @NonNull GuidedStepFragment fragment,
    int id
)

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

Parameters
@NonNull Activity activity

The Activity to be used to insert GuidedstepFragment.

@NonNull GuidedStepFragment fragment

The GuidedStepFragment to be inserted into the fragment stack.

int id

The id of container to add GuidedStepFragment, can be android.R.id.content.

Returns
int

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

collapseAction

Added in 1.1.0
Deprecated in 1.1.0
public void collapseAction(boolean withTransition)

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

Parameters
boolean withTransition

True to run transition animation, false otherwise.

collapseSubActions

Added in 1.1.0
Deprecated in 1.1.0
public void collapseSubActions()

Collapse sub actions list.

See also
getSubActions

expandAction

Added in 1.1.0
Deprecated in 1.1.0
public void expandAction(@NonNull GuidedAction action, boolean withTransition)

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

Parameters
@NonNull GuidedAction action

GuidedAction to expand.

boolean withTransition

True to run transition animation, false otherwise.

expandSubActions

Added in 1.1.0
Deprecated in 1.1.0
public void expandSubActions(@NonNull GuidedAction action)

Expand a given action's sub actions list.

Parameters
@NonNull GuidedAction action

GuidedAction to expand.

See also
expandAction

findActionById

Added in 1.1.0
Deprecated in 1.1.0
public @Nullable GuidedAction findActionById(long id)

Find GuidedAction by Id.

Parameters
long id

Id of the action to search.

Returns
@Nullable GuidedAction

GuidedAction object or null if not found.

findActionPositionById

Added in 1.1.0
Deprecated in 1.1.0
public int findActionPositionById(long id)

Find GuidedAction position in array by Id.

Parameters
long id

Id of the action to search.

Returns
int

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

findButtonActionById

Added in 1.1.0
Deprecated in 1.1.0
public @Nullable GuidedAction findButtonActionById(long id)

Find button GuidedAction by Id.

Parameters
long id

Id of the button action to search.

Returns
@Nullable GuidedAction

GuidedAction object or null if not found.

findButtonActionPositionById

Added in 1.1.0
Deprecated in 1.1.0
public int findButtonActionPositionById(long id)

Find button GuidedAction position in array by Id.

Parameters
long id

Id of the button action to search.

Returns
int

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

finishGuidedStepFragments

Added in 1.1.0
Deprecated in 1.1.0
public void finishGuidedStepFragments()

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

getActionItemView

Added in 1.1.0
Deprecated in 1.1.0
public @Nullable View getActionItemView(int position)

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

Parameters
int position

The integer position of the action of interest.

Returns
@Nullable View

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

getActions

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull List<GuidedActiongetActions()

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

Returns
@NonNull List<GuidedAction>

The list of GuidedActions for this fragment.

getButtonActionItemView

Added in 1.1.0
Deprecated in 1.1.0
public @Nullable View getButtonActionItemView(int position)

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

Parameters
int position

The integer position of the button action of interest.

Returns
@Nullable View

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

getButtonActions

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull List<GuidedActiongetButtonActions()

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

Returns
@NonNull List<GuidedAction>

The list of button GuidedActions for this fragment.

getCurrentGuidedStepFragment

Added in 1.1.0
Deprecated in 1.1.0
public static @Nullable GuidedStepFragment getCurrentGuidedStepFragment(@NonNull FragmentManager fm)

Returns the current GuidedStepFragment on the fragment transaction stack.

Returns
@Nullable GuidedStepFragment

The current GuidedStepFragment, if any, on the fragment transaction stack.

getGuidanceStylist

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidanceStylist getGuidanceStylist()

Returns the GuidanceStylist that displays guidance information for the user.

Returns
@NonNull GuidanceStylist

The GuidanceStylist for this fragment.

getGuidedActionsStylist

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidedActionsStylist getGuidedActionsStylist()

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

Returns
@NonNull GuidedActionsStylist

The GuidedActionsStylist for this fragment.

getGuidedButtonActionsStylist

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidedActionsStylist getGuidedButtonActionsStylist()

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

Returns
@NonNull GuidedActionsStylist

The GuidedActionsStylist for this fragment.

getSelectedActionPosition

Added in 1.1.0
Deprecated in 1.1.0
public int getSelectedActionPosition()

Returns the position if the currently selected GuidedAction.

Returns
int

position The integer position of the currently selected action.

getSelectedButtonActionPosition

Added in 1.1.0
Deprecated in 1.1.0
public int getSelectedButtonActionPosition()

Returns the position if the currently selected button GuidedAction.

Returns
int

position The integer position of the currently selected button action.

getUiStyle

Added in 1.1.0
Deprecated in 1.1.0
public int getUiStyle()

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

isExpanded

Added in 1.1.0
Deprecated in 1.1.0
public boolean isExpanded()
Returns
boolean

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

isFocusOutEndAllowed

Added in 1.1.0
Deprecated in 1.1.0
public boolean isFocusOutEndAllowed()

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

Returns
boolean

True if allows focus out of end edge of GuidedStepFragment.

isFocusOutStartAllowed

Added in 1.1.0
Deprecated in 1.1.0
public boolean isFocusOutStartAllowed()

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

Returns
boolean

True if allows focus out of start edge of GuidedStepFragment.

isSubActionsExpanded

Added in 1.1.0
Deprecated in 1.1.0
public boolean isSubActionsExpanded()
Returns
boolean

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

notifyActionChanged

Added in 1.1.0
Deprecated in 1.1.0
public void notifyActionChanged(int position)

Notify an action has changed and update its UI.

Parameters
int position

Position of the GuidedAction in array.

notifyButtonActionChanged

Added in 1.1.0
Deprecated in 1.1.0
public void notifyButtonActionChanged(int position)

Notify an button action has changed and update its UI.

Parameters
int position

Position of the button GuidedAction in array.

onCreate

Added in 1.1.0
Deprecated in 1.1.0
public void onCreate(@Nullable Bundle savedInstanceState)

onCreateActions

Added in 1.1.0
Deprecated in 1.1.0
public void onCreateActions(
    @NonNull List<GuidedAction> actions,
    @Nullable Bundle savedInstanceState
)

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

Parameters
@NonNull List<GuidedAction> actions

A non-null, empty list ready to be populated.

@Nullable Bundle savedInstanceState

The saved instance state from onCreate.

onCreateActionsStylist

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidedActionsStylist onCreateActionsStylist()

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

Returns
@NonNull GuidedActionsStylist

The GuidedActionsStylist used in this fragment.

onCreateBackgroundView

Added in 1.1.0
Deprecated in 1.1.0
public @Nullable View onCreateBackgroundView(
    @NonNull LayoutInflater inflater,
    @Nullable ViewGroup container,
    @Nullable Bundle savedInstanceState
)

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

Parameters
@NonNull LayoutInflater inflater

LayoutInflater to load background view.

@Nullable ViewGroup container

Parent view of background view.

@Nullable Bundle savedInstanceState
Returns
@Nullable View

Created background view or null if no background.

onCreateButtonActions

Added in 1.1.0
Deprecated in 1.1.0
public void onCreateButtonActions(
    @NonNull List<GuidedAction> actions,
    @Nullable Bundle savedInstanceState
)

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
@NonNull List<GuidedAction> actions

A non-null, empty list ready to be populated.

@Nullable Bundle savedInstanceState

The saved instance state from onCreate.

onCreateButtonActionsStylist

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidedActionsStylist onCreateButtonActionsStylist()

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

Returns
@NonNull GuidedActionsStylist

The GuidedActionsStylist used in this fragment.

onCreateGuidance

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidanceStylist.Guidance onCreateGuidance(@Nullable Bundle savedInstanceState)

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
@Nullable Bundle savedInstanceState

The saved instance state from onCreateView.

Returns
@NonNull GuidanceStylist.Guidance

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

onCreateGuidanceStylist

Added in 1.1.0
Deprecated in 1.1.0
public @NonNull GuidanceStylist onCreateGuidanceStylist()

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

Returns
@NonNull GuidanceStylist

The GuidanceStylist used in this fragment.

onCreateView

Added in 1.1.0
Deprecated in 1.1.0
public @Nullable View onCreateView(
    LayoutInflater inflater,
    @Nullable ViewGroup container,
    Bundle savedInstanceState
)

onDestroyView

Added in 1.1.0
Deprecated in 1.1.0
public void onDestroyView()

onGuidedActionClicked

Added in 1.1.0
Deprecated in 1.1.0
public void onGuidedActionClicked(@NonNull GuidedAction action)

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

Parameters
@NonNull GuidedAction action

The chosen action.

onGuidedActionEditCanceled

Added in 1.1.0
Deprecated in 1.1.0
public void onGuidedActionEditCanceled(@NonNull GuidedAction action)

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

Parameters
@NonNull GuidedAction action

The action which has been canceled editing.

onGuidedActionEdited

Added in 1.1.0
Deprecated in 1.1.0
public void onGuidedActionEdited(GuidedAction action)

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

Added in 1.1.0
Deprecated in 1.1.0
public long onGuidedActionEditedAndProceed(@NonNull GuidedAction action)

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

Parameters
@NonNull GuidedAction action

The action that has been edited.

Returns
long

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

onGuidedActionFocused

Added in 1.1.0
Deprecated in 1.1.0
public void onGuidedActionFocused(@NonNull GuidedAction action)

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

onProvideTheme

Added in 1.1.0
Deprecated in 1.1.0
public int onProvideTheme()

Returns the theme used for styling the fragment. The default returns -1, indicating that the host Activity's theme should be used.

Returns
int

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

onResume

Added in 1.1.0
Deprecated in 1.1.0
public void onResume()

onSaveInstanceState

Added in 1.1.0
Deprecated in 1.1.0
public void onSaveInstanceState(Bundle outState)

onSubGuidedActionClicked

Added in 1.1.0
Deprecated in 1.1.0
public boolean onSubGuidedActionClicked(@NonNull GuidedAction action)

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
@NonNull GuidedAction action

The chosen action.

Returns
boolean

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

openInEditMode

Added in 1.1.0
Deprecated in 1.1.0
public void openInEditMode(@Nullable GuidedAction action)

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.

popBackStackToGuidedStepFragment

Added in 1.1.0
Deprecated in 1.1.0
public void popBackStackToGuidedStepFragment(
    @NonNull Class<Object> guidedStepFragmentClass,
    int flags
)

Convenient method to pop to fragment with Given class.

Parameters
@NonNull Class<Object> guidedStepFragmentClass

Name of the Class of GuidedStepFragment to pop to.

int flags

Either 0 or POP_BACK_STACK_INCLUSIVE.

setActions

Added in 1.1.0
Deprecated in 1.1.0
public void setActions(@NonNull List<GuidedAction> actions)

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

Parameters
@NonNull List<GuidedAction> actions

The list of GuidedActions for this fragment.

setActionsDiffCallback

Added in 1.1.0
Deprecated in 1.1.0
public void setActionsDiffCallback(
    @Nullable DiffCallback<GuidedAction> diffCallback
)

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

Parameters
@Nullable DiffCallback<GuidedAction> diffCallback

DiffCallback used in setActions.

setButtonActions

Added in 1.1.0
Deprecated in 1.1.0
public void setButtonActions(@NonNull List<GuidedAction> actions)

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

Parameters
@NonNull List<GuidedAction> actions

The list of button GuidedActions for this fragment.

setSelectedActionPosition

Added in 1.1.0
Deprecated in 1.1.0
public void setSelectedActionPosition(int position)

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

Parameters
int position

The integer position of the action of interest.

setSelectedButtonActionPosition

Added in 1.1.0
Deprecated in 1.1.0
public void setSelectedButtonActionPosition(int position)

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

Parameters
int position

The integer position of the button action of interest.

setUiStyle

Added in 1.1.0
Deprecated in 1.1.0
public void setUiStyle(int style)

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

Protected methods

onAddSharedElementTransition

Added in 1.1.0
Deprecated in 1.1.0
protected void onAddSharedElementTransition(
    @NonNull FragmentTransaction ft,
    @NonNull GuidedStepFragment disappearing
)

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

Parameters
@NonNull FragmentTransaction ft

The FragmentTransaction to add shared element.

@NonNull GuidedStepFragment disappearing

The disappearing fragment.

onProvideFragmentTransitions

Added in 1.1.0
Deprecated in 1.1.0
protected void onProvideFragmentTransitions()

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