Stepper feedback enhancements (#168)

* added missing tests for stepper feedback composite and factory

* added missing tests for tabs and disabled bottom navigation feedback types
refactored tests to reuse common setup methods

* added an option to stop child steps from receiving touch events as one of stepper feedback types

* Split 'content' stepper feedback type into 'content_progress' & 'content_fade'
Added 'content_overlay' stepper feedback type

* Added an option to change fade out alpha for 'content_fade' stepper feedback type

* Added an option to change overlay background drawable for 'content_overlay' stepper feedback type

Author: zawadz88

CHANGELOG.md

@@ -8,9 +8,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - `setEndButtonVisible` and `setBackButtonVisible` methods in `StepViewModel.Builder` for toggling button visibility (issue #104)
 - New stepper type `none` which shows no progress indicator for the steps (issue #154)
+- New stepper feedback type `disabled_content_interaction` which intercepts touch events on the steps' content and ignores them during operation.
+- New stepper feedback type `content_overlay` which shows a dimmed overlay over the content.
+- An option to specify the background drawable for `content_overlay` stepper feedback type via `ms_stepperFeedback_contentOverlayBackground`.
+- An option to specify the fade out alpha for `content_fade` stepper feedback type via `ms_stepperFeedback_contentFadeAlpha` attribute.
 
 ### Changed
-- Updated Android Support Library version to `25.4.0` to support vector animations without a pre-Lollipop fallback (issue #154)
-- Changed `setNextButtonLabel` methods in `StepViewModel.Builder` to `setEndButtonLabel` so that it works for both Next and Complete buttons (issue #107)
+- **Breaking change:** Updated Android Support Library version to `25.4.0` to support vector animations without a pre-Lollipop fallback (issue #154)
+- **Breaking change:** Changed `setNextButtonLabel` methods in `StepViewModel.Builder` to `setEndButtonLabel` so that it works for both Next and Complete buttons (issue #107)
+- **Breaking change:** Split `content` stepper feedback type into `content_progress` and `content_fade`.
 
 [Unreleased]: https://github.com/stepstone-tech/android-material-stepper/compare/v3.3.0...develop

README.md

@@ -356,9 +356,12 @@ If you want to keep the error displayed when going back to the previous step you
 ### Stepper feedback
 It is possible to show stepper feedback for ongoing operations (see [Stepper feedback](https://material.io/guidelines/components/steppers.html#steppers-types-of-steppers)).
 To do so you firstly need to set ```ms_stepperFeedbackType``` to one or more of:
-* ```tabs``` - shows a progress message instead of the tabs during operation,
-* ```content``` - shows a progress bar on top of the steps' content and partially fades the content out during operation,
+* ```tabs``` - shows a progress message instead of the tabs during operation.
+* ```content_progress``` - shows a progress bar on top of the steps' content.
+* ```content_fade``` - partially fades the content out during operation (should not be used together with ```content_overlay```). You can change the default fade amount with `ms_stepperFeedback_contentFadeAlpha` attribute.
+* ```content_overlay``` - shows a dimmed overlay over the content during the operation (should not be used together with ```content_fade```). You can change the overlay background with `ms_stepperFeedback_contentOverlayBackground` attribute.
 * ```disabled_bottom_navigation``` - disables the buttons in the bottom navigation during operation. In order to see that the buttons are disabled on the bottom navigation bar, make sure that the button colors are assigned using color selectors with a disabled state (see the sample app).
+* ```disabled_content_interaction``` - intercepts touch events on the steps' content and ignores them during operation.
 
 The default is ```none``` which does nothing. It is possible to use multiple flags together.
 
@@ -480,7 +483,9 @@ For advanced styling please see [StepperLayout style attributes](#stepperlayout-
 | *ms_showErrorStateEnabled*      | boolean                                                             | Flag indicating whether to show the error state. Only applicable for 'tabs' type. False by default. |
 | *ms_showErrorStateOnBackEnabled*| boolean                                                             | Flag indicating whether to keep showing the error state when user moves back. Only applicable for 'tabs' type. False by default. |
 | *ms_tabNavigationEnabled*       | boolean                                                             | Flag indicating whether step navigation is possible by clicking on the tabs directly. Only applicable for 'tabs' type. True by default. |
-| *ms_stepperFeedbackType*        | flag(s): `none` or `tabs`, `content` & `disabled_bottom_navigation` | Type(s) of stepper feedback. Can be a combination of `tabs`, `content` & `disabled_bottom_navigation`. Default is `none`.|
+| *ms_stepperFeedbackType*        | flag(s): `none` or `tabs`, `content_progress`, `content_fade`, `content_overlay`, `disabled_bottom_navigation` & `disabled_content_interaction` | Type(s) of stepper feedback. Can be a combination of `tabs`, `content_progress`, `content_fade`, `content_overlay`, `disabled_bottom_navigation` & `disabled_content_interaction`. Default is `none`.|
+| *ms_stepperFeedback_contentFadeAlpha* | float                                                         | An alpha value from 0 to 1.0f to be used for the faded out view if `content_fade` stepper feedback type is set. 0.5f by default. |
+| *ms_stepperFeedback_contentOverlayBackground* | reference                                             | Background to be used for the overlay on top of the content if `content_overlay` stepper feedback type is set. |
 | *ms_showBottomNavigation*       | boolean                                                             | Flag indicating if the Bottom Navigation bar should be shown on the layout. True by default. |
 | *ms_stepperLayoutTheme*         | reference                                                           | Theme to use for even more custom styling of the stepper layout. It is recommended that it should extend @style/MSDefaultStepperLayoutTheme, which is the default theme used. |
 
@@ -496,6 +501,7 @@ A list of `ms_stepperLayoutTheme` attributes responsible for styling of StepperL
 | *ms_completeNavigationButtonStyle*| Used by ms_stepCompleteButton in layout/ms_stepper_layout     |
 | *ms_colorableProgressBarStyle*    | Used by ms_stepProgressBar in layout/ms_stepper_layout        |
 | *ms_stepPagerProgressBarStyle*    | Used by ms_stepPagerProgressBar in layout/ms_stepper_layout   |
+| *ms_stepPagerOverlayStyle*        | Used by ms_stepPagerOverlay in layout/ms_stepper_layout   |
 | *ms_stepTabsScrollViewStyle*      | Used by ms_stepTabsScrollView in layout/ms_tabs_container     |
 | *ms_stepTabsInnerContainerStyle*  | Used by ms_stepTabsInnerContainer in layout/ms_tabs_container |
 | *ms_stepTabsProgressMessageStyle* | Used by ms_stepTabsProgressMessage in layout/ms_tabs_container|

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

@@ -25,6 +25,7 @@
 import android.support.annotation.AttrRes;
 import android.support.annotation.ColorInt;
 import android.support.annotation.DrawableRes;
+import android.support.annotation.FloatRange;
 import android.support.annotation.IntRange;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
@@ -237,6 +238,12 @@ public void goToPrevStep() {
 
     private StepperFeedbackType mStepperFeedbackType;
 
+    @FloatRange(from = 0.0f, to = 1.0f)
+    private float mContentFadeAlpha = AnimationUtil.ALPHA_HALF;
+
+    @DrawableRes
+    private int mContentOverlayBackground;
+
     private int mCurrentStepPosition;
 
     private boolean mShowErrorStateEnabled;
@@ -627,6 +634,23 @@ public void setFeedbackType(int feedbackTypeMask) {
         mStepperFeedbackType = StepperFeedbackTypeFactory.createType(mFeedbackTypeMask, this);
     }
 
+    /**
+     * @return An alpha value from 0 to 1.0f to be used for the faded out view if 'content_fade' stepper feedback is set. 0.5f by default.
+     */
+    @FloatRange(from = 0.0f, to = 1.0f)
+    public float getContentFadeAlpha() {
+        return mContentFadeAlpha;
+    }
+
+    /**
+     * @return Background res ID to be used for the overlay on top of the content
+     * if 'content_overlay' stepper feedback type is set. 0 if default background should be used.
+     */
+    @DrawableRes
+    public int getContentOverlayBackground() {
+        return mContentOverlayBackground;
+    }
+
     @SuppressWarnings("RestrictedApi")
     private void init(AttributeSet attrs, @AttrRes int defStyleAttr) {
         initDefaultValues();
@@ -792,6 +816,14 @@ private void extractValuesFromAttributes(AttributeSet attrs, @AttrRes int defSty
                 mFeedbackTypeMask = a.getInt(R.styleable.StepperLayout_ms_stepperFeedbackType, StepperFeedbackType.NONE);
             }
 
+            if (a.hasValue(R.styleable.StepperLayout_ms_stepperFeedback_contentFadeAlpha)) {
+                mContentFadeAlpha = a.getFloat(R.styleable.StepperLayout_ms_stepperFeedback_contentFadeAlpha, AnimationUtil.ALPHA_HALF);
+            }
+
+            if (a.hasValue(R.styleable.StepperLayout_ms_stepperFeedback_contentOverlayBackground)) {
+                mContentOverlayBackground = a.getResourceId(R.styleable.StepperLayout_ms_stepperFeedback_contentOverlayBackground, 0);
+            }
+
             mShowErrorStateOnBackEnabled = a.getBoolean(R.styleable.StepperLayout_ms_showErrorStateOnBack, false);
             mShowErrorStateOnBackEnabled = a.getBoolean(R.styleable.StepperLayout_ms_showErrorStateOnBackEnabled, mShowErrorStateOnBackEnabled);
 

…feedback/ContentStepperFeedbackType.java …back/ContentFadeStepperFeedbackType.javamaterial-stepper/src/main/java/com/stepstone/stepper/internal/feedback/ContentStepperFeedbackType.java renamed to material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/ContentFadeStepperFeedbackType.java material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/ContentStepperFeedbackType.java renamed to material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/ContentFadeStepperFeedbackType.java

@@ -16,44 +16,43 @@
 
 package com.stepstone.stepper.internal.feedback;
 
+import android.support.annotation.FloatRange;
 import android.support.annotation.NonNull;
 import android.support.annotation.RestrictTo;
 import android.view.View;
-import android.widget.ProgressBar;
 
 import com.stepstone.stepper.R;
 import com.stepstone.stepper.StepperLayout;
 
 import static android.support.annotation.RestrictTo.Scope.LIBRARY;
-import static com.stepstone.stepper.internal.util.AnimationUtil.ALPHA_HALF;
 import static com.stepstone.stepper.internal.util.AnimationUtil.ALPHA_OPAQUE;
 
 /**
- * Feedback stepper type which displays a progress bar on top of the steps' content and partially fades the content out.
+ * Feedback stepper type which partially fades the content out.
  */
 @RestrictTo(LIBRARY)
-public class ContentStepperFeedbackType implements StepperFeedbackType {
+public class ContentFadeStepperFeedbackType implements StepperFeedbackType {
 
+    @NonNull
     private final View mPager;
 
-    private final ProgressBar mPagerProgressBar;
+    @FloatRange(from = 0.0f, to = 1.0f)
+    private final float mFadeOutAlpha;
 
-    public ContentStepperFeedbackType(@NonNull StepperLayout stepperLayout) {
+    public ContentFadeStepperFeedbackType(@NonNull StepperLayout stepperLayout) {
         mPager = stepperLayout.findViewById(R.id.ms_stepPager);
-        mPagerProgressBar = (ProgressBar) stepperLayout.findViewById(R.id.stepPagerProgressBar);
+        mFadeOutAlpha = stepperLayout.getContentFadeAlpha();
     }
 
     @Override
     public void showProgress(@NonNull String progressMessage) {
-        mPagerProgressBar.setVisibility(View.VISIBLE);
         mPager.animate()
-                .alpha(ALPHA_HALF)
+                .alpha(mFadeOutAlpha)
                 .setDuration(PROGRESS_ANIMATION_DURATION);
     }
 
     @Override
     public void hideProgress() {
-        mPagerProgressBar.setVisibility(View.GONE);
         mPager.animate()
                 .alpha(ALPHA_OPAQUE)
                 .setDuration(PROGRESS_ANIMATION_DURATION);

material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/ContentOverlayStepperFeedbackType.java

@@ -0,0 +1,62 @@
+/*
+Copyright 2017 StepStone Services
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+ */
+
+package com.stepstone.stepper.internal.feedback;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.RestrictTo;
+import android.view.View;
+
+import com.stepstone.stepper.R;
+import com.stepstone.stepper.StepperLayout;
+
+import static android.support.annotation.RestrictTo.Scope.LIBRARY;
+import static com.stepstone.stepper.internal.util.AnimationUtil.ALPHA_INVISIBLE;
+import static com.stepstone.stepper.internal.util.AnimationUtil.ALPHA_OPAQUE;
+
+/**
+ * Feedback stepper type which shows a dimmed overlay over the content.
+ */
+@RestrictTo(LIBRARY)
+public class ContentOverlayStepperFeedbackType implements StepperFeedbackType {
+
+    @NonNull
+    private final View mOverlayView;
+
+    public ContentOverlayStepperFeedbackType(@NonNull StepperLayout stepperLayout) {
+        mOverlayView = stepperLayout.findViewById(R.id.ms_stepPagerOverlay);
+        mOverlayView.setVisibility(View.VISIBLE);
+        mOverlayView.setAlpha(ALPHA_INVISIBLE);
+        final int contentOverlayBackground = stepperLayout.getContentOverlayBackground();
+        if (contentOverlayBackground != 0)  {
+            mOverlayView.setBackgroundResource(contentOverlayBackground);
+        }
+    }
+
+    @Override
+    public void showProgress(@NonNull String progressMessage) {
+        mOverlayView.animate()
+                .alpha(ALPHA_OPAQUE)
+                .setDuration(PROGRESS_ANIMATION_DURATION);
+    }
+
+    @Override
+    public void hideProgress() {
+        mOverlayView.animate()
+                .alpha(ALPHA_INVISIBLE)
+                .setDuration(PROGRESS_ANIMATION_DURATION);
+    }
+}

material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/ContentProgressStepperFeedbackType.java

@@ -0,0 +1,51 @@
+/*
+Copyright 2017 StepStone Services
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+ */
+
+package com.stepstone.stepper.internal.feedback;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.RestrictTo;
+import android.view.View;
+import android.widget.ProgressBar;
+
+import com.stepstone.stepper.R;
+import com.stepstone.stepper.StepperLayout;
+
+import static android.support.annotation.RestrictTo.Scope.LIBRARY;
+
+/**
+ * Feedback stepper type which displays a progress bar on top of the steps' content.
+ */
+@RestrictTo(LIBRARY)
+public class ContentProgressStepperFeedbackType implements StepperFeedbackType {
+
+    @NonNull
+    private final ProgressBar mPagerProgressBar;
+
+    public ContentProgressStepperFeedbackType(@NonNull StepperLayout stepperLayout) {
+        mPagerProgressBar = (ProgressBar) stepperLayout.findViewById(R.id.ms_stepPagerProgressBar);
+    }
+
+    @Override
+    public void showProgress(@NonNull String progressMessage) {
+        mPagerProgressBar.setVisibility(View.VISIBLE);
+    }
+
+    @Override
+    public void hideProgress() {
+        mPagerProgressBar.setVisibility(View.GONE);
+    }
+}

material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/DisabledBottomNavigationStepperFeedbackType.java

@@ -24,11 +24,12 @@
 import static android.support.annotation.RestrictTo.Scope.LIBRARY;
 
 /**
- * Feedback stepper type which disabled the buttons in the bottom navigation when an operation is in progress.
+ * Feedback stepper type which disables the buttons in the bottom navigation when an operation is in progress.
  */
 @RestrictTo(LIBRARY)
 public class DisabledBottomNavigationStepperFeedbackType implements StepperFeedbackType {
 
+    @NonNull
     private StepperLayout mStepperLayout;
 
     public DisabledBottomNavigationStepperFeedbackType(@NonNull StepperLayout stepperLayout) {

material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/DisabledContentInteractionStepperFeedbackType.java

@@ -0,0 +1,55 @@
+/*
+Copyright 2017 StepStone Services
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+ */
+
+package com.stepstone.stepper.internal.feedback;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.RestrictTo;
+
+import com.stepstone.stepper.R;
+import com.stepstone.stepper.StepperLayout;
+import com.stepstone.stepper.internal.widget.StepViewPager;
+
+import static android.support.annotation.RestrictTo.Scope.LIBRARY;
+
+/**
+ * Feedback stepper type which intercepts touch events on the steps' content and ignores them.
+ */
+@RestrictTo(LIBRARY)
+public class DisabledContentInteractionStepperFeedbackType implements StepperFeedbackType {
+
+    @NonNull
+    private final StepViewPager mStepPager;
+
+    public DisabledContentInteractionStepperFeedbackType(@NonNull StepperLayout stepperLayout) {
+        mStepPager = (StepViewPager) stepperLayout.findViewById(R.id.ms_stepPager);
+    }
+
+    @Override
+    public void showProgress(@NonNull String progressMessage) {
+        setContentInteractionEnabled(false);
+    }
+
+    @Override
+    public void hideProgress() {
+        setContentInteractionEnabled(true);
+    }
+
+    private void setContentInteractionEnabled(boolean enabled) {
+        mStepPager.setBlockTouchEventsFromChildrenEnabled(!enabled);
+    }
+
+}

material-stepper/src/main/java/com/stepstone/stepper/internal/feedback/StepperFeedbackType.java

@@ -24,17 +24,35 @@ public interface StepperFeedbackType {
     int TABS = 1 << 1;
 
     /**
-     * Shows a progress bar on top of the steps' content and partially fades the content out during operation.
-     * @see ContentStepperFeedbackType
+     * Shows a progress bar on top of the steps' content.
+     * @see ContentProgressStepperFeedbackType
      */
-    int CONTENT = 1 << 2;
+    int CONTENT_PROGRESS = 1 << 2;
 
     /**
      * Disables the buttons in the bottom navigation during operation.
      * @see DisabledBottomNavigationStepperFeedbackType
      */
     int DISABLED_BOTTOM_NAVIGATION = 1 << 3;
 
+    /**
+     * Disables content interaction during operation i.e. stops step views from receiving touch events.
+     * @see DisabledContentInteractionStepperFeedbackType
+     */
+    int DISABLED_CONTENT_INTERACTION = 1 << 4;
+
+    /**
+     * Partially fades the content out during operation.
+     * @see ContentFadeStepperFeedbackType
+     */
+    int CONTENT_FADE = 1 << 5;
+
+    /**
+     * Shows a dimmed overlay over the content during operation.
+     * @see ContentOverlayStepperFeedbackType
+     */
+    int CONTENT_OVERLAY = 1 << 6;
+
     int PROGRESS_ANIMATION_DURATION = 200;
 
     /**