Added an option to disable tab navigation (issue #73)

Author: Piotr Zawadzki

README.md

@@ -355,8 +355,9 @@ For other examples, e.g. persisting state on rotation, displaying errors, changi
 | *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_errorColor*                 | color or reference                        | Error color in Tabs stepper |
-| *ms_showErrorStateEnabled*      | boolean                                   | Flag indicating whether to show the error state. Only available with 'tabs' type. False by default. |
-| *ms_showErrorStateOnBackEnabled*| boolean                                   | Flag indicating whether to keep showing the error state when user moves back. Only available with 'tabs' type. False by default. |
+| *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_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. |
 
 ### StepperLayout style attributes 

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

@@ -222,6 +222,8 @@ public void goToPrevStep() {
 
     private boolean mShowErrorStateOnBackEnabled;
 
+    private boolean mTabNavigationEnabled;
+
     @StyleRes
     private int mStepperLayoutTheme;
 
@@ -337,10 +339,12 @@ public int getTabStepDividerWidth() {
     @Override
     @UiThread
     public void onTabClicked(int position) {
-        if (position > mCurrentStepPosition) {
-            onNext();
-        } else if (position < mCurrentStepPosition) {
-            setCurrentStepPosition(position);
+        if (mTabNavigationEnabled) {
+            if (position > mCurrentStepPosition) {
+                onNext();
+            } else if (position < mCurrentStepPosition) {
+                setCurrentStepPosition(position);
+            }
         }
     }
 
@@ -436,6 +440,21 @@ public boolean isShowErrorStateOnBackEnabled() {
         return mShowErrorStateOnBackEnabled;
     }
 
+    /**
+     * @return true if step navigation is possible by clicking on the tabs directly, false otherwise
+     */
+    public boolean isTabNavigationEnabled() {
+        return mTabNavigationEnabled;
+    }
+
+    /**
+     * Sets whether step navigation is possible by clicking on the tabs directly. Only applicable for 'tabs' type.
+     * @param tabNavigationEnabled true if step navigation is possible by clicking on the tabs directly, false otherwise
+     */
+    public void setTabNavigationEnabled(boolean tabNavigationEnabled) {
+        mTabNavigationEnabled = tabNavigationEnabled;
+    }
+
     /**
      * Updates the error state in the UI.
      * It does nothing if showing error state is disabled.
@@ -621,6 +640,8 @@ private void extractValuesFromAttributes(AttributeSet attrs, @AttrRes int defSty
             mShowErrorStateOnBackEnabled = a.getBoolean(R.styleable.StepperLayout_ms_showErrorStateOnBack, false);
             mShowErrorStateOnBackEnabled = a.getBoolean(R.styleable.StepperLayout_ms_showErrorStateOnBackEnabled, mShowErrorStateOnBackEnabled);
 
+            mTabNavigationEnabled = a.getBoolean(R.styleable.StepperLayout_ms_tabNavigationEnabled, true);
+
             mStepperLayoutTheme = a.getResourceId(R.styleable.StepperLayout_ms_stepperLayoutTheme, R.style.MSDefaultStepperLayoutTheme);
 
             a.recycle();

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

@@ -55,15 +55,18 @@ limitations under the License.
         <!-- DEPRECATED: Use ms_showErrorStateEnabled instead -->
         <attr name="ms_showErrorState" format="boolean" />
 
-        <!-- Flag indicating whether to show the error state. Only available with 'tabs' type. False by default. -->
+        <!-- Flag indicating whether to show the error state. Only applicable for 'tabs' type. False by default. -->
         <attr name="ms_showErrorStateEnabled" format="boolean" />
 
         <!-- DEPRECATED: Use ms_showErrorStateOnBackEnabled instead -->
         <attr name="ms_showErrorStateOnBack" format="boolean" />
 
-        <!-- Flag indicating whether to keep showing the error state when user moves back. Only available with 'tabs' type. False by default. -->
+        <!-- Flag indicating whether to keep showing the error state when user moves back. Only applicable for 'tabs' type. False by default. -->
         <attr name="ms_showErrorStateOnBackEnabled" format="boolean" />
 
+        <!-- Flag indicating whether step navigation is possible by clicking on the tabs directly. Only applicable for 'tabs' type. True by default. -->
+        <attr name="ms_tabNavigationEnabled" format="boolean" />
+
         <!-- 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.
              See StepperLayoutTheme below for a list of possible inner view styles to overwrite.

sample/src/main/AndroidManifest.xml

@@ -35,6 +35,7 @@
         <activity android:name=".NoFragmentsActivity" />
         <activity android:name=".ProceedProgrammaticallyActivity"
             android:windowSoftInputMode="stateVisible"/>
+        <activity android:name=".DisabledTabNavigationActivity" />
         <activity
             android:name=".CustomStepperLayoutThemeActivity"
             android:theme="@style/AppThemeDark" />

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

@@ -0,0 +1,26 @@
+/*
+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.sample;
+
+public class DisabledTabNavigationActivity extends AbstractStepperActivity {
+
+    @Override
+    protected int getLayoutResId() {
+        return R.layout.activity_disabled_tab_navigation;
+    }
+
+}

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

@@ -118,6 +118,11 @@ public void onProceedProgrammatically(View view){
         startActivity(new Intent(this, ProceedProgrammaticallyActivity.class));
     }
 
+    @OnClick(R.id.disabledTabNavigation)
+    public void onDisabledTabNavigation(View view){
+        startActivity(new Intent(this, DisabledTabNavigationActivity.class));
+    }
+
     @OnClick(R.id.customStepperLayoutTheme)
     public void onCustomStepperLayoutThemeWithTabs(View view){
         startActivity(new Intent(this, CustomStepperLayoutThemeActivity.class));

sample/src/main/res/layout/activity_disabled_tab_navigation.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<com.stepstone.stepper.StepperLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    android:id="@+id/stepperLayout"
+    android:orientation="vertical"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    app:ms_stepperType="tabs"
+    app:ms_tabNavigationEnabled="false" />

sample/src/main/res/layout/activity_main.xml

@@ -118,6 +118,12 @@
             android:layout_height="wrap_content"
             android:text="@string/proceed_programmatically" />
 
+        <Button
+            android:id="@+id/disabledTabNavigation"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:text="@string/disabled_tab_navigation" />
+
         <Button
             android:id="@+id/customStepperLayoutTheme"
             android:layout_width="wrap_content"

sample/src/main/res/values/strings.xml

@@ -17,6 +17,7 @@
     <string name="show_back_button">Show Back button on first step</string>
     <string name="no_fragments">No Fragment Stepper</string>
     <string name="proceed_programmatically">Proceed programmatically</string>
+    <string name="disabled_tab_navigation">Disabled tab navigation</string>
     <string name="custom_stepperlayout_theme">Custom StepperLayout theme</string>
 
     <string name="tab_title">Tab title</string>