- moved Fragment display info from Step to StepViewModel which is used in StepAdapter

- added an option to use CharSequence for Step titles and button titles

Author: Piotr Zawadzki

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
@@ -128,7 +121,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));
     }
 }
 ```
@@ -239,6 +232,7 @@ public class DelayedTransitionStepFragmentSample extends Fragment implements Blo
 ```
 
 ### Changing the Next button text per step
+<b>TODO update + add tutorial for Back button</b>
 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,
 but display 'Summary' just before the last page.
 <p><img src ="./gifs/different-next-buttons.gif" width="360" height="640"/></p>
@@ -293,6 +287,9 @@ 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
+<b>TODO: document</b>
+
 ### 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

@@ -538,8 +538,8 @@ private void onUpdate(int newStepPosition, boolean animate) {
         AnimationUtil.fadeViewVisibility(mBackNavigationButton, isFirst && !mShowBackButtonOnFirstStep ? View.GONE : View.VISIBLE, animate);
 
         if (!isLast) {
-            int nextButtonTextForStep = mStepAdapter.getNextButtonText(newStepPosition);
-            if (nextButtonTextForStep == StepAdapter.DEFAULT_NEXT_BUTTON_TEXT) {
+            CharSequence nextButtonTextForStep = mStepAdapter.getViewModel(newStepPosition).getNextButtonLabel();
+            if (nextButtonTextForStep == null) {
                 mNextNavigationButton.setText(mNextButtonText);
             } else {
                 mNextNavigationButton.setText(nextButtonTextForStep);

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} */

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

@@ -1,25 +1,25 @@
 package com.stepstone.stepper.adapter;
 
-import android.support.annotation.StringRes;
+import android.support.annotation.IntRange;
+import android.support.annotation.NonNull;
 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;
 
 /**
  * Interface to be used as model to {@link com.stepstone.stepper.StepperLayout}.
  */
 public interface StepAdapter {
 
-    int DEFAULT_NEXT_BUTTON_TEXT = -1;
-
     /**
      * Create each step of the {@link com.stepstone.stepper.StepperLayout}.
      * @param position The position of the {@link PagerAdapter} to be used inside the {@link ViewPager}.
      * @return the step to be used inside the {@link com.stepstone.stepper.StepperLayout}.
      */
-    Step createStep(int position);
+    Step createStep(@IntRange(from = 0) int position);
 
     /**
      * Finds the given step without creating it.
@@ -28,24 +28,21 @@ public interface StepAdapter {
      * @param position step position
      * @return step fragment
      */
-    Step findStep(ViewPager viewPager, int position);
+    Step findStep(ViewPager viewPager, @IntRange(from = 0) int position);
 
     /**
-     * Allows to override the text on the Next button per step.
-     * For a given step position you need to return a String resource ID for the label to be used.
-     * If you wish to change the text for selected steps only (and leave the default for the rest)
-     * then return {@link #DEFAULT_NEXT_BUTTON_TEXT} for the default ones.
-     * By default this method returns {@link #DEFAULT_NEXT_BUTTON_TEXT} for all steps.
-     * This method is not invoked for the last step.
+     * Returns the view information to be used to display the step.
      * @param position step position
-     * @return a String resource ID to override the default button text or {@link #DEFAULT_NEXT_BUTTON_TEXT} if the default text should be kept
+     * @return view information
      */
-    @StringRes int getNextButtonText(int position);
+    @NonNull
+    StepViewModel getViewModel(@IntRange(from = 0) int position);
 
     /**
      * Get the step count.
      * @return the quantity of steps
      */
+    @IntRange(from = 0)
     int getCount();
 
     /**

material-stepper/src/main/java/com/stepstone/stepper/internal/StepTab.java

@@ -20,7 +20,6 @@
 import android.graphics.Typeface;
 import android.graphics.drawable.Drawable;
 import android.support.annotation.ColorInt;
-import android.support.annotation.StringRes;
 import android.support.v4.content.ContextCompat;
 import android.util.AttributeSet;
 import android.view.LayoutInflater;
@@ -109,14 +108,6 @@ public void setStepTitle(CharSequence title) {
         mStepTitle.setText(title);
     }
 
-    /**
-     * Sets the name of the step
-     * @param title resource ID of the step name
-     */
-    public void setStepTitle(@StringRes int title) {
-        mStepTitle.setText(title);
-    }
-
     /**
      * Sets the position of the step
      * @param number step position

material-stepper/src/main/java/com/stepstone/stepper/internal/TabsContainer.java

@@ -20,7 +20,7 @@
 import android.content.res.TypedArray;
 import android.support.annotation.ColorInt;
 import android.support.annotation.NonNull;
-import android.support.annotation.StringRes;
+import android.support.annotation.Nullable;
 import android.support.annotation.UiThread;
 import android.support.v4.content.ContextCompat;
 import android.util.AttributeSet;
@@ -77,7 +77,7 @@ public void onTabClicked(int position) {
 
     private TabItemListener mListener = TabItemListener.NULL;
 
-    private List<Integer> mStepTitles;
+    private List<CharSequence> mStepTitles;
 
     public TabsContainer(Context context) {
         this(context, null);
@@ -132,7 +132,7 @@ public void setListener(@NonNull TabItemListener listener) {
      * Sets the steps to display in the {@link TabsContainer}.
      * @param stepTitles a list of tab titles
      */
-    public void setSteps(List<Integer> stepTitles) {
+    public void setSteps(List<CharSequence> stepTitles) {
         this.mStepTitles = stepTitles;
 
         mTabsInnerContainer.removeAllViews();
@@ -159,7 +159,7 @@ public void setCurrentStep(int newStepPosition) {
         }
     }
 
-    private View createStepTab(final int position, @StringRes int title) {
+    private View createStepTab(final int position, @Nullable CharSequence title) {
         StepTab view = (StepTab) LayoutInflater.from(getContext()).inflate(R.layout.ms_step_tab_container, mTabsInnerContainer, false);
         view.setStepNumber(String.valueOf(position + 1));
         view.toggleDividerVisibility(!isLastPosition(position));