Added error support

Author: leonardo2204

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

@@ -47,6 +47,7 @@
 import com.stepstone.stepper.internal.TabsContainer;
 import com.stepstone.stepper.type.AbstractStepperType;
 import com.stepstone.stepper.type.StepperTypeFactory;
+import com.stepstone.stepper.type.TabsStepperType;
 import com.stepstone.stepper.util.AnimationUtil;
 import com.stepstone.stepper.util.TintUtil;
 
@@ -204,6 +205,8 @@ public final void goToPrevStep() {
 
     private int mCurrentStepPosition;
 
+    private boolean mShowErrorStateOnBack;
+
     @NonNull
     private StepperListener mListener = StepperListener.NULL;
 
@@ -325,6 +328,14 @@ public void setCompleteButtonVerificationFailed(boolean verificationFailed) {
         mCompleteNavigationButton.setVerificationFailed(verificationFailed);
     }
 
+    /**
+     * Set whether when going backwards should clear the error state from the Tab. Default is false
+     * @param mShowErrorStateOnBack
+     */
+    public void setShowErrorStateOnBack(boolean mShowErrorStateOnBack) {
+        this.mShowErrorStateOnBack = mShowErrorStateOnBack;
+    }
+
     private void init(AttributeSet attrs, @AttrRes int defStyleAttr) {
         initDefaultValues();
         extractValuesFromAttributes(attrs, defStyleAttr);
@@ -455,6 +466,8 @@ private void extractValuesFromAttributes(AttributeSet attrs, @AttrRes int defSty
                 mTypeIdentifier = a.getInt(R.styleable.StepperLayout_ms_stepperType, DEFAULT_TAB_DIVIDER_WIDTH);
             }
 
+            mShowErrorStateOnBack = a.getBoolean(R.styleable.StepperLayout_ms_showErrorStateOnBack, false);
+
             a.recycle();
         }
     }
