Added an option to set Complete button text programmatically via StepViewModel

Author: Piotr Zawadzki

README.md

@@ -257,7 +257,7 @@ public class DelayedTransitionStepFragmentSample extends Fragment implements Blo
 ```
 
 ### Changing button labels & compound drawables 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,
+Sometimes you might want to have different labels on the Next/Complete 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.
 You might also want to use your custom icons instead of the default navigation button compound drawables or not show the compound drawables for some of the buttons.
 <p><img src ="./gifs/custom-navigation-buttons.gif" width="360" /></p>
@@ -284,7 +284,9 @@ In such case you need to override the `getViewModel(int)` method from the `StepA
                     .setBackButtonStartDrawableResId(R.drawable.ms_back_arrow);
                 break;
             case 2:
-                builder.setBackButtonLabel("Go back");
+                builder
+                    .setBackButtonLabel("Go back")
+                    .setCompleteButtonLabel("I'm done!");
                 break;
             default:
                 throw new IllegalArgumentException("Unsupported position: " + position);
@@ -293,8 +295,6 @@ In such case you need to override the `getViewModel(int)` method from the `StepA
     }
 ```
 
-NOTE: To change Complete button's label you need use `ms_completeButtonText` attribute from StepperLayout.
-
 ### Custom styling
 Basic styling can be done by choosing the active and inactive step colors. 
 There are some additional properties which can be changed directly from StepperLayout's attributes e.g. the background of bottom navigation buttons (see [StepperLayout attributes](#stepperlayout-attributes))

build.gradle

