Optimize some method names

Author: DylanCaiCoding

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

@@ -22,77 +22,65 @@ import android.view.ViewGroup
 import androidx.annotation.StringRes
 import androidx.fragment.app.Fragment
 
-interface LoadingState : LoadingStateView.OnReloadListener {
-  fun Activity.decorateContentView(isDecorated: Boolean = true)
-  fun View.decorateWithLoadingState(isDecorated: Boolean = true): View
+interface LoadingState {
+  fun Activity.decorateContentView(listener: OnReloadListener, isDecorated: Boolean = true)
+  fun View.decorate(listener: OnReloadListener, isDecorated: Boolean = true): View
   fun registerView(vararg viewDelegates: LoadingStateView.ViewDelegate)
   fun Activity.setToolbar(@StringRes titleId: Int, navBtnType: NavBtnType = NavBtnType.ICON, block: (ToolbarConfig.() -> Unit)? = null)
   fun Activity.setToolbar(title: String? = null, navBtnType: NavBtnType = NavBtnType.ICON, block: (ToolbarConfig.() -> Unit)? = null)
   fun Fragment.setToolbar(@StringRes titleId: Int, navBtnType: NavBtnType = NavBtnType.ICON, block: (ToolbarConfig.() -> Unit)? = null)
   fun Fragment.setToolbar(title: String? = null, navBtnType: NavBtnType = NavBtnType.ICON, block: (ToolbarConfig.() -> Unit)? = null)
   fun Activity.setHeaders(vararg delegates: LoadingStateView.ViewDelegate)
   fun Fragment.setHeaders(vararg delegates: LoadingStateView.ViewDelegate)
-  fun <T : LoadingStateView.ViewDelegate> updateView(viewType: Any, block: T.() -> Unit)
-  fun Activity.updateToolbar(block: ToolbarConfig.() -> Unit)
-  fun Fragment.updateToolbar(block: ToolbarConfig.() -> Unit)
   fun showLoadingView()
   fun showContentView()
   fun showErrorView()
   fun showEmptyView()
   fun showCustomView(viewType: Any)
+  fun updateToolbar(block: ToolbarConfig.() -> Unit)
+  fun <T : LoadingStateView.ViewDelegate> updateView(viewType: Any, block: T.() -> Unit)
 }
 
 class LoadingStateImpl : LoadingState {
   private var loadingStateView: LoadingStateView? = null
 
-  override fun Activity.decorateContentView(isDecorated: Boolean) {
-    findViewById<ViewGroup>(android.R.id.content).getChildAt(0)
-      .decorateWithLoadingState(isDecorated)
+  override fun Activity.decorateContentView(listener: OnReloadListener, isDecorated: Boolean) {
+    findViewById<ViewGroup>(android.R.id.content).getChildAt(0).decorate(listener, isDecorated)
   }
 
-  override fun View.decorateWithLoadingState(isDecorated: Boolean): View {
-    return if (isDecorated) {
-      LoadingStateView(this).apply {
-        setOnReloadListener(::onReload)
-        loadingStateView = this
-      }.decorView
+  override fun View.decorate(listener: OnReloadListener, isDecorated: Boolean): View =
+    if (isDecorated) {
+      LoadingStateView(this, listener).also { loadingStateView = it }.decorView
     } else {
       this
     }
-  }
 
   override fun registerView(vararg viewDelegates: LoadingStateView.ViewDelegate) {
     loadingStateView?.register(*viewDelegates)
   }
 
-  override fun Activity.setToolbar(@StringRes titleId: Int, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) =
+  override fun Activity.setToolbar(@StringRes titleId: Int, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) {
     setToolbar(getString(titleId), navBtnType, block)
+  }
 
-  override fun Activity.setToolbar(title: String?, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) =
+  override fun Activity.setToolbar(title: String?, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) {
     setHeaders(ToolbarViewDelegate(title, navBtnType, block))
+  }
 
-  override fun Fragment.setToolbar(@StringRes titleId: Int, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) =
+  override fun Fragment.setToolbar(@StringRes titleId: Int, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) {
     setToolbar(getString(titleId), navBtnType, block)
+  }
 
-  override fun Fragment.setToolbar(title: String?, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) =
+  override fun Fragment.setToolbar(title: String?, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) {
     setHeaders(ToolbarViewDelegate(title, navBtnType, block))
+  }
 
   override fun Activity.setHeaders(vararg delegates: LoadingStateView.ViewDelegate) {
-    loadingStateView?.setDecorHeader(*delegates)
+    loadingStateView?.setHeaders(*delegates)
   }
 
   override fun Fragment.setHeaders(vararg delegates: LoadingStateView.ViewDelegate) {
-    loadingStateView?.addChildDecorHeader(*delegates)
-  }
-
-  override fun Activity.updateToolbar(block: ToolbarConfig.() -> Unit) =
-    updateView<ToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }
-
-  override fun Fragment.updateToolbar(block: ToolbarConfig.() -> Unit) =
-    updateView<ToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }
-
-  override fun <T : LoadingStateView.ViewDelegate> updateView(viewType: Any, block: T.() -> Unit) {
-    loadingStateView?.getViewDelegate<T>(viewType)?.apply(block)
+    loadingStateView?.addChildHeaders(*delegates)
   }
 
   override fun showLoadingView() {
@@ -115,5 +103,11 @@ class LoadingStateImpl : LoadingState {
     loadingStateView?.showView(viewType)
   }
 
-  override fun onReload() = Unit
+  override fun updateToolbar(block: ToolbarConfig.() -> Unit) {
+    updateView<ToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }
+  }
+
+  override fun <T : LoadingStateView.ViewDelegate> updateView(viewType: Any, block: T.() -> Unit) {
+    loadingStateView?.getViewDelegate<T>(viewType)?.apply(block)
+  }
 }

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

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2019. Dylan Cai
+ *
+ * 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.
+ */
+
 @file:Suppress("unused")
 
 package com.dylanc.loadingstateview

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

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2019. Dylan Cai
+ *
+ * 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.
+ */
+
 @file:Suppress("unused")
 
 package com.dylanc.loadingstateview

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

@@ -32,23 +32,24 @@ import java.util.*
 /**
  * @author Dylan Cai
  */
-class LoadingStateView(private val contentView: View) {
+class LoadingStateView @JvmOverloads constructor(
+  private val contentView: View,
+  var onReloadListener: OnReloadListener? = null
+) {
   lateinit var decorView: View private set
   lateinit var currentViewType: Any private set
   private lateinit var contentParent: ViewGroup
   private val parent: ViewGroup?
   private var currentView: View? = null
-  private var onReloadListener: OnReloadListener? = null
   private var viewDelegates: HashMap<Any, ViewDelegate> = HashMap()
   private val viewCashes: HashMap<Any, View> = HashMap()
 
   /**
-   * Constructs a LoadingStateView with a activity and a content view delegate
-   *
-   * @param activity the activity
+   * Constructs a LoadingStateView with an activity
    */
-  constructor(activity: Activity) :
-      this(activity.findViewById<ViewGroup>(android.R.id.content).getChildAt(0))
+  @JvmOverloads
+  constructor(activity: Activity, listener: OnReloadListener? = null) :
+      this(activity.findViewById<ViewGroup>(android.R.id.content).getChildAt(0), listener)
 
   init {
     viewDelegatePool?.apply { ViewDelegatePool(this@LoadingStateView).invoke() }
@@ -57,6 +58,17 @@ class LoadingStateView(private val contentView: View) {
     setDecorView(LinearDecorViewDelegate(emptyList()))
   }
 
+  /**
+   * Adds one or more views to decorate content in the header.
+   *
+   * @param delegates the view delegates of creating view
+   */
+  fun setHeaders(vararg delegates: ViewDelegate) =
+    setDecorView(LinearDecorViewDelegate(delegates.map {
+      register(it)
+      getView(it.viewType)
+    }))
+
   /**
    * Sets an view delegate for decorating content view.
    *
@@ -82,12 +94,12 @@ class LoadingStateView(private val contentView: View) {
   }
 
   /**
-   * Adds one or more views to decorate content in the header.
+   * Adds child decorative header between the content and the decorative view.
    *
    * @param delegates the view delegates of creating view
    */
-  fun setDecorHeader(vararg delegates: ViewDelegate) =
-    setDecorView(LinearDecorViewDelegate(delegates.map {
+  fun addChildHeaders(vararg delegates: ViewDelegate) =
+    addChildDecorView(LinearDecorViewDelegate(delegates.map {
       register(it)
       getView(it.viewType)
     }))
@@ -106,17 +118,6 @@ class LoadingStateView(private val contentView: View) {
     showView(ViewType.CONTENT)
   }
 
-  /**
-   * Adds child decorative header between the content and the decorative view.
-   *
-   * @param delegates the view delegates of creating view
-   */
-  fun addChildDecorHeader(vararg delegates: ViewDelegate) =
-    addChildDecorView(LinearDecorViewDelegate(delegates.map {
-      register(it)
-      getView(it.viewType)
-    }))
-
   private fun DecorViewDelegate.createDecorView() =
     onCreateDecorView(LayoutInflater.from(contentView.context)).also { decorView ->
       contentView.layoutParams?.let { decorView.layoutParams = it }
@@ -125,21 +126,12 @@ class LoadingStateView(private val contentView: View) {
   /**
    * Registers the view delegate of creating view before showing view.
    *
-   * @param viewDelegate  the view delegate of creating view
+   * @param delegates the view delegate of creating view
    */
   fun register(vararg delegates: ViewDelegate) {
     delegates.forEach { viewDelegates[it.viewType] = it }
   }
 
-  /**
-   * Called if you need to handle reload event, you can get the listener of reloading data from view holder.
-   *
-   * @param onReloadListener the listener of reloading data
-   */
-  fun setOnReloadListener(onReloadListener: OnReloadListener) {
-    this.onReloadListener = onReloadListener
-  }
-
   @JvmOverloads
   fun showLoadingView(animation: Animation? = null) = showView(ViewType.LOADING, animation)
 
@@ -163,21 +155,25 @@ class LoadingStateView(private val contentView: View) {
     if (currentView == null) {
       addView(viewType)
     } else {
-      viewCashes[viewType]?.let { addView(viewType) }
+      if (viewCashes[viewType] == null) addView(viewType)
       if (viewType != currentViewType) {
-        getView(viewType).visibility = View.VISIBLE
+        val view = getView(viewType)
+        view.visibility = View.VISIBLE
         if (animation != null) {
           animation.onStartHideAnimation(currentView, currentViewType)
-          animation.onStartShowAnimation(getView(viewType), getViewDelegate<ViewDelegate>(viewType).viewType)
+          animation.onStartShowAnimation(view, getViewDelegate<ViewDelegate>(viewType).viewType)
         } else {
           currentView.visibility = View.GONE
         }
-        this.currentView = getView(viewType)
+        this.currentView = view
       }
     }
     currentViewType = viewType
   }
 
+  @Suppress("UNCHECKED_CAST")
+  fun <T : ViewDelegate> getViewDelegate(viewType: Any) = viewDelegates[viewType] as T
+
   private fun addView(viewType: Any) {
     val view = getView(viewType)
     if (view.parent != null) {
@@ -195,21 +191,14 @@ class LoadingStateView(private val contentView: View) {
 
   private fun getView(viewType: Any): View {
     if (viewCashes[viewType] == null) {
-      addViewHolder(viewType)
+      val viewDelegate: ViewDelegate = getViewDelegate(viewType)
+      val view = viewDelegate.onCreateView(LayoutInflater.from(contentParent.context), contentParent)
+      viewDelegate.onReloadListener = onReloadListener
+      viewCashes[viewType] = view
     }
     return viewCashes[viewType]!!
   }
 
-  @Suppress("UNCHECKED_CAST")
-  fun <T : ViewDelegate> getViewDelegate(viewType: Any) = viewDelegates[viewType] as T
-
-  private fun addViewHolder(viewType: Any) {
-    val viewDelegate: ViewDelegate = getViewDelegate(viewType)
-    val view = viewDelegate.onCreateView(LayoutInflater.from(contentParent.context), contentParent)
-    viewDelegate.onReloadListener = onReloadListener
-    viewCashes[viewType] = view
-  }
-
   abstract class ViewDelegate(val viewType: Any) {
     var onReloadListener: OnReloadListener? = null
       internal set
@@ -223,7 +212,6 @@ class LoadingStateView(private val contentView: View) {
 
   abstract class DecorViewDelegate {
     abstract fun onCreateDecorView(inflater: LayoutInflater): View
-
     abstract fun getContentParent(decorView: View): ViewGroup
   }
 
@@ -246,17 +234,12 @@ class LoadingStateView(private val contentView: View) {
     fun register(vararg delegates: ViewDelegate) = stateView.register(*delegates)
   }
 
-  fun interface OnReloadListener {
-    fun onReload()
-  }
-
   fun interface Callback<in T> {
     fun T.invoke()
   }
 
   interface Animation {
     fun onStartShowAnimation(view: View, viewType: Any)
-
     fun onStartHideAnimation(view: View, viewType: Any)
   }
 
@@ -270,6 +253,10 @@ class LoadingStateView(private val contentView: View) {
   }
 }
 
+fun interface OnReloadListener {
+  fun onReload()
+}
+
 enum class ViewType {
   TITLE, LOADING, CONTENT, ERROR, EMPTY
 }

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

@@ -20,6 +20,7 @@
 
 import com.dylanc.loadingstateview.LoadingStateView;
 import com.dylanc.loadingstateview.ViewType;
+import com.dylanc.loadingstateview.sample.java.animation.FadeAnimation;
 import com.dylanc.loadingstateview.sample.java.delegate.EmptyViewDelegate;
 import com.dylanc.loadingstateview.sample.java.delegate.ErrorViewDelegate;
 import com.dylanc.loadingstateview.sample.java.delegate.LoadingViewDelegate;

sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/base/BaseActivity.java

@@ -25,7 +25,7 @@
 
 /**
  * 这是耦合度较低的封装方式，没有任何抽象方法，可以很方便地将基类里的代码拷贝到其它项目的基类里使用。
- *
+ * <p>
  * 使用该基类时注意以下事项：
  * 1. 显示对应视图之前需要注册适配器，可以设置全局适配器，某个页面想修改样式时再注册个新的适配器。
  * 2. 设置标题栏的方法应该根据项目需要进行编写，下面提供了参考示例。
@@ -45,11 +45,10 @@ public void setContentView(int layoutResID) {
   public void setContentView(int layoutResID, @IdRes int contentViewId) {
     super.setContentView(layoutResID);
     if (contentViewId == 0) {
-      loadingStateView = new LoadingStateView(this);
+      loadingStateView = new LoadingStateView(this, this::onReload);
     } else {
       loadingStateView = new LoadingStateView(findViewById(contentViewId));
     }
-    loadingStateView.setOnReloadListener(this::onReload);
   }
 
   /**
@@ -64,7 +63,7 @@ public void setToolbar(String title, NavIconType type) {
   }
 
   public void setToolbar(String title, NavIconType type, int menuId) {
-    loadingStateView.setDecorHeader(new ToolbarViewDelegate(title, type, menuId, this::onOptionsItemSelected));
+    loadingStateView.setHeaders(new ToolbarViewDelegate(title, type, menuId, this::onOptionsItemSelected));
   }
 
   public void showLoadingView() {