Android持续滑动布局ConsecutiveScrollerLayout的使用

作者 : 开心源码 本文共16088个字,预计阅读时间需要41分钟 发布时间: 2022-05-13 共225人阅读

在开发项目的时候,有时候会遇到少量比较复杂的页面,需要多个不同的列表或者者滑动布局、甚至是WebView,组成一个完整的页面。要实现这样一个复杂的页面,在以前我们可能会通过布局嵌套的方式,在一个大的ScrollView下嵌套多个RecyclerView、WebView、ScrollView来实现。但是这种嵌套的方式不仅会严重影响布局的性能,而且解决滑动事件的冲突也是一件头疼的事,解决不好会严重影响客户操作的体验。ConsecutiveScrollerLayout正是为理解决这个难题而设计的滑动布局,它可以同时嵌套多个滑动布局(RecyclerView、WebView、ScrollView等)和普通控件(TextView、ImageView、LinearLayou、自己设置View等),它把所有的子View看作是一个整体,由ConsecutiveScrollerLayout来统一解决布局的滑动,使得多个滑动布局就像一个整体一样连续滑动,它的效果就像是一个ScrollView一样。而且它支持嵌套所有的View,具备很好的通用性。使用者不需要关心它是如何滑动的,也不需要考虑滑动的冲突问题,并且不用担心它会影响子View的性能。

下面是对ConsecutiveScrollerLayout的使用详情和一写注意事项。

项目地址: ConsecutiveScroller
ConsecutiveScroller的设计思路和源码分析:Android可持续滑动布局:ConsecutiveScrollerLayout

效果图

sample.gifsticky.gif

引入依赖

在Project的build.gradle在增加以下代码

allprojects {      repositories {         ...         maven { url 'https://jitpack.io' }      }   }

在Module的build.gradle在增加以下代码

implementation 'com.github.donkingliang:ConsecutiveScroller:2.6.2'

注意: 假如你准备使用这个库,请务必认真阅读下面的文档。它能让你理解ConsecutiveScrollerLayout可以实现的功能,以及避免不必要的错误。

基本使用

ConsecutiveScrollerLayout的使用非常简单,把需要滑动的布局作为ConsecutiveScrollerLayout的直接子View就可。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">    <WebView        android:id="@+id/webView"        android:layout_width="match_parent"        android:layout_height="match_parent" />    <LinearLayout        android:layout_width="match_parent"        android:layout_height="200dp"        android:background="@android:color/holo_red_dark"        android:gravity="center"        android:orientation="vertical">    </LinearLayout>    <androidx.core.widget.NestedScrollView        android:layout_width="match_parent"        android:layout_height="match_parent">    </androidx.core.widget.NestedScrollView>    <androidx.recyclerview.widget.RecyclerView        android:id="@+id/recyclerView1"        android:layout_width="match_parent"        android:layout_height="wrap_content" />    <ImageView        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:scaleType="fitXY"        android:src="@drawable/temp" />    <ScrollView        android:layout_width="match_parent"        android:layout_height="match_parent">    </ScrollView>  <!--  可以嵌套ConsecutiveScrollerLayout  -->  <com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout        android:layout_width="match_parent"        android:layout_height="match_parent"        android:background="@color/design_default_color_primary">        <TextView            android:layout_width="match_parent"            android:layout_height="wrap_content"            android:padding="10dp"            android:text=""            android:textColor="@android:color/black"            android:textSize="18sp" />        <androidx.recyclerview.widget.RecyclerView            android:id="@+id/recyclerView3"            android:layout_width="match_parent"            android:layout_height="match_parent" />    </com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

关于margin

ConsecutiveScrollerLayout支持左右margin,但是不支持上下margin,子View间的间距可以通过Space设置。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">    <!--  使用Space设置上下边距   -->    <Space        android:layout_width="0dp"        android:layout_height="20dp" />    <!--  ConsecutiveScrollerLayout支持左右margin,但是不支持上下margin   -->    <LinearLayout        android:layout_width="match_parent"        android:layout_height="200dp"        android:layout_marginLeft="20dp"        android:layout_marginRight="20dp"        android:background="@android:color/holo_red_dark"        android:gravity="center"        android:orientation="vertical">        <TextView            android:layout_width="wrap_content"            android:layout_height="wrap_content"            android:text="LinearLayout"            android:textColor="@android:color/black"            android:textSize="18sp" />    </LinearLayout>    <!--  使用Space设置上下边距   -->    <Space        android:layout_width="0dp"        android:layout_height="20dp" /></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

布局对齐方式

