- updated version to 2.1.0 + README

- added missing JavaDoc
- fixed indentations

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:2.0.0'
+compile 'com.stepstone.stepper:material-stepper:2.1.0'
 ```
 
 ## Supported steppers
@@ -28,6 +28,7 @@ compile 'com.stepstone.stepper:material-stepper:2.0.0'
   - custom texts of individual widgets inside of the stepper via View attributes or a style from a theme
   - embedding the stepper anywhere in the view hierarchy and changing the stepper type for various device configurations, e.g. phone/tablet, portrait/landscape
   - step validation
+  - use with Fragments or Views
 
 ## Getting started
 
@@ -333,6 +334,8 @@ For other examples, e.g. persisting state on rotation, displaying errors, changi
 | *ms_completeButtonText*         | string or reference                       | COMPLETE button's text            |
 | *ms_tabStepDividerWidth*        | dimension or reference                    | The width of the horizontal tab divider used in tabs stepper type            |
 | *ms_showBackButtonOnFirstStep*  | boolean                                   | Flag indicating if the Back (Previous step) button should be shown on the first step. False by default.            |
+| *ms_showErrorState*             | boolean                                   | Flag indicating whether to show the error state. Only available with 'tabs' type. False by default. |
+| *ms_showErrorStateOnBack*       | boolean                                   | Flag indicating whether to keep showing the error state when user moves back. Only available with 'tabs' type. False by default. |
 
 ## Missing features
   - support for non-linear steppers

gradle.properties

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

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

@@ -339,17 +339,18 @@ public void setCompleteButtonVerificationFailed(boolean verificationFailed) {
     }
 
     /**
-
-     * Set whether when going backwards should clear the error state from the Tab. Default is false.
-     * @param mShowErrorStateOnBack
+     * Set whether when going backwards should clear the error state from the Tab. Default is <code>false</code>.
+     *
+     * @param mShowErrorStateOnBack true if navigating backwards should keep the error state, false otherwise
      */
     public void setShowErrorStateOnBack(boolean mShowErrorStateOnBack) {
         this.mShowErrorStateOnBack = mShowErrorStateOnBack;
     }
 
     /**
-     * Set whether the tab should display error or not. Default false.
-     * @param mShowErrorState
+     * Set whether the errors should be displayed when they occur or not. Default is <code>false</code>.
+     *
+     * @param mShowErrorState true if the errors should be displayed when they occur, false otherwise
      */
     public void setShowErrorState(boolean mShowErrorState) {
         this.mShowErrorState = mShowErrorState;
@@ -547,8 +548,9 @@ private void onNext() {
         }
 
         //if moving forward and got no errors, set hasError to false, so we can have the tab with the check mark.
-        if(mShowErrorState)
+        if (mShowErrorState) {
             mStepperType.setErrorStep(mCurrentStepPosition, false);
+        }
 
         OnNextClickedCallback onNextClickedCallback = new OnNextClickedCallback();
         if (step instanceof BlockingStep) {
@@ -573,9 +575,9 @@ private void onError(@NonNull VerificationError verificationError) {
             step.onError(verificationError);
 
             //if moving forward and got errors, set hasError to true, showing the error drawable.
-            if(mShowErrorState)
+            if (mShowErrorState) {
                 mStepperType.setErrorStep(mCurrentStepPosition, true);
-
+            }
         }
         mListener.onError(verificationError);
     }

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

@@ -17,12 +17,10 @@
 package com.stepstone.stepper.internal;
 
 import android.content.Context;
-import android.content.res.ColorStateList;
 import android.graphics.Typeface;
 import android.graphics.drawable.Drawable;
 import android.support.annotation.ColorInt;
 import android.support.v4.content.ContextCompat;
-import android.support.v4.graphics.drawable.DrawableCompat;
 import android.support.v7.widget.AppCompatImageView;
 import android.util.AttributeSet;
 import android.view.LayoutInflater;
@@ -92,6 +90,7 @@ public StepTab(Context context, AttributeSet attrs, int defStyleAttr) {
 
     /**
      * Changes the visibility of the horizontal line in the tab
+     *
      * @param show true if the line should be shown, false otherwise
      */
     public void toggleDividerVisibility(boolean show) {
@@ -100,13 +99,16 @@ public void toggleDividerVisibility(boolean show) {
 
     /**
      * Updates tab's UI
-     * @param done true if the step is done and the step's number should be replaced with a <i>done</i> icon, false otherwise
+     *
+     * @param done    true if the step is done and the step's number should be replaced with a <i>done</i> icon, false otherwise
+     * @param showErrorOnBack true if an error should be shown if verification failed, false otherwise
      * @param current true if the step is the current step, false otherwise
      */
     public void updateState(final boolean done, final boolean showErrorOnBack, final boolean current) {
         //if this tab has errors and the user decide not to clear when going backwards, simply ignore the update
-        if(this.hasError && showErrorOnBack)
+        if (this.hasError && showErrorOnBack) {
             return;
+        }
 
         mStepDoneIndicator.setVisibility(done ? View.VISIBLE : View.GONE);
         mStepNumber.setVisibility(!done ? View.VISIBLE : View.GONE);
@@ -122,16 +124,18 @@ public void updateState(final boolean done, final boolean showErrorOnBack, final
 
     /**
      * Update the error state of this tab. If it has error, show the error drawable.
+     *
+     * @param isLastStep whether this is the tab of the last step
      * @param hasError whether the tab has errors or not.
      */
-    public void updateErrorState(boolean done, boolean hasError) {
-        if(hasError) {
+    public void updateErrorState(boolean isLastStep, boolean hasError) {
+        if (hasError) {
             mStepDoneIndicator.setVisibility(View.GONE);
             mStepNumber.setVisibility(View.GONE);
             mStepErrorIndicator.setVisibility(VISIBLE);
             mStepErrorIndicator.setColorFilter(mErrorColor);
             mStepTitle.setTextColor(mErrorColor);
-        } else if(done) {
+        } else if (isLastStep) {
             mStepDoneIndicator.setVisibility(View.VISIBLE);
             mStepErrorIndicator.setVisibility(GONE);
             colorViewBackground(mStepDoneIndicator, true);
@@ -144,6 +148,7 @@ public void updateErrorState(boolean done, boolean hasError) {
 
     /**
      * Sets the name of the step
+     *
      * @param title step name
      */
     public void setStepTitle(CharSequence title) {
@@ -152,6 +157,7 @@ public void setStepTitle(CharSequence title) {
 
     /**
      * Sets the position of the step
+     *
      * @param number step position
      */
     public void setStepNumber(CharSequence number) {

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

@@ -49,6 +49,7 @@ public interface TabItemListener {
 
         /**
          * Called when a tab gets clicked
+         *
          * @param position position of the tab/step
          */
         @UiThread
@@ -144,6 +145,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<CharSequence> stepTitles) {
@@ -158,6 +160,7 @@ public void setSteps(List<CharSequence> stepTitles) {
 
     /**
      * Changes the position of the current step and updates the UI based on it.
+     *
      * @param newStepPosition new current step
      */
     public void setCurrentStep(int newStepPosition) {
@@ -175,20 +178,22 @@ public void setCurrentStep(int newStepPosition) {
 
     /**
      * Set whether when going backwards should clear the error state from the Tab. Default is false
-     * @param mShowErrorStateOnBack
+     *
+     * @param mShowErrorStateOnBack true if navigating backwards should keep the error state, false otherwise
      */
     public void setShowErrorStateOnBack(boolean mShowErrorStateOnBack) {
         this.mShowErrorStateOnBack = mShowErrorStateOnBack;
     }
 
-    public void setErrorStep(int stepPosition, boolean hasError){
-        if(mStepTitles.size() < stepPosition)
+    public void setErrorStep(int stepPosition, boolean hasError) {
+        if (mStepTitles.size() < stepPosition) {
             return;
+        }
 
         StepTab childTab = (StepTab) mTabsInnerContainer.getChildAt(stepPosition);
-        childTab.updateErrorState(mStepTitles.size() - 1 == stepPosition ,hasError);
+        childTab.updateErrorState(mStepTitles.size() - 1 == stepPosition, hasError);
     }
-  
+
     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));

material-stepper/src/main/java/com/stepstone/stepper/type/AbstractStepperType.java

@@ -63,7 +63,7 @@ public void setErrorStep(int stepPosition, boolean hasError){ }
 
     /**
      * Called to set whether navigating backwards should keep the error state.
-     * @param mShowErrorStateOnBack
+     * @param mShowErrorStateOnBack true if navigating backwards should keep the error state, false otherwise
      */
     public void showErrorStateOnBack(boolean mShowErrorStateOnBack){ }