Merge pull request #45 from DylanCaiCoding/5.0.0

5.0.0

Author: DylanCaiCoding

README.md

@@ -55,10 +55,10 @@ Add dependencies in your module `build.gradle` :
 ```groovy
 dependencies {
     // java
-    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:4.1.0'
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:5.0.0'
 
     // kotlin
-    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:4.1.0'
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:5.0.0'
 }
 ```
 

README_ZH.md

@@ -57,10 +57,10 @@ allprojects {
 ```groovy
 dependencies {
     // java
-    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:4.1.0'
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:5.0.0'
 
     // kotlin
-    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:4.1.0'
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:5.0.0'
 }
 ```
 

docs/README.md

@@ -53,10 +53,10 @@ allprojects {
 ```groovy
 dependencies {
     // java
-    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:4.1.0'
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:5.0.0'
     
     // kotlin
-    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:4.1.0'
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:5.0.0'
 }
 ```
 

docs/zh/delegate.md

@@ -8,7 +8,7 @@
 
 ```groovy
 dependencies {
-  implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:4.1.0'
+  implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:5.0.0'
 }
 ```
 

loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingState.kt

@@ -22,6 +22,7 @@ import androidx.annotation.StringRes
 import androidx.fragment.app.Fragment
 
 interface LoadingState : Decorative, OnReloadListener {
+  val loadingStateViewType: Any?
 
   @Deprecated("Use Activity.decorateContentView(this) instead", ReplaceWith("decorateContentView(decorative)"))
   fun Activity.decorateContentView(listener: OnReloadListener, decorative: Decorative) = decorateContentView(decorative)
@@ -51,15 +52,15 @@ interface LoadingState : Decorative, OnReloadListener {
 
   fun Fragment.setDecorView(delegate: LoadingStateView.DecorViewDelegate)
 
-  fun showLoadingView(animation: LoadingStateView.Animation? = null)
+  fun showLoadingView(animatable: LoadingStateView.Animatable? = LoadingStateView.defaultAnimatable)
 
-  fun showContentView(animation: LoadingStateView.Animation? = null)
+  fun showContentView(animatable: LoadingStateView.Animatable? = LoadingStateView.defaultAnimatable)
 
-  fun showErrorView(animation: LoadingStateView.Animation? = null)
+  fun showErrorView(animatable: LoadingStateView.Animatable? = LoadingStateView.defaultAnimatable)
 
-  fun showEmptyView(animation: LoadingStateView.Animation? = null)
+  fun showEmptyView(animatable: LoadingStateView.Animatable? = LoadingStateView.defaultAnimatable)
 
-  fun showCustomView(viewType: Any)
+  fun showCustomView(viewType: Any, animatable: LoadingStateView.Animatable? = LoadingStateView.defaultAnimatable)
 
   fun updateToolbar(block: ToolbarConfig.() -> Unit)
 

loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingStateDelegate.kt

@@ -25,6 +25,9 @@ import androidx.fragment.app.Fragment
 class LoadingStateDelegate : LoadingState {
   private var loadingStateView: LoadingStateView? = null
 
+  override val loadingStateViewType: Any?
+    get() = loadingStateView?.currentViewType
+
   override fun Activity.decorateContentView(decorative: Decorative) {
     findViewById<ViewGroup>(android.R.id.content).getChildAt(0).decorate(decorative)
   }
@@ -34,6 +37,7 @@ class LoadingStateDelegate : LoadingState {
       !decorative.isDecorated -> this
       decorative.contentView == null ->
         LoadingStateView(this, decorative).also { loadingStateView = it }.decorView
+
       else -> {
         loadingStateView = LoadingStateView(decorative.contentView!!, decorative)
         this
@@ -76,24 +80,24 @@ class LoadingStateDelegate : LoadingState {
     loadingStateView?.addChildDecorView(delegate)
   }
 
-  override fun showLoadingView(animation: LoadingStateView.Animation?) {
-    loadingStateView?.showLoadingView(animation)
+  override fun showLoadingView(animatable: LoadingStateView.Animatable?) {
+    loadingStateView?.showLoadingView(animatable)
   }
 
-  override fun showContentView(animation: LoadingStateView.Animation?) {
-    loadingStateView?.showContentView(animation)
+  override fun showContentView(animatable: LoadingStateView.Animatable?) {
+    loadingStateView?.showContentView(animatable)
   }
 
-  override fun showErrorView(animation: LoadingStateView.Animation?) {
-    loadingStateView?.showErrorView(animation)
+  override fun showErrorView(animatable: LoadingStateView.Animatable?) {
+    loadingStateView?.showErrorView(animatable)
   }
 
-  override fun showEmptyView(animation: LoadingStateView.Animation?) {
-    loadingStateView?.showEmptyView(animation)
+  override fun showEmptyView(animatable: LoadingStateView.Animatable?) {
+    loadingStateView?.showEmptyView(animatable)
   }
 
-  override fun showCustomView(viewType: Any) {
-    loadingStateView?.showView(viewType)
+  override fun showCustomView(viewType: Any, animatable: LoadingStateView.Animatable?) {
+    loadingStateView?.showView(viewType, animatable)
   }
 
   override fun updateToolbar(block: ToolbarConfig.() -> Unit) {

loadingstateview/src/main/java/com/dylanc/loadingstateview/LoadingStateView.kt

@@ -39,7 +39,7 @@ class LoadingStateView @JvmOverloads constructor(
   private val parent: ViewGroup?
   private var currentView: View? = null
   private var viewDelegates: HashMap<Any, ViewDelegate> = HashMap()
-  private val viewCashes: HashMap<Any, View> = HashMap()
+  private val viewCaches: HashMap<Any, View> = HashMap()
 
   /**
    * Constructs a LoadingStateView with an activity and listener.
@@ -111,6 +111,7 @@ class LoadingStateView @JvmOverloads constructor(
     onCreateDecorView(contentView.context, LayoutInflater.from(contentView.context)).also { decorView ->
       contentView.layoutParams?.let {
         decorView.layoutParams = if (it is ConstraintLayout.LayoutParams) ConstraintLayout.LayoutParams(it) else it
+        (it as? ViewGroup.MarginLayoutParams)?.setMargins(0, 0, 0, 0)
       }
     }
 
@@ -122,39 +123,41 @@ class LoadingStateView @JvmOverloads constructor(
   fun register(vararg delegates: ViewDelegate) = delegates.forEach { viewDelegates[it.viewType] = it }
 
   @JvmOverloads
-  fun showLoadingView(animation: Animation? = null) = showView(ViewType.LOADING, animation)
+  fun showLoadingView(animatable: Animatable? = defaultAnimatable) = showView(ViewType.LOADING, animatable)
 
   @JvmOverloads
-  fun showContentView(animation: Animation? = null) = showView(ViewType.CONTENT, animation)
+  fun showContentView(animatable: Animatable? = defaultAnimatable) = showView(ViewType.CONTENT, animatable)
 
   @JvmOverloads
-  fun showErrorView(animation: Animation? = null) = showView(ViewType.ERROR, animation)
+  fun showErrorView(animatable: Animatable? = defaultAnimatable) = showView(ViewType.ERROR, animatable)
 
   @JvmOverloads
-  fun showEmptyView(animation: Animation? = null) = showView(ViewType.EMPTY, animation)
+  fun showEmptyView(animatable: Animatable? = defaultAnimatable) = showView(ViewType.EMPTY, animatable)
 
   /**
    * Shows the view by view type
    *
    * @param viewType the view type of view delegate
    */
   @JvmOverloads
-  fun showView(viewType: Any, animation: Animation? = null) {
+  fun showView(viewType: Any, animatable: Animatable? = defaultAnimatable) {
     val currentView = currentView
     if (currentView == null) {
       addView(viewType)
     } else {
-      if (viewCashes[viewType] == null) addView(viewType)
+      if (viewCaches[viewType] == null) addView(viewType)
       if (viewType != currentViewType) {
-        val view = getView(viewType)
-        view.visibility = View.VISIBLE
-        if (animation != null) {
-          animation.onStartHideAnimation(currentView, currentViewType)
-          animation.onStartShowAnimation(view, getViewDelegate<ViewDelegate>(viewType)!!.viewType)
+        val nextView = getOrCreateView(viewType)
+        nextView.visibility = View.VISIBLE
+        val nextViewDelegate = getViewDelegate<ViewDelegate>(viewType)
+        nextViewDelegate?.onViewAttached(nextView)
+        getViewDelegate<ViewDelegate>(currentViewType)?.onViewDetached(nextView)
+        if (animatable != null && nextViewDelegate != null) {
+          animatable.toggleViewsAnimation(nextView, currentView, viewType, currentViewType)
         } else {
           currentView.visibility = View.GONE
         }
-        this.currentView = view
+        this.currentView = nextView
       }
     }
     currentViewType = viewType
@@ -167,7 +170,7 @@ class LoadingStateView @JvmOverloads constructor(
   fun <T : ViewDelegate> getViewDelegate(viewType: Any) = viewDelegates[viewType] as? T
 
   private fun addView(viewType: Any) {
-    val view = getView(viewType)
+    val view = getOrCreateView(viewType)
     (view.parent as? ViewGroup)?.removeView(view)
     if (parent is ConstraintLayout && viewType == ViewType.CONTENT) {
       val params = view.layoutParams
@@ -179,24 +182,25 @@ class LoadingStateView @JvmOverloads constructor(
     currentView = view
   }
 
-  private fun getView(viewType: Any): View {
-    if (viewCashes[viewType] == null) {
+  private fun getOrCreateView(viewType: Any): View {
+    if (viewCaches[viewType] == null) {
       val viewDelegate = requireNotNull(getViewDelegate(viewType)) { "Please register view delegate for $viewType type." }
       val view = viewDelegate.onCreateView(LayoutInflater.from(contentParent.context), contentParent)
       viewDelegate.onReloadListener = onReloadListener
-      viewCashes[viewType] = view
+      viewCaches[viewType] = view
     }
-    return viewCashes[viewType]!!
+    return viewCaches[viewType]!!
   }
 
   abstract class ViewDelegate(val viewType: Any) {
+    abstract fun onCreateView(inflater: LayoutInflater, parent: ViewGroup): View
+    open fun onViewAttached(view: View) = Unit
+    open fun onViewDetached(view: View) = Unit
     var onReloadListener: OnReloadListener? = null
       internal set
-
-    abstract fun onCreateView(inflater: LayoutInflater, parent: ViewGroup): View
   }
 
-  private inner class ContentViewDelegate : LoadingStateView.ViewDelegate(ViewType.CONTENT) {
+  private inner class ContentViewDelegate : ViewDelegate(ViewType.CONTENT) {
     override fun onCreateView(inflater: LayoutInflater, parent: ViewGroup) = contentView
   }
 
@@ -210,7 +214,7 @@ class LoadingStateView @JvmOverloads constructor(
 
     constructor(delegates: Array<out ViewDelegate>) : this(delegates.map {
       register(it)
-      getView(it.viewType)
+      getOrCreateView(it.viewType)
     })
 
     override fun onCreateDecorView(context: Context, inflater: LayoutInflater) =
@@ -233,14 +237,16 @@ class LoadingStateView @JvmOverloads constructor(
     fun T.invoke()
   }
 
-  interface Animation {
-    fun onStartShowAnimation(view: View, viewType: Any)
-    fun onStartHideAnimation(view: View, viewType: Any)
+  interface Animatable {
+    fun toggleViewsAnimation(showView: View, hideView: View, showViewType: Any, hideViewType: Any)
   }
 
   companion object {
     private var poolInitializer: Callback<PoolInitializer>? = null
 
+    @JvmStatic
+    var defaultAnimatable: Animatable? = null
+
     @JvmStatic
     fun setViewDelegatePool(poolInitializer: Callback<PoolInitializer>) {
       this.poolInitializer = poolInitializer

sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/App.java

@@ -19,6 +19,7 @@
 import android.app.Application;
 
 import com.dylanc.loadingstateview.LoadingStateView;
+import com.dylanc.loadingstateview.sample.java.animation.FadeAnimatable;
 import com.dylanc.loadingstateview.sample.java.delegate.EmptyViewDelegate;
 import com.dylanc.loadingstateview.sample.java.delegate.ErrorViewDelegate;
 import com.dylanc.loadingstateview.sample.java.delegate.LoadingViewDelegate;
@@ -32,5 +33,6 @@ public void onCreate() {
     super.onCreate();
     LoadingStateView.setViewDelegatePool(pool ->
         pool.register(new LoadingViewDelegate(), new ErrorViewDelegate(), new EmptyViewDelegate()));
+    LoadingStateView.setDefaultAnimatable(new FadeAnimatable());
   }
 }

sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/animation/FadeAnimatable.java

@@ -0,0 +1,43 @@
+package com.dylanc.loadingstateview.sample.java.animation;
+
+import android.view.View;
+
+import androidx.annotation.NonNull;
+
+import com.dylanc.loadingstateview.LoadingStateView;
+import com.dylanc.loadingstateview.ViewType;
+
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * @author Dylan Cai
+ */
+public class FadeAnimatable implements LoadingStateView.Animatable {
+
+  private static final long DEFAULT_DURATION = 500;
+  private final long duration;
+
+  public FadeAnimatable() {
+    this(DEFAULT_DURATION);
+  }
+
+  public FadeAnimatable(long duration) {
+    this.duration = duration;
+  }
+
+  @Override
+  public void toggleViewsAnimation(@NonNull View showView, @NonNull View hideView, @NonNull Object showViewType, @NonNull Object hideViewType) {
+    showView.setAlpha(0);
+    showView.setVisibility(View.VISIBLE);
+    showView.animate().alpha(1).setDuration(duration);
+
+    if (showViewType == ViewType.LOADING && hideViewType == ViewType.CONTENT) {
+      hideView.setVisibility(View.GONE);
+    } else {
+      hideView.animate().alpha(0).setDuration(duration).withEndAction(() -> {
+        hideView.setAlpha(1);
+        hideView.setVisibility(View.GONE);
+      });
+    }
+  }
+}