@@ -1,6 +1,6 @@
 buildscript {
-    ext.gradleAndroidVersion        = '2.3.2'
-    ext.kotlinVersion               = '1.1.2-3'
+    ext.gradleAndroidVersion        = '2.3.3'
+    ext.kotlinVersion               = '1.1.3-2'
     ext.bintrayVersion              = '1.4'
     ext.mavenGradlePluginVersion    = '1.4.1'
 

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

@@ -896,6 +896,8 @@ private void onUpdate(int newStepPosition, boolean userTriggeredChange) {
 
         if (!isLast) {
             updateNextButton(viewModel);
+        } else {
+            updateCompleteButton(viewModel);
         }
 
         setCompoundDrawablesForNavigationButtons(viewModel.getBackButtonStartDrawableResId(), viewModel.getNextButtonEndDrawableResId());
@@ -908,6 +910,15 @@ private void onUpdate(int newStepPosition, boolean userTriggeredChange) {
         }
     }
 
+    private void updateCompleteButton(@NonNull StepViewModel viewModel) {
+        CharSequence completeButtonTextForStep = viewModel.getCompleteButtonLabel();
+        if (completeButtonTextForStep == null) {
+            mCompleteNavigationButton.setText(mCompleteButtonText);
+        } else {
+            mCompleteNavigationButton.setText(completeButtonTextForStep);
+        }
+    }
+
     private void updateNextButton(@NonNull StepViewModel viewModel) {
         CharSequence nextButtonTextForStep = viewModel.getNextButtonLabel();
         if (nextButtonTextForStep == null) {

material-stepper/src/main/java/com/stepstone/stepper/viewmodel/StepViewModel.java

@@ -41,6 +41,15 @@ private StepViewModel() {}
     @Nullable
     private CharSequence mNextButtonLabel;
 
+    /**
+     * Allows to override the text on the Complete button for this step.
+     * This step has to be the last step for this to have any effect.
+     * To do so you need to return a non-null String of the label.
+     * By default this is {@code null}.
+     */
+    @Nullable
+    private CharSequence mCompleteButtonLabel;
+
     /**
      * Allows to override the text on the Back button for this step.
      * To do so you need to return a non-null String of the label.
@@ -75,6 +84,11 @@ public CharSequence getNextButtonLabel() {
         return mNextButtonLabel;
     }
 
+    @Nullable
+    public CharSequence getCompleteButtonLabel() {
+        return mCompleteButtonLabel;
+    }
+
     @Nullable
     public CharSequence getBackButtonLabel() {
         return mBackButtonLabel;
@@ -101,6 +115,9 @@ public static class Builder {
         @Nullable
         private CharSequence mNextButtonLabel;
 
+        @Nullable
+        private CharSequence mCompleteButtonLabel;
+
         @Nullable
         private CharSequence mBackButtonLabel;
 
@@ -163,6 +180,28 @@ public Builder setNextButtonLabel(@Nullable CharSequence nextButtonLabel) {
             return this;
         }
 
+        /**
+         * Set the label of the complete button using the given resource id.
+         *
+         * @param completeButtonLabelId string resource ID for the Complete button
+         * @return This Builder object to allow for chaining of calls to set methods
+         */
+        public Builder setCompleteButtonLabel(@StringRes int completeButtonLabelId) {
+            this.mCompleteButtonLabel = mContext.getString(completeButtonLabelId);
+            return this;
+        }
+
+        /**
+         * Set the label of the complete button.
+         *
+         * @param completeButtonLabel CharSequence to be used as a Complete button label
+         * @return This Builder object to allow for chaining of calls to set methods
+         */
+        public Builder setCompleteButtonLabel(@Nullable CharSequence completeButtonLabel) {
+            this.mCompleteButtonLabel = completeButtonLabel;
+            return this;
+        }
+
         /**
          * Set the label of the back button using the given resource id.
          *
@@ -217,6 +256,7 @@ public StepViewModel create() {
             viewModel.mTitle = this.mTitle;
             viewModel.mBackButtonLabel = this.mBackButtonLabel;
             viewModel.mNextButtonLabel = this.mNextButtonLabel;
+            viewModel.mCompleteButtonLabel = this.mCompleteButtonLabel;
             viewModel.mNextButtonEndDrawableResId = this.mNextButtonEndDrawableResId;
             viewModel.mBackButtonStartDrawableResId = this.mBackButtonStartDrawableResId;
             return viewModel;

material-stepper/src/test/java/com/stepstone/stepper/test/assertion/StepViewModelAssert.kt

@@ -0,0 +1,50 @@
+package com.stepstone.stepper.test.assertion
+
+import com.stepstone.stepper.viewmodel.StepViewModel
+import org.assertj.core.api.AbstractAssert
+import org.junit.Assert.assertEquals
+
+/**
+ * @author Piotr Zawadzki
+ */
+class StepViewModelAssert constructor(actual: StepViewModel) : AbstractAssert<StepViewModelAssert, StepViewModel>(actual, StepViewModelAssert::class.java) {
+
+    companion object {
+
+        fun assertThat(actual: StepViewModel): StepViewModelAssert {
+            return StepViewModelAssert(actual)
+        }
+
+    }
+
+    fun hasTitle(title: CharSequence?): StepViewModelAssert {
+        assertEquals("Incorrect title!", title, actual.title)
+        return this
+    }
+
+    fun hasNextButtonLabel(nextButtonLabel: CharSequence?): StepViewModelAssert {
+        assertEquals("Incorrect label for the Next button!", nextButtonLabel, actual.nextButtonLabel)
+        return this
+    }
+
+    fun hasCompleteButtonLabel(completeButtonLabel: CharSequence?): StepViewModelAssert {
+        assertEquals("Incorrect label for the Complete button!", completeButtonLabel, actual.completeButtonLabel)
+        return this
+    }
+
+    fun hasBackButtonLabel(backButtonLabel: CharSequence?): StepViewModelAssert {
+        assertEquals("Incorrect label for the Back button!", backButtonLabel, actual.backButtonLabel)
+        return this
+    }
+
+    fun hasNextButtonEndDrawableResId(nextButtonEndDrawableResId: Int): StepViewModelAssert {
+        assertEquals("Incorrect drawable resource id for the Next button!", nextButtonEndDrawableResId, actual.nextButtonEndDrawableResId)
+        return this
+    }
+
+    fun hasBackButtonStartDrawableResId(backButtonStartDrawableResId: Int): StepViewModelAssert {
+        assertEquals("Incorrect drawable resource id for the Back button!", backButtonStartDrawableResId, actual.backButtonStartDrawableResId)
+        return this
+    }
+
+}