Skip to content

Latest commit

 

History

History
executable file
·
351 lines (250 loc) · 11.2 KB

README-cn.md

File metadata and controls

executable file
·
351 lines (250 loc) · 11.2 KB
Raw

Ultra Pull to Refresh with Load More

本分支对原有的Ultra Pull To Refresh进行了修改，使得其支持了上拉加载更多。

1.0.3更新

为了添加更多功能，我将头部和脚部的一些属性给分开了，例如resistance和durationToClose。同时，为了避免在变量名称上造成误解，一些原有的变量名也作出了修改。

  • 在旧版本中，ptr_duration_to_close是指回到刷新状态的事件。另外，ptr_duration_to_close_header代表回到**开始状态（不可见）**的事件。这两个属性有点类似，因此可能造成误解，特别是在添加了footer之后。所以，在新版本中，ptr_duration_to_close被删除，而使用ptr_duration_to_back_refresh作为替代。同时，也加入了ptr_duration_to_back_header和ptr_duration_to_back_footer来区分头部和脚部。
  • 新版本中，添加ptr_duration_to_close_either代表回到**开始状态（不可见）**的事件。
  • 针对ptr_resistance，也分别添加ptr_resistance_header和ptr_resistance_footer。

可以查看FooterFeatures来查看新添加的方法。如果你有任何意见，欢迎反馈。

加载更多

Ultra Pull to Refresh是现在已经停止维护的下拉刷新项目的替代方案。继承于ViewGroup可以包含任何View。功能比SwipeRefreshLayout强大。使用起来非常简单。良好的设计，如果你想定制自己的UI样式，非常简单，就像给ListView加一个Header View那么简单。

和下拉刷新一样，上拉加载同样支持所有view。全部的逻辑都是仿造原有的下拉刷新而来，并且配置信息（阻抗，持续时间等）为两者共享。另外，本分支没有修改任何原有API。如果你之前已经在使用Ultra Pull To Refresh，那么你可以无缝的转换到本分支上来。

实例项目demo中只有主页面和自动刷新页面演示了如何使用上拉加载更多。

支持 API LEVEL >= 8。

添加的方法和类

  • setFooterView：对应于setHeaderView()。在set完footer后，你需要调用 addPtrUIHandler()，这和设置header的机制是一样的。
  • PtrHandler2：原有PtrHandler类的一个补充。当需要使用上拉加载更多的时候，你应该调用setPtrHandler(new PtrHandler2())，而不是setPtrHandler(new PtrHandler())。
  • PtrDefaultHandler2：实现了默认的 checkCanDoLoadMore() 逻辑，可以适用于大部分的View。机制和PtrDefaultHandler一致。
  • PtrClassicDefaultFooter：默认的footer，将默认header反转了过来。
  • setMode(Mode): Mode是本分支的一个新特性。通过调用setMode, 你可以任意的开启/关闭header或者footer。参数类型是一个枚举变量，可以通过以下方式调用：setMode(Mode.BOTH).

引用方法

  • 在gradle中:
    compile 'in.srain.cube:ptr-load-more:1.0.6'
  • 在maven中：

<dependency>
	<groupId>in.srain.cube</groupId>
	<artifactId>ptr-load-more</artifactId>
	<version>1.0.6</version>
	<type>pom</type>
</dependency>

联系方式

有任何意见和问题，欢迎在issues中提出，一定尽快回复。

以下是原项目的说明

  • 先上两张StoreHouse风格的截图! 感谢 CBStoreHouseRefreshControl.

  • 5.0 Material 风格 2014-12-09 新增。阴影效果，gif图看起来有些失真，看demo吧！

  • 支持所有的View:

    ListView, GridView, ScrollView, FrameLayout, 甚至 TextView.

  • 支持各种下拉刷新交互.

    • 下拉刷新(iOS风格)

    • 释放刷新(经典风格)

    • 刷新时，头部保持(新浪微博)

    • 刷新时，头部不保持(微信朋友圈)

    • 自动刷新，进入界面时自动刷新

使用方式

中央库依赖

项目已经发布到了Maven中央库，包括aar和apklib两种格式。在Maven或者Gradle下可如下直接引入:

最新版版本号: 1.0.11, 发布到了: https://oss.sonatype.org/content/repositories/snapshots

在gradle中:

maven {
    url 'https://oss.sonatype.org/content/repositories/snapshots'
}

稳定版: 1.0.11, https://oss.sonatype.org/content/repositories/releases, in gradle:

mavenCentral()

pom.xml 文件中

最新版:

<dependency>
    <groupId>in.srain.cube</groupId>
    <artifactId>ultra-ptr</artifactId>
    <type>aar</type>
    <!-- or apklib format, if you want -->
    <!-- <type>apklib</type> -->
    <version>1.0.11</version>
</dependency>

稳定版

