add support for adding a 'back' button

klinker24 · klinker24 · commit 1b50a4e0dc88 · 2019-03-11T14:35:11.000-05:00
diff --git a/library/src/main/java/xyz/klinker/android/floating_tutorial/TutorialPage.kt b/library/src/main/java/xyz/klinker/android/floating_tutorial/TutorialPage.kt
@@ -40,6 +40,7 @@ abstract class TutorialPage(private val activity: FloatingTutorialActivity) : Fr
     private val pageContent: FrameLayout by lazy { rootLayout.findViewById<View>(R.id.tutorial_page_content) as FrameLayout }
     private val progressHolder: LinearLayout by lazy { rootLayout.findViewById<View>(R.id.tutorial_progress) as LinearLayout }
     private val nextButton: Button by lazy { rootLayout.findViewById<View>(R.id.tutorial_next_button) as Button }
+    private val backButton: Button by lazy { rootLayout.findViewById<View>(R.id.tutorial_back_button) as Button }
 
     private var data: Any? = null
     private var pageIndex: Int? = null
@@ -56,6 +57,7 @@ abstract class TutorialPage(private val activity: FloatingTutorialActivity) : Fr
 
         if (pageIndex == pageCount - 1) setNextButtonText(R.string.tutorial_finish)
         nextButton.setOnClickListener { activity.onNextPressed() }
+        backButton.setOnClickListener { activity.onBackPressed() }
 
         initPage()
 
@@ -162,6 +164,51 @@ abstract class TutorialPage(private val activity: FloatingTutorialActivity) : Fr
         return activity.provider.tutorialPages[pageIndex!! - 1].getPageResultData()
     }
 
+    /**
+     * Set the color of the "Back" button's text. The default is close to black.
+     *
+     * @param newColor the color resource you want to use.
+     */
+    fun setBackButtonTextColorResource(@ColorRes newColor: Int) {
+        setBackButtonTextColor(activity.resources.getColor(newColor))
+    }
+
+    /**
+     * Set the color of the "Back" button's text. The default is close to black.
+     *
+     * @param newColor the color value you want to use.
+     */
+    fun setBackButtonTextColor(newColor: Int) {
+        nextButton.setTextColor(newColor)
+    }
+
+    /**
+     * Set the text for the "Back" button. The default is simply "Back".
+     *
+     * @param text the string you want to use.
+     */
+    fun setBackButtonText(@StringRes text: Int) {
+        setBackButtonText(activity.getString(text))
+    }
+
+    /**
+     * Set the text for the "Back" button. The default is simply "Back".
+     *
+     * @param text the string you want to use.
+     */
+    fun setBackButtonText(text: String) {
+        backButton.text = text
+        showBackButton()
+    }
+
+    /**
+     * Show the "Back" button to explicitly handle returning to the previous page.
+     */
+    fun showBackButton() {
+        backButton.visibility = View.VISIBLE
+        progressHolder.visibility = View.GONE
+    }
+
     /**
      * Hide the "Next" button to handle advancing the paging through a [View] you define in the page.
      */
