完善配置功能

Author: xiazunyang

README.md

@@ -25,8 +25,9 @@ try {
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     app:stateful_failure_layout="@layout/state_failure_layout">
-        
-    <!--默认是success状态-->
+    <!--注意上方的stateful_failure_layout属性，它引用了另外一个布局作为自己的failure状态下的视图-->
+
+    <!--没有指定state，则默认是success状态-->
     <RecyclerView
         android:layout_width="match_parent"
         android:layout_height="match_parent" />
@@ -45,18 +46,27 @@ try {
         app:stateful_animation_show="@anim/stateful_loading_show"
         app:stateful_animation_hide="@anim/stateful_loading_hide"
         app:layout_state="loading" />
-    
+
 </StatefulLayout>
 ```
-*  如果想统一修改除success以外所有状态的默认视图，可在当前正在应用的主题资源中指定：
+*  如果想统一修改除success以外所有状态的默认视图，可在当前正在应用的主题资源中添加以下属性并指定新的`Style`:
 ```xml
-<!--默认视图-->
-<item="stateful_empty_layout">@layout/state_empty_layout</item>
-<item="stateful_loading_layout">@layout/state_loading_layout</item>
-<item="stateful_failure_layout">@layout/state_failure_layout</item>
-<!--包括默认动画效果-->
-<item="stateful_animation_show">@layout/state_show_anim</item>
-<item="stateful_animation_hide">@layout/state_hide_anim</item>
+<style name="...">
+    ...
+    <!--为statefulLayoutStyle属性设置新的样式-->
+    <item name="statefulLayoutStyle">@style/ExampleStatefulLayoutStyle</item>
+</style>
+
+<!--添加新的样式，继承自默认的样式-->
+<style name="ExampleStatefulLayoutStyle" parent="StatefulLayoutStyle">
+    <!--修改默认视图-->
+    <item name="stateful_empty_layout">@layout/empty_layout</item>
+    <item name="stateful_loading_layout">@layout/loading_layout</item>
+    <item name="stateful_failure_layout">@layout/failure_layout</item>
+    <!--修改默认动画效果-->
+    <item="stateful_animation_show">@layout/state_show_anim</item>
+    <item="stateful_animation_hide">@layout/state_hide_anim</item>
+</style>
 ```
 
 ### 引入

build.gradle

@@ -1,7 +1,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 buildscript {
     ext {
-        kotlin_version = '1.4.32'
+        kotlin_version = '1.5.21'
         compile_sdk_version = 30
         target_sdk_version = 30
     }
@@ -10,7 +10,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath "com.android.tools.build:gradle:4.1.3"
+        classpath "com.android.tools.build:gradle:4.2.2"
         classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-bin.zip

stateful.layout/build.gradle

@@ -1,6 +1,5 @@
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-parcelize'
 apply plugin: 'com.github.dcendents.android-maven'
 
 group = 'com.github.xiazunyang'

stateful.layout/src/main/java/cn/numeron/stateful/layout/StatefulLayout.kt

@@ -2,123 +2,132 @@ package cn.numeron.stateful.layout
 
 import android.content.Context
 import android.util.AttributeSet
+import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
 import android.view.animation.AnimationUtils
 import android.widget.FrameLayout
 import cn.numeron.common.State
 
-class StatefulLayout @JvmOverloads constructor(c: Context, a: AttributeSet? = null, i: Int = 0) : FrameLayout(c, a, i) {
-
-    private var previousState: State? = null
+class StatefulLayout @JvmOverloads constructor(
+    c: Context,
+    a: AttributeSet? = null,
+    i: Int = R.attr.statefulLayoutStyle,
+    s: Int = R.style.StatefulLayoutStyle
+) : FrameLayout(c, a, i, s) {
 
     var state: State = State.Empty
         set(value) {
             if (value != field) {
-                previousState = field
                 field = value
             }
             changeView()
         }
 
-    private val emptyViews
-        get() = findChildrenByState(State.Empty)
-
-    private val loadingViews
-        get() = findChildrenByState(State.Loading)
-
-    private val failureViews
-        get() = findChildrenByState(State.Failure)
-
-    private val contentViews
-        get() = findChildrenByState(State.Success)
-
-    private val defaultState: Int
     private val emptyLayoutId: Int
     private val loadingLayoutId: Int
     private val failureLayoutId: Int
 
-    private var animationEnabled: Boolean
+    private var animationEnabled = true
 
     init {
-        val tArray = c.obtainStyledAttributes(a, R.styleable.StatefulLayout)
+        val tArray = c.obtainStyledAttributes(a, R.styleable.StatefulLayout, i, s)
 
         emptyLayoutId = tArray.getResourceId(
             R.styleable.StatefulLayout_stateful_empty_layout,
             R.layout.state_empty_layout
         )
-
         failureLayoutId = tArray.getResourceId(
             R.styleable.StatefulLayout_stateful_failure_layout,
             R.layout.state_failure_layout
         )
-
         loadingLayoutId = tArray.getResourceId(
             R.styleable.StatefulLayout_stateful_loading_layout,
             R.layout.state_loading_layout
         )
 
-        //分配默认状态
-        defaultState = tArray.getInt(R.styleable.StatefulLayout_state, 0)
+        //获取默认状态
+        val defaultState = tArray.getInt(R.styleable.StatefulLayout_state, 0)
+        //设置默认的状态
+        state = State.values().first {
+            it.ordinal == defaultState
+        }
         //是否启动状态切换动画
-        animationEnabled = tArray.getBoolean(R.styleable.StatefulLayout_animation_enabled, true)
+        animationEnabled =
+            tArray.getBoolean(R.styleable.StatefulLayout_animation_enabled, animationEnabled)
 
         tArray.recycle()
     }
 
     override fun onFinishInflate() {
         super.onFinishInflate()
-        if (emptyViews.isEmpty()) {
-            View.inflate(context, emptyLayoutId, this)
+        //根据拥有的状态，决定加载剩余的状态布局
+        val (hasEmpty, hasLoading, hasFailure) = checkState()
+        val inflater = LayoutInflater.from(context)
+        if (!hasEmpty) {
+            val emptyLayout = inflater.inflate(emptyLayoutId, this, false)
+            addView(emptyLayout, resetLayoutParamsState(emptyLayout, State.Empty))
         }
-        if (loadingViews.isEmpty()) {
-            View.inflate(context, loadingLayoutId, this)
+        if (!hasLoading) {
+            val loadingLayout = inflater.inflate(loadingLayoutId, this, false)
+            addView(loadingLayout, resetLayoutParamsState(loadingLayout, State.Loading))
         }
-        if (failureViews.isEmpty()) {
-            View.inflate(context, failureLayoutId, this)
+        if (!hasFailure) {
+            val failureLayout = inflater.inflate(failureLayoutId, this, false)
+            addView(failureLayout, resetLayoutParamsState(failureLayout, State.Failure))
         }
-        state = State.values().first {
-            it.ordinal == defaultState
+    }
+
+    private fun checkState(): Triple<Boolean, Boolean, Boolean> {
+        var hasEmpty = false
+        var hasLoading = false
+        var hasFailure = false
+        repeat(childCount) {
+            val childView = getChildAt(it)
+            val layoutParams = childView.layoutParams as LayoutParams
+            val state = layoutParams.state
+            if (!hasEmpty) {
+                hasEmpty = state == State.Empty
+            }
+            if (!hasLoading) {
+                hasLoading = state == State.Loading
+            }
+            if (!hasFailure) {
+                hasFailure = state == State.Failure
+            }
         }
+        return Triple(hasEmpty, hasLoading, hasFailure)
     }
 
-    private fun findChildrenByState(state: State): List<View> {
-        return (0..childCount)
-            .mapNotNull(::getChildAt)
-            .filter {
-                val layoutParams = it.layoutParams
-                layoutParams is LayoutParams && layoutParams.state == state
+    private fun resetLayoutParamsState(view: View, state: State): LayoutParams {
+        val oldLayoutParams = view.layoutParams
+        if (oldLayoutParams is LayoutParams) {
+            if (oldLayoutParams.state != state) {
+                oldLayoutParams.state = state
             }
+            return oldLayoutParams
+        }
+        val layoutParams = generateLayoutParams(oldLayoutParams)
+        layoutParams.state = state
+        return layoutParams
     }
 
     private fun changeView() {
-        if (previousState != State.Loading && state == State.Loading) {
-            loadingViews.forEach(::show)
-        } else {
-            loadingViews.forEach(::hide)
-        }
-        if (previousState != State.Success && state == State.Success) {
-            contentViews.forEach(::show)
-        } else {
-            contentViews.forEach(::hide)
-        }
-        if (previousState != State.Failure && state == State.Failure) {
-            failureViews.forEach(::show)
-        } else {
-            failureViews.forEach(::hide)
-        }
-        if (previousState != State.Empty && state == State.Empty) {
-            emptyViews.forEach(::show)
-        } else {
-            emptyViews.forEach(::hide)
+        repeat(childCount) { index ->
+            val childView = getChildAt(index)
+            val childLayoutParams = childView.layoutParams as LayoutParams
+            if (childLayoutParams.state == this.state) {
+                show(childView, childLayoutParams)
+            } else {
+                hide(childView, childLayoutParams)
+            }
         }
     }
 
-    private fun show(view: View) {
+    private fun show(view: View, layoutParams: LayoutParams) {
         if (view.visibility != VISIBLE) {
             view.visibility = VISIBLE
-            val layoutParams = view.layoutParams
-            if (animationEnabled && layoutParams is LayoutParams) {
+            if (animationEnabled) {
                 view.clearAnimation()
                 view.startAnimation(
                     AnimationUtils.loadAnimation(
@@ -130,11 +139,10 @@ class StatefulLayout @JvmOverloads constructor(c: Context, a: AttributeSet? = nu
         }
     }
 
-    private fun hide(view: View) {
-        if (view.visibility != GONE) {
-            view.visibility = GONE
-            val layoutParams = view.layoutParams
-            if (animationEnabled && layoutParams is LayoutParams) {
+    private fun hide(view: View, layoutParams: LayoutParams) {
+        if (view.visibility == VISIBLE) {
+            view.visibility = if (layoutParams.invisible) INVISIBLE else GONE
+            if (animationEnabled) {
                 view.clearAnimation()
                 view.startAnimation(
                     AnimationUtils.loadAnimation(
@@ -146,61 +154,77 @@ class StatefulLayout @JvmOverloads constructor(c: Context, a: AttributeSet? = nu
         }
     }
 
-    override fun generateDefaultLayoutParams(): FrameLayout.LayoutParams {
+    override fun checkLayoutParams(p: ViewGroup.LayoutParams?): Boolean {
+        return p is LayoutParams
+    }
+
+    override fun generateDefaultLayoutParams(): LayoutParams {
         return LayoutParams(
             ViewGroup.LayoutParams.MATCH_PARENT,
             ViewGroup.LayoutParams.MATCH_PARENT
         )
     }
 
-    override fun generateLayoutParams(attrs: AttributeSet?): FrameLayout.LayoutParams {
+    override fun generateLayoutParams(attrs: AttributeSet?): LayoutParams {
         return LayoutParams(context, attrs)
     }
 
-    override fun generateLayoutParams(lp: ViewGroup.LayoutParams?): ViewGroup.LayoutParams {
+    override fun generateLayoutParams(lp: ViewGroup.LayoutParams?): LayoutParams {
         return when (lp) {
-            is LayoutParams -> LayoutParams(lp)
             is MarginLayoutParams -> LayoutParams(lp)
             is ViewGroup.LayoutParams -> LayoutParams(lp)
             else -> generateDefaultLayoutParams()
         }
     }
 
-    inner class LayoutParams : FrameLayout.LayoutParams {
+    override fun addView(child: View, index: Int, params: ViewGroup.LayoutParams) {
+        super.addView(child, index, params)
+        if (params is LayoutParams) {
+            //根据当前的状态与child的布局属性，决定child是否显示
+            child.visibility = when {
+                state == params.state -> VISIBLE
+                params.invisible -> INVISIBLE
+                else -> GONE
+            }
+        }
+    }
+
+    class LayoutParams : FrameLayout.LayoutParams {
 
-        val state: State
+        var invisible = false
+        var state = State.Success
         var showAnimationResId = R.anim.anim_state_layout_show
         var hideAnimationResId = R.anim.anim_state_layout_hide
 
         constructor(context: Context, attrs: AttributeSet?) : super(context, attrs) {
             val typedArray =
                 context.obtainStyledAttributes(attrs, R.styleable.StatefulLayout_Layout)
+            invisible = typedArray.getBoolean(
+                R.styleable.StatefulLayout_Layout_stateful_invisible,
+                invisible
+            )
             val stateValue = typedArray.getInt(R.styleable.StatefulLayout_Layout_layout_state, 3)
-            this.state = State.values()[stateValue]
-            showAnimationResId = typedArray.getResourceId(R.styleable.StatefulLayout_Layout_stateful_animation_show, showAnimationResId)
-            hideAnimationResId = typedArray.getResourceId(R.styleable.StatefulLayout_Layout_stateful_animation_hide, hideAnimationResId)
+            state = State.values()[stateValue]
+            showAnimationResId = typedArray.getResourceId(
+                R.styleable.StatefulLayout_Layout_stateful_animation_show,
+                showAnimationResId
+            )
+            hideAnimationResId = typedArray.getResourceId(
+                R.styleable.StatefulLayout_Layout_stateful_animation_hide,
+                hideAnimationResId
+            )
             typedArray.recycle()
         }
 
-        constructor(width: Int, height: Int, s: State) : super(width, height) {
-            this.state = s
+        constructor(width: Int, height: Int, state: State) : super(width, height) {
+            this.state = state
         }
 
-        constructor(width: Int, height: Int) : this(width, height, State.Success)
+        constructor(width: Int, height: Int) : super(width, height)
 
-        constructor(source: ViewGroup.LayoutParams) : super(source) {
-            this.state = State.Success
-        }
-
-        constructor(source: MarginLayoutParams) : super(source) {
-            this.state = State.Success
-        }
+        constructor(source: ViewGroup.LayoutParams) : super(source)
 
-        constructor(source: LayoutParams) : super(source) {
-            this.state = source.state
-            this.showAnimationResId = source.showAnimationResId
-            this.hideAnimationResId = source.hideAnimationResId
-        }
+        constructor(source: MarginLayoutParams) : super(source)
 
     }
 

stateful.layout/src/main/res/layout/state_empty_layout.xml

@@ -4,5 +4,5 @@
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     android:gravity="center"
-    android:text="@string/stateful_empty"
+    android:text="@string/stateful_layout_empty"
     app:layout_state="empty" />