ConsecutiveScrollerLayout的布局方式相似于垂直的LinearLayout,但是它没有gravity和子view layout_gravity属性。ConsecutiveScrollerLayout为它的子view提供了layout_align属性,用于设置子view和父布局的对齐方式。layout_align有三个值:左对齐(LEFT) 、右对齐(RIGHT) 和中间对齐(CENTER)。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"                                                                    xmlns:app="http://schemas.android.com/apk/res-auto"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">      <TextView        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:background="@android:color/white"        android:padding="10dp"        android:text="吸顶View - 1"        android:textColor="@android:color/black"        android:textSize="18sp"        app:layout_isSticky="true"        app:layout_align="LEFT"/> // 对齐方式  </com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

嵌套Fragment

要想把一个Fragment嵌套在ConsecutiveScrollerLayout里。通常我们需要一个布局容器来承载我们的Fragment,或者者直接把Fragment写在activity的布局里。假如Fragment是垂直滑动的,那么承载Fragment的容器需要是ConsecutiveScrollerLayout,以及Fragment的根布局也需要是垂直滑动的。我们推荐使用ConsecutiveScrollerLayout或者者其余可垂直滑动的控件(比方:RecyclerView、NestedScrollView)作为Fragment的根布局。假如你的Fragment不是垂直滑动的,则可以忽略这个限制。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">    <!--  承载Fragment的容器  -->    <com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout        android:id="@+id/fragment_container"        android:layout_width="match_parent"        android:layout_height="match_parent"/>  <!--  MyFragment的根布局是垂直滑动控件  -->   <fragment       android:layout_width="match_parent"       android:layout_height="match_parent"       android:name="com.donkingliang.consecutivescrollerdemo.MyFragment"/></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

布局吸顶

要实现布局的吸顶效果,在以前,我们可能会写两个一摸一样的布局,一个隐藏在顶部,一个嵌套在ScrollView下,通过监听ScrollView的滑动来显示和隐藏顶部的布局。这种方式实现起来既麻烦也不优雅。ConsecutiveScrollerLayout内部实现了子View吸附顶部的功能,只需设置一个属性,即可以实现吸顶功能。而且支持设置多个子View吸顶,后面的View要吸顶时会把前面的吸顶View推出屏幕。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:app="http://schemas.android.com/apk/res-auto"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">  <!-- 设置app:layout_isSticky="true"即可以使View吸顶 -->    <TextView        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:background="@android:color/white"        android:padding="10dp"        android:text="吸顶View - 1"        android:textColor="@android:color/black"        android:textSize="18sp"        app:layout_isSticky="true" />    <WebView        android:id="@+id/webView"        android:layout_width="match_parent"        android:layout_height="match_parent" />    <LinearLayout        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:background="@android:color/white"        android:orientation="vertical"        app:layout_isSticky="true">        <TextView            android:layout_width="match_parent"            android:layout_height="wrap_content"            android:padding="10dp"            android:text="吸顶View - 2 我是个LinearLayout"            android:textColor="@android:color/black"            android:textSize="18sp" />    </LinearLayout>    <androidx.recyclerview.widget.RecyclerView        android:id="@+id/recyclerView1"        android:layout_width="match_parent"        android:layout_height="wrap_content" />    <TextView        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:background="@android:color/white"        android:padding="10dp"        android:text="吸顶View - 3"        android:textColor="@android:color/black"        android:textSize="18sp"        app:layout_isSticky="true" />    <androidx.core.widget.NestedScrollView        android:layout_width="match_parent"        android:layout_height="match_parent">    </androidx.core.widget.NestedScrollView>    <TextView        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:background="@android:color/white"        android:padding="10dp"        android:text="吸顶View - 4"        android:textColor="@android:color/black"        android:textSize="18sp"        app:layout_isSticky="true" />    <androidx.recyclerview.widget.RecyclerView        android:id="@+id/recyclerView2"        android:layout_width="match_parent"        android:layout_height="wrap_content" /></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

常驻吸顶

假如你不希望吸顶的view被后面的吸顶view顶出屏幕,而且多个吸顶view排列吸附在顶部,你可以设置常驻吸顶模式:app:isPermanent=”true”。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:app="http://schemas.android.com/apk/res-auto"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    app:isPermanent="true"  // 常驻吸顶    android:scrollbars="vertical"></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

关于吸顶功能的其余方法

// 设置吸顶到顶部的距离,在距离顶部肯定距离时开始悬停吸顶scrollerLayout.setStickyOffset(50);// 监听吸顶变化(普通模式)scrollerLayout.setOnStickyChangeListener(OnStickyChangeListener);// 监听吸顶变化(常驻模式)scrollerLayout.setOnPermanentStickyChangeListener(OnPermanentStickyChangeListener);// 获取当前吸顶view(普通模式)scrollerLayout.getCurrentStickyView(); // 获取当前吸顶view(常驻模式)scrollerLayout.getCurrentStickyViews();

