Merge branch 'master' into error_back

Author: leonardo2204

README.md

@@ -11,7 +11,7 @@ Quoting the [documentation](https://www.google.com/design/spec/components/steppe
 
 ## Download (from JCenter)
 ```groovy
-compile 'com.stepstone.stepper:material-stepper:1.1.1'
+compile 'com.stepstone.stepper:material-stepper:2.0.0'
 ```
 
 ## Supported steppers
@@ -62,13 +62,6 @@ public class StepFragmentSample extends Fragment implements Step {
         return v;
     }
 
-    @Override
-    @StringRes
-    public int getName() {
-        //return string resource ID for the tab title used when StepperLayout is in tabs mode
-        return R.string.tab_title;
-    }
-
     @Override
     public VerificationError verifyStep() {
         //return null if the user can go to the next step, create a new VerificationError instance otherwise
@@ -88,15 +81,15 @@ public class StepFragmentSample extends Fragment implements Step {
 }
 ```
 
-### Extend AbstractStepAdapter
-AbstractStepAdapter extends [FragmentPagerAdapter](http://developer.android.com/reference/android/support/v4/app/FragmentPagerAdapter.html)
+### Extend AbstractFragmentStepAdapter
+AbstractFragmentStepAdapter extends [FragmentPagerAdapter](http://developer.android.com/reference/android/support/v4/app/FragmentPagerAdapter.html)
 but instead of overriding the method `getItem(int)` you must override the `createStep(int)` method.
 
 ```java
-public static class MyStepperAdapter extends AbstractStepAdapter {
+public static class MyStepperAdapter extends AbstractFragmentStepAdapter {
 
-    public MyStepperAdapter(FragmentManager fm) {
-        super(fm);
+    public MyStepperAdapter(FragmentManager fm, Context context) {
+        super(fm, context);
     }
 
     @Override
@@ -112,6 +105,15 @@ public static class MyStepperAdapter extends AbstractStepAdapter {
     public int getCount() {
         return 3;
     }
+
+    @NonNull
+    @Override
+    public StepViewModel getViewModel(@IntRange(from = 0) int position) {
+        //Override this method to set Step title for the Tabs, not necessary for other stepper types
+        return new StepViewModel.Builder(context)
+                .setTitle(R.string.tab_title) //can be a CharSequence instead
+                .create();
+    }
 }
 
 ```
@@ -128,7 +130,7 @@ public class StepperActivity extends AppCompatActivity {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.main);
         mStepperLayout = (StepperLayout) findViewById(R.id.stepperLayout);
-        mStepperLayout.setAdapter(new MyStepperAdapter(getSupportFragmentManager()));
+        mStepperLayout.setAdapter(new MyStepperAdapter(getSupportFragmentManager(), this));
     }
 }
 ```
@@ -238,24 +240,36 @@ public class DelayedTransitionStepFragmentSample extends Fragment implements Blo
 }
 ```
 
-### Changing the Next button text per step
-Sometimes you might want to have different labels on the Next button on different steps e.g. use the default label on the first few steps,
+### Changing Back/Next button labels per step
+Sometimes you might want to have different labels on the Next and/or Back navigation buttons on different steps e.g. use the default labels on the first few steps,
 but display 'Summary' just before the last page.
 <p><img src ="./gifs/different-next-buttons.gif" width="360" height="640"/></p>
-In such case you need to override the `getNextButtonText(int)` method in the `AbstractStepAdapter` e.g.
+In such case you need to override the `getViewModel(int)` method from the `StepAdapter` e.g.
 ```java
-        @StringRes
-        @Override
-        public int getNextButtonText(int position) {
-            switch (position) {
-                case 0:
-                    return R.string.ms_next;
-                case 1:
-                    return R.string.go_to_summary;
-                default:
-                    throw new IllegalArgumentException("Unsupported position: " + position);
-            }
+    @NonNull
+    @Override
+    public StepViewModel getViewModel(@IntRange(from = 0) int position) {
+        StepViewModel.Builder builder = new StepViewModel.Builder(context)
+                .setTitle(R.string.tab_title);
+        switch (position) {
+            case 0:
+                builder
+                        .setNextButtonLabel("This way")
+                        .setBackButtonLabel("Go to first");
+                break;
+            case 1:
+                builder
+                        .setNextButtonLabel(R.string.go_to_summary)
+                        .setBackButtonLabel("Go to first");
+                break;
+            case 2:
+                builder.setBackButtonLabel("Go back");
+                break;
+            default:
+                throw new IllegalArgumentException("Unsupported position: " + position);
         }
+        return builder.create();
+    }
 ```
 
 ### Using the same stepper styling across the application
@@ -293,6 +307,11 @@ This behaviour can be changed by setting ```ms_showBackButtonOnFirstStep``` to `
 ```
 To get a callback when this button was pressed you need set a ```StepperListener``` and write your own custom return logic in the ```onReturn()``` method to e.g. close the Activity.
 
+### Using with Views instead of Fragments
+It is possible to use this library without the need to rely on Fragments.
+To do so you need to use ```AbstractStepAdapter``` instead of ```AbstractFragmentStepAdapter```.
+For an example of how to use it with views please see the sample app.
+
 ### Advanced usage
 For other examples, e.g. persisting state on rotation, displaying errors, changing whether the user can go to the next step, etc. check out the sample app.
 

build.gradle

@@ -20,10 +20,10 @@ configure(allprojects) {
     /* Android config and dependency versions */
     ext {
         androidMinSdkVersion 		        = 14
-        androidTargetSdkVersion             = 24
-        androidCompileSdkVersion            = 24
+        androidTargetSdkVersion             = 25
+        androidCompileSdkVersion            = 25
         androidBuildToolsVersion            = "25.0.2"
-        androidSupportLibraryVersion        = "25.0.0"
+        androidSupportLibraryVersion        = "25.1.0"
 
         /* Sample only */
         butterknifeVersion                  = "7.0.1"

gradle.properties

@@ -19,4 +19,4 @@
 
 POM_GROUP_ID=com.stepstone.stepper
 POM_ARTIFACT_ID=material-stepper
-POM_VERSION=1.1.1
+POM_VERSION=2.0.0

material-stepper/src/main/java/com/stepstone/stepper/Step.java

@@ -17,19 +17,12 @@
 package com.stepstone.stepper;
 
 import android.support.annotation.NonNull;
-import android.support.annotation.StringRes;
 
 /**
  * A base step interface which all {@link StepperLayout} steps must implement.
  */
 public interface Step {
 
-    /**
-     * Returns a String resource ID for the displayable name of the step.
-     * @return a String resource ID for the displayable name of the step
-     */
-    @StringRes int getName();
-
     /**
      * Checks if the stepper can go to the next step after this step.<br>
      * <b>This does not mean the user clicked on the Next/Complete button.</b><br>

material-stepper/src/main/java/com/stepstone/stepper/StepperLayout.java

@@ -50,6 +50,7 @@
 import com.stepstone.stepper.type.TabsStepperType;
 import com.stepstone.stepper.util.AnimationUtil;
 import com.stepstone.stepper.util.TintUtil;
+import com.stepstone.stepper.viewmodel.StepViewModel;
 
 /**
  * Stepper widget implemented according to the <a href="https://www.google.com/design/spec/components/steppers.html">Material documentation</a>.<br>
@@ -338,6 +339,7 @@ public void setCompleteButtonVerificationFailed(boolean verificationFailed) {
     }
 
     /**
+
      * Set whether when going backwards should clear the error state from the Tab. Default is false.
      * @param mShowErrorStateOnBack
      */
@@ -351,6 +353,17 @@ public void setShowErrorStateOnBack(boolean mShowErrorStateOnBack) {
      */
     public void setShowErrorState(boolean mShowErrorState) {
         this.mShowErrorState = mShowErrorState;
+      
+     /**
+     * Set the number of steps that should be retained to either side of the
+     * current step in the view hierarchy in an idle state. Steps beyond this
+     * limit will be recreated from the adapter when needed.
+     *
+     * @param limit How many steps will be kept offscreen in an idle state.
+     * @see ViewPager#setOffscreenPageLimit(int)
+     */
+    public void setOffscreenPageLimit(int limit) {
+        mPager.setOffscreenPageLimit(limit);
     }
 
     private void init(AttributeSet attrs, @AttrRes int defStyleAttr) {
@@ -576,19 +589,18 @@ private void onComplete(View completeButton) {
 
     private void onUpdate(int newStepPosition, boolean animate) {
         mPager.setCurrentItem(newStepPosition);
-        boolean isLast = isLastPosition(newStepPosition);
-        boolean isFirst = newStepPosition == 0;
+        final boolean isLast = isLastPosition(newStepPosition);
+        final boolean isFirst = newStepPosition == 0;
         AnimationUtil.fadeViewVisibility(mNextNavigationButton, isLast ? View.GONE : View.VISIBLE, animate);
         AnimationUtil.fadeViewVisibility(mCompleteNavigationButton, !isLast ? View.GONE : View.VISIBLE, animate);
         AnimationUtil.fadeViewVisibility(mBackNavigationButton, isFirst && !mShowBackButtonOnFirstStep ? View.GONE : View.VISIBLE, animate);
 
+        final StepViewModel viewModel = mStepAdapter.getViewModel(newStepPosition);
+
+        updateBackButtonText(viewModel);
+
         if (!isLast) {
-            int nextButtonTextForStep = mStepAdapter.getNextButtonText(newStepPosition);
-            if (nextButtonTextForStep == StepAdapter.DEFAULT_NEXT_BUTTON_TEXT) {
-                mNextNavigationButton.setText(mNextButtonText);
-            } else {
-                mNextNavigationButton.setText(nextButtonTextForStep);
-            }
+            updateNextButtonText(viewModel);
         }
 
         //needs to be here in case user for any reason decide to change whether or not to show errors when going back.
@@ -603,4 +615,22 @@ private void onUpdate(int newStepPosition, boolean animate) {
             step.onSelected();
         }
     }
+
+    private void updateNextButtonText(@NonNull StepViewModel viewModel) {
+        CharSequence nextButtonTextForStep = viewModel.getNextButtonLabel();
+        if (nextButtonTextForStep == null) {
+            mNextNavigationButton.setText(mNextButtonText);
+        } else {
+            mNextNavigationButton.setText(nextButtonTextForStep);
+        }
+    }
+
+    private void updateBackButtonText(@NonNull StepViewModel viewModel) {
+        CharSequence backButtonTextForStep = viewModel.getBackButtonLabel();
+        if (backButtonTextForStep == null) {
+            mBackNavigationButton.setText(mBackButtonText);
+        } else {
+            mBackNavigationButton.setText(backButtonTextForStep);
+        }
+    }
 }

material-stepper/src/main/java/com/stepstone/stepper/adapter/AbstractFragmentStepAdapter.java

@@ -16,14 +16,17 @@
 
 package com.stepstone.stepper.adapter;
 
-import android.support.annotation.StringRes;
+import android.content.Context;
+import android.support.annotation.IntRange;
+import android.support.annotation.NonNull;
 import android.support.v4.app.Fragment;
 import android.support.v4.app.FragmentManager;
 import android.support.v4.app.FragmentPagerAdapter;
 import android.support.v4.view.PagerAdapter;
 import android.support.v4.view.ViewPager;
 
 import com.stepstone.stepper.Step;
+import com.stepstone.stepper.viewmodel.StepViewModel;
 
 /**
  * A base adapter class which returns step fragments to use inside of the {@link com.stepstone.stepper.StepperLayout}.
@@ -32,29 +35,35 @@ public abstract class AbstractFragmentStepAdapter
         extends FragmentPagerAdapter
         implements StepAdapter {
 
+    @NonNull
     private final FragmentManager mFragmentManager;
 
-    public AbstractFragmentStepAdapter(FragmentManager fm) {
+    @NonNull
+    protected final Context context;
+
+    public AbstractFragmentStepAdapter(@NonNull FragmentManager fm, @NonNull Context context) {
         super(fm);
-        mFragmentManager = fm;
+        this.mFragmentManager = fm;
+        this.context = context;
     }
 
     @Override
-    public final Fragment getItem(int position) {
+    public final Fragment getItem(@IntRange(from = 0) int position) {
         return (Fragment) createStep(position);
     }
 
     /** {@inheritDoc} */
     @SuppressWarnings("unchecked")
-    public Step findStep(ViewPager viewPager, int position) {
+    public Step findStep(ViewPager viewPager, @IntRange(from = 0) int position) {
         String fragmentTag =  "android:switcher:" + viewPager.getId() + ":" + this.getItemId(position);
         return (Step) mFragmentManager.findFragmentByTag(fragmentTag);
     }
 
     /** {@inheritDoc} */
-    @StringRes
-    public int getNextButtonText(int position) {
-        return DEFAULT_NEXT_BUTTON_TEXT;
+    @NonNull
+    @Override
+    public StepViewModel getViewModel(@IntRange(from = 0) int position) {
+        return new StepViewModel.Builder(context).create();
     }
 
     /** {@inheritDoc} */

material-stepper/src/main/java/com/stepstone/stepper/adapter/AbstractStepAdapter.java

@@ -1,18 +1,33 @@
 package com.stepstone.stepper.adapter;
 
+import android.content.Context;
+import android.support.annotation.IntRange;
+import android.support.annotation.NonNull;
 import android.support.v4.view.PagerAdapter;
 
+import com.stepstone.stepper.viewmodel.StepViewModel;
+
 /**
  * A base adapter class which returns step to use inside of the {@link com.stepstone.stepper.StepperLayout}.
  * This class is intended to be inherited if you need to use {@link com.stepstone.stepper.StepperLayout} without fragments.
  * Otherwise, you should use {@link AbstractFragmentStepAdapter}
  */
-public abstract class AbstractStepAdapter extends PagerAdapter implements StepAdapter {
+public abstract class AbstractStepAdapter
+        extends PagerAdapter
+        implements StepAdapter {
+
+    @NonNull
+    protected final Context context;
+
+    public AbstractStepAdapter(@NonNull Context context) {
+        this.context = context;
+    }
 
     /** {@inheritDoc} */
+    @NonNull
     @Override
-    public int getNextButtonText(int position) {
-        return DEFAULT_NEXT_BUTTON_TEXT;
+    public StepViewModel getViewModel(@IntRange(from = 0) int position) {
+        return new StepViewModel.Builder(context).create();
     }
 
     /** {@inheritDoc} */