@@ -496,6 +509,11 @@ private void onNext() {
         if (verifyCurrentStep(step)) {
             return;
         }
+
+        //if moving forward and got no errors, set hasError to false, so we can have the tab with the check mark.
+        if(mStepperType instanceof TabsStepperType)
+            mTabsContainer.setErrorStep(mCurrentStepPosition, false);
+
         OnNextClickedCallback onNextClickedCallback = new OnNextClickedCallback();
         if (step instanceof BlockingStep) {
             ((BlockingStep) step).onNextClicked(onNextClickedCallback);
@@ -517,6 +535,11 @@ private void onError(@NonNull VerificationError verificationError) {
         Step step = findCurrentStep();
         if (step != null) {
             step.onError(verificationError);
+
+            //if moving forward and got errors, set hasError to true, showing the error drawable.
+            if(mStepperType instanceof TabsStepperType)
+                mTabsContainer.setErrorStep(mCurrentStepPosition, true);
+
         }
         mListener.onError(verificationError);
     }
@@ -546,6 +569,11 @@ private void onUpdate(int newStepPosition, boolean animate) {
             }
         }
 
+        //needs to be here in case user for any reason decide to change whether or not to show errors when going back.
+        if(mStepperType instanceof TabsStepperType) {
+            mTabsContainer.setShowErrorStateOnBack(mShowErrorStateOnBack);
+        }
+
         mStepperType.onStepSelected(newStepPosition);
         mListener.onStepSelected(newStepPosition);
         Step step = mStepAdapter.findStep(mPager, newStepPosition);

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

@@ -56,8 +56,12 @@ public class StepTab extends RelativeLayout {
 
     private final ImageView mStepDoneIndicator;
 
+    private final ImageView mStepErrorIndicator;
+
     private int mDividerWidth = StepperLayout.DEFAULT_TAB_DIVIDER_WIDTH;
 
+    private boolean hasError;
+
     public StepTab(Context context) {
         this(context, null);
     }
@@ -75,6 +79,7 @@ public StepTab(Context context, AttributeSet attrs, int defStyleAttr) {
 
         mStepNumber = (TextView) findViewById(R.id.ms_stepNumber);
         mStepDoneIndicator = (ImageView) findViewById(R.id.ms_stepDoneIndicator);
+        mStepErrorIndicator = (ImageView) findViewById(R.id.ms_stepErrorIndicator);
         mStepDivider = findViewById(R.id.ms_stepDivider);
         mStepTitle = ((TextView) findViewById(R.id.ms_stepTitle));
     }
@@ -92,15 +97,36 @@ public void toggleDividerVisibility(boolean show) {
      * @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 current true if the step is the current step, false otherwise
      */
-    public void updateState(final boolean done, final boolean current) {
+    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)
+            return;
+
         mStepDoneIndicator.setVisibility(done ? View.VISIBLE : View.GONE);
         mStepNumber.setVisibility(!done ? View.VISIBLE : View.GONE);
+        mStepErrorIndicator.setVisibility(GONE);
         colorViewBackground(done ? mStepDoneIndicator : mStepNumber, done || current);
 
+        this.hasError = false;
+
         mStepTitle.setTypeface(current ? Typeface.DEFAULT_BOLD : Typeface.DEFAULT);
         mStepTitle.setAlpha(done || current ? OPAQUE_ALPHA : INACTIVE_STEP_TITLE_ALPHA);
     }
 
+    /**
+     * Update the error state of this tab. If it has error, show the error drawable.
+     * @param hasError whether the tab has errors or not.
+     */
+    public void updateErrorState(boolean hasError) {
+        if(hasError) {
+            mStepDoneIndicator.setVisibility(View.GONE);
+            mStepNumber.setVisibility(View.GONE);
+            mStepErrorIndicator.setVisibility(VISIBLE);
+        }
+
+        this.hasError = hasError;
+    }
+
     /**
      * Sets the name of the step
      * @param title step name

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

@@ -79,6 +79,8 @@ public void onTabClicked(int position) {
 
     private List<Integer> mStepTitles;
 
+    private boolean mShowErrorStateOnBack;
+
     public TabsContainer(Context context) {
         this(context, null);
     }
@@ -152,13 +154,29 @@ public void setCurrentStep(int newStepPosition) {
             StepTab childTab = (StepTab) mTabsInnerContainer.getChildAt(i);
             boolean done = i < newStepPosition;
             final boolean current = i == newStepPosition;
-            childTab.updateState(done, current);
+            childTab.updateState(done, mShowErrorStateOnBack, current);
             if (current) {
                 mTabsScrollView.smoothScrollTo(childTab.getLeft() - mContainerLateralPadding, 0);
             }
         }
     }
 
+    /**
+     * Set whether when going backwards should clear the error state from the Tab. Default is false
+     * @param mShowErrorStateOnBack
+     */
+    public void setShowErrorStateOnBack(boolean mShowErrorStateOnBack) {
+        this.mShowErrorStateOnBack = mShowErrorStateOnBack;
+    }
+
+    public void setErrorStep(int stepPosition, boolean hasError){
+        if(mStepTitles.size() < stepPosition)
+            return;
+
+        StepTab childTab = (StepTab) mTabsInnerContainer.getChildAt(stepPosition);
+        childTab.updateErrorState(hasError);
+    }
+
     private View createStepTab(final int position, @StringRes int 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/res/drawable/ic_warning.xml

@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+        android:width="24dp"
+        android:height="24dp"
+        android:viewportWidth="24.0"
+        android:viewportHeight="24.0">
+    <path
+        android:fillColor="#FF000000"
+        android:pathData="M1,21h22L12,2 1,21zM13,18h-2v-2h2v2zM13,14h-2v-4h2v4z"/>
+</vector>

material-stepper/src/main/res/layout/ms_step_tab.xml

@@ -27,6 +27,15 @@
             app:srcCompat="@drawable/ic_check"
             android:visibility="gone" />
 
+        <android.support.v7.widget.AppCompatImageView
+            android:id="@+id/ms_stepErrorIndicator"
+            android:layout_width="@dimen/ms_step_tab_counter_size"
+            android:layout_height="@dimen/ms_step_tab_counter_size"
+            android:scaleType="centerInside"
+            app:srcCompat="@drawable/ic_warning"
+            android:tint="@color/ms_errorColor"
+            android:visibility="gone" />
+
     </FrameLayout>
 
     <TextView

material-stepper/src/main/res/values/attrs.xml

@@ -49,6 +49,9 @@ limitations under the License.
 
         <!-- Flag indicating if the Back (Previous step) button should be shown on the first step. False by default. -->
         <attr name="ms_showBackButtonOnFirstStep" format="boolean" />
+
+        <!-- Flag indicating wheter to keep showing the error state when user moves back. Only available with 'tabs' type. False by default. -->
+        <attr name="ms_showErrorStateOnBack" format="boolean" />
 
         <!-- REQUIRED: Type of the stepper-->
         <attr name="ms_stepperType">

sample/src/main/AndroidManifest.xml

@@ -24,6 +24,7 @@
         <activity android:name=".StyledProgressBarActivity" />
         <activity android:name=".DefaultTabsActivity" />
         <activity android:name=".StyledTabsActivity" />
+        <activity android:name=".ShowErrorOnBackTabActivity"/>
         <activity android:name=".CombinationActivity" />
         <activity android:name=".CustomPageTransformerActivity" />
         <activity android:name=".DelayedTransitionStepperActivity" />

sample/src/main/java/com/stepstone/stepper/sample/AbstractStepperActivity.java

@@ -31,7 +31,7 @@ public abstract class AbstractStepperActivity extends AppCompatActivity implemen
 
     private static final String CURRENT_STEP_POSITION_KEY = "position";
 
-    StepperLayout mStepperLayout;
+    protected StepperLayout mStepperLayout;
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {

sample/src/main/java/com/stepstone/stepper/sample/MainActivity.java

@@ -68,6 +68,11 @@ public void onStyledTabs(View view) {
         startActivity(new Intent(this, StyledTabsActivity.class));
     }
 
+    @OnClick(R.id.errorOnBackTabs)
+    public void onErrorOnBackTabs(View view) {
+        startActivity(new Intent(this, ShowErrorOnBackTabActivity.class));
+    }
+
     @OnClick(R.id.combination)
     public void onCombination(View view) {
         startActivity(new Intent(this, CombinationActivity.class));

sample/src/main/java/com/stepstone/stepper/sample/ShowErrorOnBackTabActivity.java

@@ -0,0 +1,21 @@
+package com.stepstone.stepper.sample;
+
+import android.os.Bundle;
+
+/**
+ * Created by leonardo on 10/01/17.
+ */
+
+public class ShowErrorOnBackTabActivity extends AbstractStepperActivity {
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        mStepperLayout.setShowErrorStateOnBack(true);
+    }
+
+    @Override
+    protected int getLayoutResId() {
+        return R.layout.activity_default_tabs;
+    }
+}