局部滑动

ConsecutiveScrollerLayout将所有的子View视作一个整体,由它统一解决页面的滑动事件,所以它默认会阻拦可滑动的子View的滑动事件,由自己来分发解决。并且会追踪客户的手指滑动事件,计算调整ConsecutiveScrollerLayout滑动偏移。假如你希望某个子View自己解决自己的滑动事件,可以通过设置layout_isConsecutive属性来告诉父View不要阻拦它的滑动事件,这样即可以实现在这个View自己的高度内滑动自己的内容,而不会作为ConsecutiveScrollerLayout的一部分来解决。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:app="http://schemas.android.com/apk/res-auto"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">  <!--设置app:layout_isConsecutive="false"使父布局不阻拦滑动事件-->    <LinearLayout        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:orientation="vertical"        app:layout_isConsecutive="false">        <TextView            android:layout_width="match_parent"            android:layout_height="wrap_content"            android:padding="10dp"            android:text="下面的红色区域是个RecyclerView,它在自己的范围内单独滑动。"            android:textColor="@android:color/black"            android:textSize="18sp"            app:layout_isSticky="true" />        <androidx.recyclerview.widget.RecyclerView            android:id="@+id/recyclerView1"            android:layout_width="match_parent"            android:layout_height="300dp"            android:layout_marginLeft="50dp"            android:layout_marginRight="50dp"            android:layout_marginBottom="30dp"            android:background="@android:color/holo_red_dark"/>    </LinearLayout>    <TextView        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:padding="10dp"        android:text="下面的是个NestedScrollView,它在自己的范围内单独滑动。"        android:textColor="@android:color/black"        android:textSize="18sp" />    <androidx.core.widget.NestedScrollView        android:layout_width="match_parent"        android:layout_height="250dp"        app:layout_isConsecutive="false">    </androidx.core.widget.NestedScrollView></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

在这个例子中NestedScrollView希望在自己的高度里滑动自己的内容,而不是跟随ConsecutiveScrollerLayout滑动,只需给它设置layout_isConsecutive=”false”即可以了。而LinearLayout尽管不是滑动布局,但是在下面嵌套了个滑动布局RecyclerView,所以它也需要设置layout_isConsecutive=”false”。

ConsecutiveScrollerLayout支持NestedScrolling机制,假如你的局部滑动的view实现了NestedScrollingChild接口(如:RecyclerView、NestedScrollView等),它滑动完成后会把滑动事件交给父布局。假如你不想你的子view或者它的下级view与父布局嵌套滑动,可以给子view设置app:layout_isNestedScroll=”false”。它可以禁止子view与ConsecutiveScrollerLayout的嵌套滑动

滑动子view的下级view

ConsecutiveScrollerLayout默认情况下只会解决它的直接子view的滑动,但有时候需要滑动的布局可能不是ConsecutiveScrollerLayout的直接子view,而是子view所嵌套的下级view。比方ConsecutiveScrollerLayout嵌套FrameLayout,FrameLayout嵌套ScrollView,我们希望ConsecutiveScrollerLayout也能正常解决ScrollView的滑动。为了支持这种需求,ConsecutiveScroller提供了一个接口:IConsecutiveScroller。子view实现IConsecutiveScroller接口,并通过实现接口方法告诉ConsecutiveScrollerLayout需要滑动的下级view,ConsecutiveScrollerLayout就能正确地解决它的滑动事件。IConsecutiveScroller需要实现两个方法:

    /**     * 返回当前需要滑动的下级view。在一个时间点里只能有一个view可以滑动。     */    View getCurrentScrollerView();    /**     * 返回所有可以滑动的子view。因为ConsecutiveScrollerLayout允许它的子view包含多个可滑动的子view,所以返回一个view列表。     */    List<View> getScrolledViews();

在前面提到的例子中,我们可以这样实现:

