Android SwipeRefreshLayout超詳細講解

1. 控件說明

SwipeRefreshLayout是google官方推薦使用的下拉刷新的控件,如果用戶想通過垂直滑動手勢刷新視圖的內容,就可以使用它。

實例化此控件的Activity應添加一個 OnRefreshListener,以便在完成滑動刷新手勢時收到通知。 SwipeRefreshLayout 會在每次手勢再次完成時通知監聽器,監聽器負責確定何時實際啟動其內容的刷新。如果監聽器不需要有刷新動作,通過調用 setRefreshing(false) 來取消任何刷新的視覺指示。如果用戶要禁用手勢和進度動畫,可以通過調用 setEnabled(false)實現。

SwipeRefreshLayout 經常與ListView RecyclerView CardView控件一起使用,用來刷新數據顯示。

SwipeRefreshLayout 在xml文件中角色:它作為手勢刷新視圖的父佈局控件,並且隻支持一個直接子控件。

2. API介紹

方法 說明
setRefreshing(boolean refreshing) 設置刷新狀態,true表示正在刷新,false表示取消刷新。
isRefreshing() 判斷當前的狀態是否是正處於刷新狀態。
setSize(int size) 設置下拉刷新圖標的大小, 隻支持兩種: DEFAULT  和 LARGE
setColorSchemeResources(int…colorReslds) 設置進度View的組合顏色,在手指上下滑時使用第一個顏色,在刷新中,會一個個顏色進行切換
setColorSchemeResources(@ColorRes int… colorResIds) 設置刷新圖標的顏色, 在手指下滑刷新時使用第一個顏色,和 setColorSchemeColors 傳遞的參數不一樣,這裡是傳入int colorResIds
setProgressBackgroundColorSchemeResource(@ColorRes int colorRes) 設置刷新圖標的背景顏色,默認為白色
setOnRefreshListener(SwipeRefreshLayout.OnRefreshListener listener) 設置監聽,需要重寫onRefresh()方法,頂部下拉時會調用這個方法,在裡面實現請求數據的邏輯,設置下拉進度條消失等等。
setProgressViewOffset(boolean scale, int start, int end) 設置動畫樣式下拉的起始點和結束點,scale設置是否需要放大或者縮小動畫, 第一個參數:默認為false,設置為true,下拉過程中刷新圖標就會從小變大

第二個參數:起始位置,刷新圖標距離頂部像素px

第三個參數:結束位置,刷新圖標距離頂部像素px

setProgressViewEndTarget(boolean scale, int end) 設置動畫樣式下拉的結束點 scale設置是否需要放大或者縮小動畫, 第二個參數:結束位置,刷新圖標距離頂部像素px
setSlingshotDistance(@Px int slingshotDistance) 設置可以將刷新指示器拉出其靜止位置的距離(以像素為單位)
setEnabled(boolean enabled) false:禁用手勢下拉刷新動畫

這些API 都是通過代碼測試後,做的解釋說明,還是比較準確的。

3. 使用方法

3.1 佈局文件

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">
    <androidx.swiperefreshlayout.widget.SwipeRefreshLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:id="@+id/swipeLayout">
        <TextView
            android:id="@+id/text_test"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:text="手動下拉刷新"
            android:gravity="center"
            android:textSize="30dp"/>
    </androidx.swiperefreshlayout.widget.SwipeRefreshLayout>
</RelativeLayout>

SwipeRefreshLayout 作為父控件, 它僅僅隻能有一個子控件,比如TextView ListView CardView 其他等…

3.2 界面代碼

public class MainActivity extends AppCompatActivity implements SwipeRefreshLayout.OnRefreshListener{
    private SwipeRefreshLayout swipeRefreshLayout;
    private TextView mTextView;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        swipeRefreshLayout = findViewById(R.id.swipeLayout);
        mTextView = findViewById(R.id.text_test);
        //設置下拉刷新圖標的大小 隻支持兩種: DEFAULT  和 LARGE
        swipeRefreshLayout.setSize(CircularProgressDrawable.LARGE);
        //設置刷新圖標的顏色,在手指下滑刷新時使用第一個顏色,在刷新中,會一個個顏色進行切換 這裡是傳入 int... colors
        swipeRefreshLayout.setColorSchemeColors(Color.BLACK, Color.GREEN, Color.RED, Color.YELLOW, Color.BLUE);
        //設置刷新圖標的顏色, 在手指下滑刷新時使用第一個顏色,和 setColorSchemeColors 傳遞的參數不一樣,這裡是傳入int colorResIds
        swipeRefreshLayout.setColorSchemeResources(R.color.red, R.color.blue, R.color.green);
        //設置刷新圖標的背景顏色
        swipeRefreshLayout.setProgressBackgroundColorSchemeResource(R.color.teal_200);
        //設置動畫樣式下拉的起始點和結束點,scale設置是否需要放大或者縮小動畫
        // 第一個參數:默認為false,設置為true,下拉過程中刷新圖標就會從小變大
        // 第二個參數:起始位置,刷新圖標距離頂部像素px
        // 第三個參數:結束位置,刷新圖標距離頂部像素px
        //swipeRefreshLayout.setProgressViewOffset(false, 100, 200);
        //設置動畫樣式下拉的結束點  scale設置是否需要放大或者縮小動畫
        // 第二個參數:結束位置,刷新圖標距離頂部像素px
        //swipeRefreshLayout.setProgressViewEndTarget(false, 500);
        //設置可以將刷新指示器拉出其靜止位置的距離(以像素為單位)
        //swipeRefreshLayout.setSlingshotDistance(600);
        //false:禁用手勢下拉刷新動畫
        //swipeRefreshLayout.setEnabled(false);
        //設置監聽器,需要重寫onRefresh()方法
        swipeRefreshLayout.setOnRefreshListener(this);
    }
    @Override
    public void onRefresh() {
        Log.e("test", "===是否==正在刷新中====" + swipeRefreshLayout.isRefreshing());
        mTextView.setText("正在刷新中......");
        new Handler().postDelayed(new Runnable() {
            @Override
            public void run() {
                mTextView.setText("刷新完成");
                //註意事項:當完成數據更新後一定要調用 setRefreshing(false),不然刷新圖標會一直轉圈,不會消失
                swipeRefreshLayout.setRefreshing(false);
            }
        }, 3000);
    }

代碼解讀:

當手勢下拉刷新界面打印log如下:

28100 28100 E test    : ===是否==正在刷新中====true

效果圖:

響應刷新手勢

(1)當用戶做出滑動手勢時,系統會顯示進度指示器並調用應用的回調方法。您的回調方法負責應用數據的實際更新。

(2)如需響應應用中的刷新手勢,請實現 SwipeRefreshLayout.OnRefreshListener 接口及其 onRefresh() 方法。

(3)當用戶做出滑動手勢時,系統會調用 onRefresh() 方法。

實際更新操作的代碼放在單獨的方法中,並通過onRefresh() 實現調用該更新方法。

當完成數據更新後一定要調用setRefreshing(false), 調用此方法可指示SwipeRefreshLayout移除進度指示器並更新視圖內容。

4. 註意事項

當完成數據更新後,記得一定要調用setRefreshing(false) 方法,不然刷新圖標會一直轉圈,不會消失。

到此這篇關於Android SwipeRefreshLayout超詳細講解的文章就介紹到這瞭,更多相關Android SwipeRefreshLayout內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: