ShowOnce paramater added

Author: JorgeCM

README.md

@@ -41,6 +41,7 @@ BubbleShowCaseBuilder(this) //Activity instance
                 .descriptionTextSize(15) //Subtitle text size in SP (default value 14sp)
                 .image(imageDrawable) //Bubble main image
                 .closeActionImage(CloseImageDrawable) //Custom close action image
+                .showOnce("BUBBLE_SHOW_CASE_ID") //Id to show only once the BubbleShowCase
                 .listener(listener(object : BubbleShowCaseListener{ //Listener for user actions
                     override fun onTargetClick(bubbleShowCase: BubbleShowCase) {
                         //Called when the user clicks the target

bubbleshowcase/src/main/java/com/elconfidencial/bubbleshowcase/BubbleShowCase.kt

@@ -3,6 +3,8 @@ package com.elconfidencial.bubbleshowcase
 
 import android.app.Activity
 import android.content.Context
+import android.content.Context.MODE_PRIVATE
+import android.content.SharedPreferences
 import android.graphics.Bitmap
 import android.graphics.RectF
 import android.graphics.drawable.Drawable
@@ -21,6 +23,8 @@ import java.lang.ref.WeakReference
  */
 
 class BubbleShowCase(builder: BubbleShowCaseBuilder){
+    private val SHARED_PREFS_NAME = "BubbleShowCasePrefs"
+
     private val FOREGROUND_LAYOUT_ID = 731
 
     private val DURATION_SHOW_CASE_ANIMATION = 200 //ms
@@ -47,6 +51,7 @@ class BubbleShowCase(builder: BubbleShowCaseBuilder){
     private val mTextColor: Int? = builder.mTextColor
     private val mTitleTextSize: Int? = builder.mTitleTextSize
     private val mSubtitleTextSize: Int? = builder.mSubtitleTextSize
+    private val mShowOnce: String? = builder.mShowOnce
     private val mDisableTargetClick: Boolean = builder.mDisableTargetClick
     private val mArrowPositionList: MutableList<ArrowPosition> = builder.mArrowPositionList
     private val mTargetView: WeakReference<View>? = builder.mTargetView
@@ -62,6 +67,15 @@ class BubbleShowCase(builder: BubbleShowCaseBuilder){
     private var bubbleMessageViewBuilder: BubbleMessageView.Builder? = null
 
     fun show(){
+        if(mShowOnce != null){
+            if(isBubbleShowCaseHasBeenShowedPreviously(mShowOnce)){
+                notifyDismissToSequenceListener()
+                return
+            } else{
+                registerBubbleShowCaseInPreferences(mShowOnce)
+            }
+        }
+
         val rootView = getViewRoot(mActivity.get()!!)
         foregroundLayoutWithBlur = getForegroundLayoutWithBlur()
         bubbleMessageViewBuilder = getBubbleMessageViewBuilder()
@@ -95,7 +109,7 @@ class BubbleShowCase(builder: BubbleShowCaseBuilder){
     }
 
     fun dismiss() {
-        mSequenceListener?.let { mSequenceListener.onDismiss() }
+        notifyDismissToSequenceListener()
         if (foregroundLayoutWithBlur != null && isLastOfSequence) {
             //Remove foreground layout if the BubbleShowCase is the last of the sequence
             val rootView = getViewRoot(mActivity.get()!!)
@@ -107,6 +121,10 @@ class BubbleShowCase(builder: BubbleShowCaseBuilder){
         }
     }
 
+    private fun notifyDismissToSequenceListener(){
+        mSequenceListener?.let { mSequenceListener.onDismiss() }
+    }
+
     private fun getViewRoot(activity: Activity): ViewGroup {
         val androidContent = activity.findViewById<ViewGroup>(android.R.id.content)
         return androidContent.parent.parent as ViewGroup
@@ -143,6 +161,27 @@ class BubbleShowCase(builder: BubbleShowCaseBuilder){
                 })
     }
 
+    private fun isBubbleShowCaseHasBeenShowedPreviously(id: String): Boolean{
+        val mPrefs = mActivity.get()!!.getSharedPreferences(SHARED_PREFS_NAME, MODE_PRIVATE)
+        return getString(mPrefs, id)!=null
+    }
+
+    private fun registerBubbleShowCaseInPreferences(id: String){
+        val mPrefs = mActivity.get()!!.getSharedPreferences(SHARED_PREFS_NAME, MODE_PRIVATE)
+        setString(mPrefs, id, id)
+    }
+
+    fun getString(mPrefs: SharedPreferences, key: String): String? {
+        return mPrefs.getString(key, null)
+    }
+
+    fun setString(mPrefs: SharedPreferences, key: String, value: String) {
+        val editor = mPrefs.edit()
+        editor.putString(key, value)
+        editor.apply()
+    }
+
+
     /**
      * This function takes a screenshot of the targetView, creating an ImageView from it. This new ImageView is also set on the layout passed by param
      */

bubbleshowcase/src/main/java/com/elconfidencial/bubbleshowcase/BubbleShowCaseBuilder.kt

@@ -22,6 +22,7 @@ class BubbleShowCaseBuilder{
     internal var mTitleTextSize: Int? = null
     internal var mSubtitleTextSize: Int? = null
     internal var mDisableTargetClick: Boolean = false
+    internal var mShowOnce: String? = null
     internal var mIsFirstOfSequence: Boolean? = null
     internal var mIsLastOfSequence: Boolean? = null
     internal val mArrowPositionList = ArrayList<BubbleShowCase.ArrowPosition>()
@@ -108,6 +109,15 @@ class BubbleShowCaseBuilder{
         return this
     }
 
+    /**
+     * If an unique id is passed in this function, this BubbleShowCase will only be showed once
+     * - ID to identify the BubbleShowCase
+     */
+    fun showOnce(id: String): BubbleShowCaseBuilder {
+        mShowOnce = id
+        return this
+    }
+
     /**
      * Target view to be highlighted. Set a TargetView is essential to figure out BubbleShowCase position
      * - If a target view is not defined, the BubbleShowCase final position will be the center of the screen