public class MyFrameLayout extends FrameLayout implements IConsecutiveScroller {    @Override    public View getCurrentScrollerView() {        // 返回需要滑动的ScrollView        return getChildAt(0);    }    @Override    public List<View> getScrolledViews() {        // 返回需要滑动的ScrollView        List<View> views = new ArrayList<>();        views.add(getChildAt(0));        return views;    }}
<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:app="http://schemas.android.com/apk/res-auto"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">    <com.donkingliang.consecutivescrollerdemo.widget.MyFrameLayout        android:layout_width="match_parent"        android:layout_height="match_parent">        <ScrollView            android:layout_width="match_parent"            android:layout_height="match_parent">            <LinearLayout                android:layout_width="match_parent"                android:layout_height="match_parent">            </LinearLayout>        </ScrollView>    </com.donkingliang.consecutivescrollerdemo.widget.MyFrameLayout></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

这样ConsecutiveScrollerLayout就能正确地解决ScrollView的滑动。这是一个简单的例子,在实际的需求中,我们一般不需要这样做。

注意:

1、getCurrentScrollerView()和getScrolledViews()必需正确地返回需要滑动的view,这些view可以是经过多层嵌套的,不肯定是直接子view。所以使用者应该按照自己的实际场景去实现者两个方法。

2、滑动的控件应该跟嵌套它的子view的高度保持一致,也就是说滑动的控件高度应该是match_parent,并且包裹它的子view和它本身都不要设置上下边距(margin和ppadding)。宽度没有这个限制。

对ViewPager的支持

假如你的ViewPager承载的子布局(或者Fragment)不是可以垂直滑动的,那么使用普通的ViewPager就可。假如是可以垂直滑动的,那么你的ViewPager需要实现IConsecutiveScroller接口,并返回需要滑动的view对象。框架里提供了一个实现了IConsecutiveScroller接口自己设置控件:ConsecutiveViewPager。使用这个控件,而后你的ConsecutiveViewPager的子view(或者Fragment的根布局)是可垂直滑动的view,如:RecyclerView、NestedScrollView、ConsecutiveScrollerLayout就可。这样你的ViewPager就能正确地跟ConsecutiveScrollerLayout一起滑动了。

<?xml version="1.0" encoding="utf-8"?><com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:app="http://schemas.android.com/apk/res-auto"    android:id="@+id/scrollerLayout"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:scrollbars="vertical">    <com.google.android.material.tabs.TabLayout        android:id="@+id/tabLayout"        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:background="@android:color/white"        app:tabGravity="fill"        app:tabIndicatorColor="@color/colorPrimary"        app:tabIndicatorHeight="3dp"        app:tabMode="scrollable"        app:tabSelectedTextColor="@color/colorPrimary" />    <com.donkingliang.consecutivescroller.ConsecutiveViewPager        android:id="@+id/viewPager"        android:layout_width="match_parent"        android:layout_height="match_parent" /></com.donkingliang.consecutivescroller.ConsecutiveScrollerLayout>

布局吸顶时会覆盖在下面的布局的上面,有时候我们希望TabLayout吸顶悬浮在顶部,但是不希望它覆盖遮挡ViewPager的内容。ConsecutiveViewPager提供了setAdjustHeight调整自己的布局高度,让自己不被TabLayout覆盖。注意:只有ConsecutiveScrollerLayout是ConsecutiveScrollerLayout的最低部时才能这样做。

// 保证能获取到tabLayout的高度tabLayout.post(new Runnable() {    @Override    public void run() {        viewPager.setAdjustHeight(tabLayout.getHeight());    }});

其余注意事项

1、WebView在加载的过程中假如滑动的布局,可能会导致WebView与其余View在显示上断层,使用下面的方法肯定程度上可以避免这个问题。

webView.setWebChromeClient(new WebChromeClient() {            @Override            public void onProgressChanged(WebView view, int newProgress) {                super.onProgressChanged(view, newProgress);                scrollerLayout.checkLayoutChange();            }        });

2、SmartRefreshLayout和SwipeRefreshLayout等刷新控件可以嵌套ConsecutiveScrollerLayout实现下拉刷新功能,但是ConsecutiveScrollerLayout内部嵌套它们来刷新子view,由于子view时ConsecutiveScrollerLayout滑动内容等一部分。除非你给SmartRefreshLayout或者者SwipeRefreshLayout设置app:layout_isConsecutive=”false”。

3、继承AbsListView的布局(ListView、GridView等),在滑动上可能会与客户的手指滑动不同步,推荐使用RecyclerView代替。

4、ConsecutiveScroller的minSdkVersion是19,假如你的项目支持19以下,可以设置:

<uses-sdk tools:overrideLibrary="com.donkingliang.consecutivescroller"/>

但是不要在minSdkVersion小于19的项目使用AbsListView的子类,由于ConsecutiveScrollerLayout使用了只有19以上才有的AbsListView API。

5、使用ConsecutiveScrollerLayout提供的setOnVerticalScrollChangeListener()方法监听布局的滑动事件。View所提供的setOnScrollChangeListener()方法已无效。

6、通过getOwnScrollY()方法获取ConsecutiveScrollerLayout的垂直滑动距离,View的getScrollY()方法获取的不是ConsecutiveScrollerLayout的整体滑动距离。

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » Android持续滑动布局ConsecutiveScrollerLayout的使用

发表回复