```xml
<dependency>
    <groupId>in.srain.cube</groupId>
    <artifactId>ultra-ptr</artifactId>
    <type>aar</type>
    <!-- or apklib format, if you want -->
    <!-- <type>apklib</type> -->
    <version>1.0.11</version>
</dependency>

gradle / Android Studio, 最新版

compile 'in.srain.cube:ultra-ptr:1.0.11'

gradle / Android Studio, 稳定版

compile 'in.srain.cube:ultra-ptr:1.0.11'

配置

有6个参数可配置:

  • 阻尼系数

    默认: 1.7f，越大，感觉下拉时越吃力。

  • 触发刷新时移动的位置比例

    默认，1.2f，移动达到头部高度1.2倍时可触发刷新操作。

  • 回弹延时

    默认 200ms，回弹到刷新高度所用时间

  • 头部回弹时间

    默认1000ms

  • 刷新是保持头部

    默认值 true.

  • 下拉刷新 / 释放刷新

    默认为释放刷新

xml中配置示例
<in.srain.cube.views.ptr.PtrFrameLayout
    android:id="@+id/store_house_ptr_frame"
    xmlns:cube_ptr="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"

    cube_ptr:ptr_resistance="1.7"
    cube_ptr:ptr_ratio_of_header_height_to_refresh="1.2"
    cube_ptr:ptr_duration_to_close="300"
    cube_ptr:ptr_duration_to_close_header="2000"
    cube_ptr:ptr_keep_header_when_refresh="true"
    cube_ptr:ptr_pull_to_fresh="false" >

    <LinearLayout
        android:id="@+id/store_house_ptr_image_content"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@color/cube_mints_333333"
        android:clickable="true"
        android:padding="10dp">

        <in.srain.cube.image.CubeImageView
            android:id="@+id/store_house_ptr_image"
            android:layout_width="match_parent"
            android:layout_height="match_parent" />
    </LinearLayout>

</in.srain.cube.views.ptr.PtrFrameLayout>

也可以在java代码中配置

// the following are default settings
mPtrFrame.setResistance(1.7f);
mPtrFrame.setRatioOfHeaderHeightToRefresh(1.2f);
mPtrFrame.setDurationToClose(200);
mPtrFrame.setDurationToCloseHeader(1000);
// default is false
mPtrFrame.setPullToRefresh(false);
// default is true
mPtrFrame.setKeepHeaderWhenRefresh(true);

其他配置

  • 刷新时，保持内容不动，仅头部下移, setPinContent()

    Material 风格时，效果不错，其他风格的头部，效果不好。issue #29

StoreHouse 风格

  • 使用字符串, 支持A-Z, 0-7 以及 - .
// header
final StoreHouseHeader header = new StoreHouseHeader(getContext());
header.setPadding(0, LocalDisplay.dp2px(15), 0, 0);

/**
 * using a string, support: A-Z 0-9 - .
 * you can add more letters by {@link in.srain.cube.views.ptr.header.StoreHousePath#addChar}
 */
header.initWithString('Alibaba');
  • 使用资源文件中的路径信息
header.initWithStringArray(R.array.storehouse);

资源文件 res/values/arrays.xml 内容如下:

<resources>
    <string-array name="storehouse">
        <item>0,35,12,42,</item>
        <item>12,42,24,35,</item>
        <item>24,35,12,28,</item>
        <item>0,35,12,28,</item>
        <item>0,21,12,28,</item>
        <item>12,28,24,21,</item>
        <item>24,35,24,21,</item>
        <item>24,21,12,14,</item>
        <item>0,21,12,14,</item>
        <item>0,21,0,7,</item>
        <item>12,14,0,7,</item>
        <item>12,14,24,7,</item>
        <item>24,7,12,0,</item>
        <item>0,7,12,0,</item>
    </string-array>
</resources>

处理刷新

通过PtrHandler，可以检查确定是否可以下来刷新以及在合适的时间刷新数据。

检查是否可以下拉刷新在PtrDefaultHandler.checkContentCanBePulledDown中有默认简单的实现，你可以根据实际情况完成这个逻辑。

public interface PtrHandler {

    /**
     * 检查是否可以执行下来刷新，比如列表为空或者列表第一项在最上面时。
     * <p/>
     * {@link in.srain.cube.views.ptr.PtrDefaultHandler#checkContentCanBePulledDown}
     */
    public boolean checkCanDoRefresh(final PtrFrameLayout frame, final View content, final View header);

    /**
     * 需要加载数据时触发
     *
     * @param frame
     */
    public void onRefreshBegin(final PtrFrameLayout frame);
}

例子:

ptrFrame.setPtrHandler(new PtrHandler() {
    @Override
    public void onRefreshBegin(PtrFrameLayout frame) {
        frame.postDelayed(new Runnable() {
            @Override
            public void run() {
                ptrFrame.refreshComplete();
            }
        }, 1800);
    }

    @Override
    public boolean checkCanDoRefresh(PtrFrameLayout frame, View content, View header) {
        // 默认实现，根据实际情况做改动
        return PtrDefaultHandler.checkContentCanBePulledDown(frame, content, header);
    }
});

常见问题

  • ViewPager滑动冲突: disableWhenHorizontalMove()

  • 长按LongPressed, setInterceptEventWhileWorking()

联系方式和问题建议