Lines Matching defs:GuidedStepFragment
60 * A GuidedStepFragment is used to guide the user through a decision or series of decisions.
66 * Clients of GuidedStepFragment must create a custom subclass to attach to their Activities.
75 * Clients use following helper functions to add GuidedStepFragment to Activity or FragmentManager:
77 * <li>{@link #addAsRoot(Activity, GuidedStepFragment, int)}, to be called during Activity onCreate,
78 * adds GuidedStepFragment as the first Fragment in activity.</li>
79 * <li>{@link #add(FragmentManager, GuidedStepFragment)} or {@link #add(FragmentManager,
80 * GuidedStepFragment, int)}, to add GuidedStepFragment on top of existing Fragments or
81 * replacing existing GuidedStepFragment when moving forward to next step.</li>
83 * GuidedStepFragment from stack.
90 * GuidedStepFragment delegates its visual styling to classes called stylists. The {@link
107 * this theme will be used by GuidedStepFragment as an overlay to the Activity's theme.</li>
108 * <li>Finally, custom subclasses of GuidedStepFragment may provide a theme through the {@link
118 * provided to the GuidedStepFragment through the {@link #onCreateGuidanceStylist} and {@link
148 public class GuidedStepFragment extends Fragment implements GuidedActionAdapter.FocusListener {
165 * <li>{@link #addAsRoot(Activity, GuidedStepFragment, int)} sets to
167 * <li>{@link #add(FragmentManager, GuidedStepFragment)} or {@link #add(FragmentManager,
168 * GuidedStepFragment, int)} sets it to {@link #UI_STYLE_REPLACE} if there is already a
169 * GuidedStepFragment on stack.</li>
170 * <li>{@link #finishGuidedStepFragments()} changes current GuidedStepFragment to
173 * GuidedStepFragment run a return transition of {@link #UI_STYLE_ENTRANCE}</li>
186 * This is the case that we use GuidedStepFragment to replace another existing
187 * GuidedStepFragment when moving forward to next step. Default behavior of this style is:
204 * GuidedStepFragment constructor. This is the case that we show GuidedStepFragment on top of
212 * When popping multiple GuidedStepFragment, {@link #finishGuidedStepFragments()} also changes
213 * the top GuidedStepFragment to UI_STYLE_ENTRANCE in order to run the return transition
220 * GuidedStepFragment in a separate activity. The default behavior of this style:
273 public GuidedStepFragment() {
470 * Adds the specified GuidedStepFragment to the fragment stack, replacing any existing
474 * <li>If current fragment on stack is GuidedStepFragment: assign {@link #UI_STYLE_REPLACE}
475 * <li>If current fragment on stack is not GuidedStepFragment: assign {@link #UI_STYLE_ENTRANCE}
480 * @param fragment The GuidedStepFragment to be inserted into the fragment stack.
483 public static int add(FragmentManager fragmentManager, GuidedStepFragment fragment) {
488 * Adds the specified GuidedStepFragment to the fragment stack, replacing any existing
492 * <li>If current fragment on stack is GuidedStepFragment: assign {@link #UI_STYLE_REPLACE} and
493 * {@link #onAddSharedElementTransition(FragmentTransaction, GuidedStepFragment)} will be called
495 * <li>If current fragment on stack is not GuidedStepFragment: assign {@link #UI_STYLE_ENTRANCE}
500 * @param fragment The GuidedStepFragment to be inserted into the fragment stack.
501 * @param id The id of container to add GuidedStepFragment, can be android.R.id.content.
504 public static int add(FragmentManager fragmentManager, GuidedStepFragment fragment, int id) {
505 GuidedStepFragment current = getCurrentGuidedStepFragment(fragmentManager);
526 * when the GuidedStepFragment replacing an existing GuidedStepFragment). Default implementation
528 * change from disappearing GuidedStepFragment into this GuidedStepFragment. The default
537 protected void onAddSharedElementTransition(FragmentTransaction ft, GuidedStepFragment
568 * Returns BackStackEntry name for the GuidedStepFragment or empty String if no entry is
571 * @return BackStackEntry name for the GuidedStepFragment or empty String if no entry is
579 * Generates BackStackEntry name for GuidedStepFragment class or empty String if no entry is
582 * @return BackStackEntry name for the GuidedStepFragment or empty String if no entry is
598 * Returns true if the backstack entry represents GuidedStepFragment with
599 * {@link #UI_STYLE_ENTRANCE}, i.e. this is the first GuidedStepFragment pushed to stack; false
603 * @return True if the backstack represents GuidedStepFragment with {@link #UI_STYLE_ENTRANCE};
613 * @return Class name of GuidedStepFragment.
626 * Adds the specified GuidedStepFragment as content of Activity; no backstack entry is added so
636 * @param fragment The GuidedStepFragment to be inserted into the fragment stack.
637 * @param id The id of container to add GuidedStepFragment, can be android.R.id.content.
639 * GuidedStepFragment.
641 public static int addAsRoot(Activity activity, GuidedStepFragment fragment, int id) {
656 * Returns the current GuidedStepFragment on the fragment transaction stack.
657 * @return The current GuidedStepFragment, if any, on the fragment transaction stack.
659 public static GuidedStepFragment getCurrentGuidedStepFragment(FragmentManager fm) {
661 if (f instanceof GuidedStepFragment) {
662 return (GuidedStepFragment) f;
826 * GuidedStepFragment uses
970 * determine if this is the first GuidedStepFragment on backstack. In most cases app does not
972 * {@link #add(FragmentManager, GuidedStepFragment, int)}. However if the app creates Fragment
1000 * animations and determine if this is the first GuidedStepFragment on backstack.
1096 return GuidedStepFragment.this.onGuidedActionEditedAndProceed(action);
1101 GuidedStepFragment.this.onGuidedActionEditCanceled(action);
1108 GuidedStepFragment.this.onGuidedActionClicked(action);
1120 GuidedStepFragment.this.onGuidedActionClicked(action);
1129 if (GuidedStepFragment.this.onSubGuidedActionClicked(action)) {
1155 Context ctx = mThemeWrapper != null ? mThemeWrapper : FragmentUtil.getContext(GuidedStepFragment.this);
1265 * Note that this method must be paired with {@link #add(FragmentManager, GuidedStepFragment,
1275 GuidedStepFragment top = getCurrentGuidedStepFragment(fragmentManager);
1290 * @param guidedStepFragmentClass Name of the Class of GuidedStepFragment to pop to.
1294 if (!GuidedStepFragment.class.isAssignableFrom(guidedStepFragmentClass)) {
1313 * Returns true if allows focus out of start edge of GuidedStepFragment, false otherwise.
1315 * beneath content of GuidedStepFragment. Subclass may override.
1316 * @return True if allows focus out of start edge of GuidedStepFragment.
1323 * Returns true if allows focus out of end edge of GuidedStepFragment, false otherwise.
1325 * beneath content of GuidedStepFragment. Subclass may override.
1326 * @return True if allows focus out of end edge of GuidedStepFragment.
1362 Context context = FragmentUtil.getContext(GuidedStepFragment.this);
1382 Log.e(TAG, "GuidedStepFragment does not have an appropriate theme set.");