1. 导入库
clone：https://github.com/chrisbanes/Android-PullToRefresh.git
可以把 library 文件夹重命名为 PullToRefresh。
Android Studio 中 File => New => Import Module，导入 PullToRefresh 文件夹。
dependencies {
......
compile project(':pullToRefresh')
}
还要把自己工程和 PullToRefresh 的 build.gradle 文件里的版本统一：
android {
compileSdkVersion 24
buildToolsVersion "23.0.2"
defaultConfig {
minSdkVersion 15
targetSdkVersion 24
}
Rubuild 后就能用了。
2. 简单使用
<!--The PullToRefreshListView replaces a standard ListView widget.
The ID CAN NOT be @+id/android:list-->
<com.handmark.pulltorefresh.library.PullToRefreshListView
android:id="@+id/pull_to_refresh_listview"
android:layout_height="fill_parent"
android:layout_width="fill_parent" />
// Set a listener to be invoked when the list should be refreshed.
PullToRefreshListView pullToRefreshView = (PullToRefreshListView) findViewById(R.id.pull_to_refresh_listview);
pullToRefreshView.setOnRefreshListener(new OnRefreshListener<ListView>() {
@Override
public void onRefresh(PullToRefreshBase<ListView> refreshView) {
// Do work to refresh the list here.
new GetDataTask().execute();
}
});
private class GetDataTask extends AsyncTask<Void, Void, String[]> {
...
@Override
protected void onPostExecute(String[] result) {
// Call onRefreshComplete when the list has been refreshed.
pullToRefreshView.onRefreshComplete();
super.onPostExecute(result);
}
}
- 得到 View 的实例：
getRefreshableView()
3. 自定义 PullToRefresh View
PullToRefresh 只支持以下 View：
ListView
ExpandableListView
GridView
WebView
ScrollView
HorizontalScrollView
ViewPager
如 RecyclerView、NestedScrollView 等，可以自己封装一个。
1. 新建类继承 PullToRefreshBase
2. 复写几个构造方法
3. 复写四个重要抽象方法
public class PullToRefreshNestedScrollView extends PullToRefreshBase<NestedScrollView> {
public PullToRefreshNestedScrollView(Context context) {
super(context);
}
public PullToRefreshNestedScrollView(Context context, AttributeSet attrs) {
super(context, attrs);
}
public PullToRefreshNestedScrollView(Context context, Mode mode) {
super(context, mode);
}
public PullToRefreshNestedScrollView(Context context, Mode mode, AnimationStyle animStyle) {
super(context, mode, animStyle);
}
// 滑动方向
// Orientation.VERTICAL、Orientation.HORIZONTAL
@Override
public Orientation getPullToRefreshScrollDirection() {
return Orientation.VERTICAL;
}
// 滑动的 View
// 创建一个想应用于的 View 的实例就行
@Override
protected NestedScrollView createRefreshableView(Context context, AttributeSet attrs) {
return new MyNestedScrollView(context, attrs);
}
// 判断是否滑动到底部了，返回 true 就会执行上拉加载
@Override
protected boolean isReadyForPullEnd() {
// 写判断逻辑
return false;
}
// 判断是否滑动到顶部了，返回 true 就会执行下拉刷新
@Override
protected boolean isReadyForPullStart() {
// 写判断逻辑
return false;
}
}
4. 自定义属性
res/values/attrs.xml 中：
<?xml version="1.0" encoding="utf-8"?>
<resources>
<declare-styleable name="PullToRefresh">
<!-- 设置刷新列表的背景色 -->
<attr name="ptrRefreshableViewBackground" format="reference|color" />
<!-- 设置下拉Header或者上拉Footer的背景色 -->
<attr name="ptrHeaderBackground" format="reference|color" />
<!-- 用于设置Header与Footer中文本的颜色 -->
<attr name="ptrHeaderTextColor" format="reference|color" />
<!-- 用于设置Header与Footer中上次刷新时间文本的颜色 -->
<attr name="ptrHeaderSubTextColor" format="reference|color" />
<!-- 刷新模式 -->
<attr name="ptrMode">
<flag name="disabled" value="0x0" /> <!-- 禁用下拉刷新 -->
<flag name="pullFromStart" value="0x1" /> <!-- 仅支持下拉刷新 -->
<flag name="pullFromEnd" value="0x2" /> <!-- 仅支持上拉刷新 -->
<flag name="both" value="0x3" /> <!-- 上拉刷新和下拉刷新都支持 -->
<flag name="manualOnly" value="0x4" /> <!-- 只允许手动触发 -->
<!-- These last two are depreacted -->
<flag name="pullDownFromTop" value="0x1" />
<flag name="pullUpFromBottom" value="0x2" />
</attr>
<!-- 如果为true会在mPullRefreshListView中出现icon，右上角和右下角，挺有意思的 -->
<attr name="ptrShowIndicator" format="reference|boolean" />
<!-- 同时改变头部和底部的刷新图标 -->
<attr name="ptrDrawable" format="reference" />
<!-- 头部视图的刷新图标 -->
<attr name="ptrDrawableStart" format="reference" />
<!-- 底部视图的刷新图标 -->
<attr name="ptrDrawableEnd" format="reference" />
<attr name="ptrOverScroll" format="reference|boolean" />
<!-- 分别设置拉Header或者上拉Footer中字体的类型颜色等等 -->
<attr name="ptrHeaderTextAppearance" format="reference" />
<attr name="ptrSubHeaderTextAppearance" format="reference" />
<!-- flip（翻转动画）， rotate（旋转动画） -->
<attr name="ptrAnimationStyle">
<flag name="rotate" value="0x0" />
<flag name="flip" value="0x1" />
</attr>
<!-- 刷新的时候，是否允许ListView或GridView滚动 -->
<attr name="ptrScrollingWhileRefreshingEnabled" format="reference|boolean" />
<!-- 决定了Header，Footer以何种方式加入mPullRefreshListView，true为headView方式加入，就是滚动时刷新头部会一起滚动,false不能刷新 -->
<attr name="ptrListViewExtrasEnabled" format="reference|boolean" />
<!-- 拉的时候头部或者尾部的刷新图片，是否多次旋转，true多次，false只是旋转一周，在下拉，图片不会在跟着旋转 -->
<attr name="ptrRotateDrawableWhilePulling" format="reference|boolean" />
<!-- BELOW HERE ARE DEPRECEATED. DO NOT USE. -->
<attr name="ptrAdapterViewBackground" format="reference|color" />
<attr name="ptrDrawableTop" format="reference" />
<attr name="ptrDrawableBottom" format="reference" />
</declare-styleable>
</resources>
使用方法：
- 在布局文件头部加入
xmlns:ptr="http://schemas.android.com/apk/res-auto" - 在 PullToRefreshView 节点使用
ptr:ptrMode="both"等进行设置。
