GuidedStepFragment

EXTRA_UI_STYLE

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(Activity, GuidedStepFragment, int) sets to UI_STYLE_ACTIVITY_ROOT
• add(FragmentManager, GuidedStepFragment) or add(FragmentManager, GuidedStepFragment, int) sets it to UI_STYLE_REPLACE if there is already a GuidedStepFragment on stack.
• finishGuidedStepFragments() changes current GuidedStepFragment to UI_STYLE_ENTRANCE for the non activity case. This is a special case that changes the transition settings after fragment has been created, in order to force current GuidedStepFragment run a return transition of UI_STYLE_ENTRANCE

Argument value can be either:

• UI_STYLE_REPLACE
• UI_STYLE_ENTRANCE
• UI_STYLE_ACTIVITY_ROOT

Constant Value: "uiStyle"

UI_STYLE_ACTIVITY_ROOT

int UI_STYLE_ACTIVITY_ROOT

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

Constant Value: 2 (0x00000002)

UI_STYLE_DEFAULT

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

int UI_STYLE_ENTRANCE

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

Constant Value: 1 (0x00000001)

UI_STYLE_REPLACE

int UI_STYLE_REPLACE

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.

Constant Value: 0 (0x00000000)

GuidedStepFragment

GuidedStepFragment ()

add

int add (FragmentManager fragmentManager, 
                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.

add

int add (FragmentManager fragmentManager, 
                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.

addAsRoot

int addAsRoot (Activity activity, 
                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.

collapseAction

void collapseAction (boolean withTransition)

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

collapseSubActions

void collapseSubActions ()

Collapse sub actions list.

expandAction

void expandAction (GuidedAction action, 
                boolean withTransition)

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

expandSubActions

void expandSubActions (GuidedAction action)

Expand a given action's sub actions list.

findActionById

GuidedAction findActionById (long id)

Find GuidedAction by Id.

findActionPositionById

int findActionPositionById (long id)

Find GuidedAction position in array by Id.

findButtonActionById

GuidedAction findButtonActionById (long id)

Find button GuidedAction by Id.

findButtonActionPositionById

int findButtonActionPositionById (long id)

Find button GuidedAction position in array by Id.

finishGuidedStepFragments

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

getActionItemView

View getActionItemView (int position)

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

getActions

List<GuidedAction> getActions ()

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

getButtonActionItemView

View getButtonActionItemView (int position)

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

getButtonActions

List<GuidedAction> getButtonActions ()

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

getCurrentGuidedStepFragment

GuidedStepFragment getCurrentGuidedStepFragment (FragmentManager fm)

Returns the current GuidedStepFragment on the fragment transaction stack.

getGuidanceStylist

GuidanceStylist getGuidanceStylist ()

Returns the GuidanceStylist that displays guidance information for the user.

getGuidedActionsStylist

GuidedActionsStylist getGuidedActionsStylist ()

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

getGuidedButtonActionsStylist

GuidedActionsStylist getGuidedButtonActionsStylist ()

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

getSelectedActionPosition

int getSelectedActionPosition ()

Returns the position if the currently selected GuidedAction.

getSelectedButtonActionPosition

int getSelectedButtonActionPosition ()

Returns the position if the currently selected button GuidedAction.

getUiStyle

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

boolean isExpanded ()

isFocusOutEndAllowed

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.

isFocusOutStartAllowed

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.

isSubActionsExpanded

boolean isSubActionsExpanded ()

notifyActionChanged

void notifyActionChanged (int position)

Notify an action has changed and update its UI.

notifyButtonActionChanged

void notifyButtonActionChanged (int position)

Notify an button action has changed and update its UI.

onCreateActions

void onCreateActions (List<GuidedAction> actions, 
                Bundle savedInstanceState)

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

onCreateActionsStylist

GuidedActionsStylist onCreateActionsStylist ()

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

onCreateBackgroundView

View onCreateBackgroundView (LayoutInflater inflater, 
                ViewGroup container, 
                Bundle savedInstanceState)

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

onCreateButtonActions

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

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

onCreateButtonActionsStylist

GuidedActionsStylist onCreateButtonActionsStylist ()

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

onCreateGuidance

GuidanceStylist.Guidance onCreateGuidance (Bundle savedInstanceState)

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

onCreateGuidanceStylist

GuidanceStylist onCreateGuidanceStylist ()

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

onGuidedActionClicked

void onGuidedActionClicked (GuidedAction action)

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

onGuidedActionEditCanceled

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

onGuidedActionEdited

void onGuidedActionEdited (GuidedAction action)

This method was deprecated in API level 24.1.0.
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

long onGuidedActionEditedAndProceed (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(GuidedAction) and returns ACTION_ID_NEXT.

onGuidedActionFocused

void onGuidedActionFocused (GuidedAction action)

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

onProvideTheme

int onProvideTheme ()

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

onSubGuidedActionClicked

boolean onSubGuidedActionClicked (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.

openInEditMode

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

popBackStackToGuidedStepFragment

void popBackStackToGuidedStepFragment (Class guidedStepFragmentClass, 
                int flags)

Convenient method to pop to fragment with Given class.

setActions

void setActions (List<GuidedAction> actions)

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

setActionsDiffCallback

void setActionsDiffCallback (DiffCallback<GuidedAction> diffCallback)

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

setButtonActions

void setButtonActions (List<GuidedAction> actions)

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

setSelectedActionPosition

void setSelectedActionPosition (int position)

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

setSelectedButtonActionPosition

void setSelectedButtonActionPosition (int position)

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

setUiStyle

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(FragmentManager, GuidedStepFragment, 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.

onAddSharedElementTransition

void onAddSharedElementTransition (FragmentTransaction ft, 
                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.

onProvideFragmentTransitions

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