@@ -257,7 +304,7 @@ abstract class TutorialPage(private val activity: FloatingTutorialActivity) : Fr
     }
 
     companion object {
-        private val DARKNESS_THRESHOLD = 0.30
+        private const val DARKNESS_THRESHOLD = 0.30
         private fun isColorDark(color: Int): Boolean {
             val darkness = 1 - (0.299 * Color.red(color) + 0.587 * Color.green(color) + 0.114 * Color.blue(color)) / 255
             return darkness >= DARKNESS_THRESHOLD
diff --git a/library/src/main/res/layout/tutorial_page_root.xml b/library/src/main/res/layout/tutorial_page_root.xml
@@ -40,26 +40,44 @@
 
             <LinearLayout
                 android:id="@+id/tutorial_progress"
-                android:layout_width="0dp"
+                android:layout_width="wrap_content"
                 android:layout_height="match_parent"
-                android:layout_marginLeft="12dp"
-                android:layout_marginRight="12dp"
-                android:layout_weight="1"
+                android:layout_marginStart="12dp"
+                android:layout_marginEnd="12dp"
                 android:gravity="center_vertical"
                 android:orientation="horizontal" />
 
-            <Button
+            <com.google.android.material.button.MaterialButton
+                android:id="@+id/tutorial_back_button"
+                style="@style/Widget.MaterialComponents.Button.TextButton"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_gravity="start"
+                android:layout_marginStart="12dp"
+                android:layout_marginLeft="12dp"
+                android:layout_marginBottom="6dp"
+                android:text="@string/tutorial_back"
+                android:textColor="@android:color/black"
+                android:visibility="gone"
+                app:rippleColor="@color/tutorial_ripple_color" />
+
+            <View
+                android:layout_width="0dp"
+                android:layout_height="match_parent"
+                android:layout_weight="1" />
+
+            <com.google.android.material.button.MaterialButton
                 android:id="@+id/tutorial_next_button"
                 style="@style/Widget.MaterialComponents.Button.TextButton"
-                app:rippleColor="@color/tutorial_ripple_color"
                 android:layout_width="wrap_content"
                 android:layout_height="wrap_content"
                 android:layout_gravity="end"
                 android:layout_marginEnd="12dp"
                 android:layout_marginRight="12dp"
-                android:background="?selectableItemBackgroundBorderless"
+                android:layout_marginBottom="6dp"
                 android:text="@string/tutorial_next"
-                android:textColor="@android:color/black" />
+                android:textColor="@android:color/black"
+                app:rippleColor="@color/tutorial_ripple_color" />
 
         </LinearLayout>
 
diff --git a/library/src/main/res/values/strings.xml b/library/src/main/res/values/strings.xml
@@ -17,6 +17,7 @@
 
 <resources>
 
+    <string name="tutorial_back">Back</string>
     <string name="tutorial_next">Next</string>
     <string name="tutorial_finish">Finish</string>
 
diff --git a/sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.java b/sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.java
@@ -94,6 +94,14 @@ public PageTwo(FloatingTutorialActivity activity) {
         @Override
         public void initPage() {
             setContentView(R.layout.example_rate_it_page_2);
+
+            findViewById(R.id.tutorial_back_button).setOnClickListener(new OnClickListener() {
+                @Override
+                public void onClick(View view) {
+                    setActivityResult(Activity.RESULT_CANCELED, new Intent());
+                    getActivity().finishAnimated();
+                }
+            });
         }
 
         @Override
@@ -113,6 +121,7 @@ public void onShown(boolean firstTimeShown) {
                 setActivityResult(Activity.RESULT_OK, data);
 
                 setNextButtonText(R.string.rate_it);
+                setBackButtonText(R.string.no_thanks);
             } else {
                 titleText.setText(R.string.rate_it_page_2_bad_title);
                 summaryText.setText(R.string.rate_it_page_2_bad_summary);
@@ -122,6 +131,7 @@ public void onShown(boolean firstTimeShown) {
                 setActivityResult(Activity.RESULT_OK, data);
 
                 setNextButtonText(R.string.send_email);
+                setBackButtonText(R.string.no_thanks);
             }
         }
 
diff --git a/sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.kt b/sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.kt
@@ -68,6 +68,11 @@ class RateItExample : FloatingTutorialActivity() {
     private class PageTwo(activity: FloatingTutorialActivity) : TutorialPage(activity) {
         override fun initPage() {
             setContentView(R.layout.example_rate_it_page_2)
+
+            findViewById<View>(R.id.tutorial_back_button).setOnClickListener {
+                setActivityResult(Activity.RESULT_CANCELED, Intent())
+                getActivity().finishAnimated()
+            }
         }
 
         override fun onShown(firstTimeShown: Boolean) {
@@ -86,6 +91,7 @@ class RateItExample : FloatingTutorialActivity() {
                 setActivityResult(Activity.RESULT_OK, data)
 
                 setNextButtonText(R.string.rate_it)
+                setBackButtonText(R.string.no_thanks)
             } else {
                 titleText.setText(R.string.rate_it_page_2_bad_title)
                 summaryText.setText(R.string.rate_it_page_2_bad_summary)
@@ -95,6 +101,7 @@ class RateItExample : FloatingTutorialActivity() {
                 setActivityResult(Activity.RESULT_OK, data)
 
                 setNextButtonText(R.string.send_email)
+                setBackButtonText(R.string.no_thanks)
             }
         }
 
diff --git a/sample-shared/src/main/res/values/strings.xml b/sample-shared/src/main/res/values/strings.xml
@@ -47,6 +47,7 @@
     <string name="rate_it_page_2_bad_summary">Not loving the app yet? Please get in touch to let us know how to make it better!</string>
     <string name="rate_it">Rate It!</string>
     <string name="send_email">Send Email</string>
+    <string name="no_thanks">No thanks</string>
 
     <!-- Feature Walk-through Example -->
     <string name="feature_1_title">My awesome first feature</string>
