Constructor Detail

Method Detail

• setFooterHeight

   abstract RefreshLayout setFooterHeight(float dp)

  Set the Footer's height. 设置 Footer 的高度

  Parameters:

  dp - Density-independent Pixels 虚拟像素（px需要调用px2dp转换）

  Returns:

  RefreshLayout

• setFooterHeightPx

   abstract RefreshLayout setFooterHeightPx(int px)

  设置 Footer 高度

  Parameters:

  px - 像素

  Returns:

  RefreshLayout

• setHeaderHeight

   abstract RefreshLayout setHeaderHeight(float dp)

  Set the Header's height. 设置 Header 高度

  Parameters:

  dp - Density-independent Pixels 虚拟像素（px需要调用px2dp转换）

  Returns:

  RefreshLayout

• setHeaderHeightPx

   abstract RefreshLayout setHeaderHeightPx(int px)

  设置 Header 高度

  Parameters:

  px - 像素

  Returns:

  RefreshLayout

• setHeaderInsetStart

   abstract RefreshLayout setHeaderInsetStart(float dp)

  Set the Header's start offset（see srlHeaderInsetStart in the RepastPracticeActivity XML in demo-app for the practical application）. 设置 Header 的起始偏移量（使用方法参考 demo-app 中的 RepastPracticeActivity xml 中的 srlHeaderInsetStart）

  Parameters:

  dp - Density-independent Pixels 虚拟像素（px需要调用px2dp转换）

  Returns:

  RefreshLayout

• setHeaderInsetStartPx

   abstract RefreshLayout setHeaderInsetStartPx(int px)

  Set the Header's start offset（see srlHeaderInsetStart in the RepastPracticeActivity XML in demo-app for the practical application）. 设置 Header 起始偏移量（使用方法参考 demo-app 中的 RepastPracticeActivity xml 中的 srlHeaderInsetStart）

  Parameters:

  px - 像素

  Returns:

  RefreshLayout

• setFooterInsetStart

   abstract RefreshLayout setFooterInsetStart(float dp)

  Set the Footer's start offset. 设置 Footer 起始偏移量（用处和 setHeaderInsetStart 一样）

  Parameters:

  dp - Density-independent Pixels 虚拟像素（px需要调用px2dp转换）

  Returns:

  RefreshLayout

• setFooterInsetStartPx

   abstract RefreshLayout setFooterInsetStartPx(int px)

  Set the Footer's start offset. 设置 Footer 起始偏移量（用处和 setFooterInsetStartPx 一样）

  Parameters:

  px - 像素

  Returns:

  RefreshLayout

• setDragRate

   abstract RefreshLayout setDragRate(float rate)

  Set the damping effect. 显示拖动高度/真实拖动高度 比率（默认0.5，阻尼效果）

  Parameters:

  rate - ratio = (The drag height of the view)/(The actual drag height of the finger) 比率 = 视图拖动高度 / 手指拖动高度

  Returns:

  RefreshLayout

• setHeaderMaxDragRate

   abstract RefreshLayout setHeaderMaxDragRate(float rate)

  Set the ratio of the maximum height to drag header. 设置下拉最大高度和Header高度的比率（将会影响可以下拉的最大高度）

  Parameters:

  rate - ratio = (the maximum height to drag header)/(the height of header) 比率 = 下拉最大高度 / Header的高度

  Returns:

  RefreshLayout

• setFooterMaxDragRate

   abstract RefreshLayout setFooterMaxDragRate(float rate)

  Set the ratio of the maximum height to drag footer. 设置上拉最大高度和Footer高度的比率（将会影响可以上拉的最大高度）

  Parameters:

  rate - ratio = (the maximum height to drag footer)/(the height of footer) 比率 = 下拉最大高度 / Footer的高度

  Returns:

  RefreshLayout

• setHeaderTriggerRate

   abstract RefreshLayout setHeaderTriggerRate(float rate)

  Set the ratio at which the refresh is triggered. 设置 触发刷新距离 与 HeaderHeight 的比率

  Parameters:

  rate - 触发刷新距离 与 HeaderHeight 的比率

  Returns:

  RefreshLayout

• setFooterTriggerRate

   abstract RefreshLayout setFooterTriggerRate(float rate)

  Set the ratio at which the load more is triggered. 设置 触发加载距离 与 FooterHeight 的比率

  Parameters:

  rate - 触发加载距离 与 FooterHeight 的比率

  Returns:

  RefreshLayout

• setReboundInterpolator

   abstract RefreshLayout setReboundInterpolator(Interpolator interpolator)

  Set the rebound interpolator. 设置回弹显示插值器 [放手时回弹动画,结束时收缩动画]

  Parameters:

  interpolator - 动画插值器

  Returns:

  RefreshLayout

• setReboundDuration

   abstract RefreshLayout setReboundDuration(int duration)

  Set the duration of the rebound animation. 设置回弹动画时长 [放手时回弹动画,结束时收缩动画]

  Parameters:

  duration - 时长

  Returns:

  RefreshLayout

• setRefreshFooter

   abstract RefreshLayout setRefreshFooter(RefreshFooter footer)

  Set the footer of RefreshLayout. 设置指定的 Footer

  Parameters:

  footer - RefreshFooter 刷新尾巴

  Returns:

  RefreshLayout

• setRefreshFooter

   abstract RefreshLayout setRefreshFooter(RefreshFooter footer, int width, int height)

  Set the footer of RefreshLayout. 设置指定的 Footer

  Parameters:

  footer - RefreshFooter 刷新尾巴

  width - the width in px, can use MATCH_PARENT and WRAP_CONTENT.

  height - the height in px, can use MATCH_PARENT and WRAP_CONTENT.

  Returns:

  RefreshLayout

• setRefreshHeader

   abstract RefreshLayout setRefreshHeader(RefreshHeader header)

  Set the header of RefreshLayout. 设置指定的 Header

  Parameters:

  header - RefreshHeader 刷新头

  Returns:

  RefreshLayout

• setRefreshHeader

   abstract RefreshLayout setRefreshHeader(RefreshHeader header, int width, int height)

  Set the header of RefreshLayout. 设置指定的 Header

  Parameters:

  header - RefreshHeader 刷新头

  width - the width in px, can use MATCH_PARENT and WRAP_CONTENT.

  height - the height in px, can use MATCH_PARENT and WRAP_CONTENT.

  Returns:

  RefreshLayout

• setRefreshContent

   abstract RefreshLayout setRefreshContent(View content)

  Set the content of RefreshLayout（Suitable for non-XML pages, not suitable for replacing empty layouts）。 设置指定的 Content（适用于非XML页面，不适合用替换空布局）

  Parameters:

  content - View 内容视图

  Returns:

  RefreshLayout

• setRefreshContent

   abstract RefreshLayout setRefreshContent(View content, int width, int height)

  Set the content of RefreshLayout（Suitable for non-XML pages, not suitable for replacing empty layouts）. 设置指定的 Content（适用于非XML页面，不适合用替换空布局）

  Parameters:

  content - View 内容视图

  width - the width in px, can use MATCH_PARENT and WRAP_CONTENT.

  height - the height in px, can use MATCH_PARENT and WRAP_CONTENT.

  Returns:

  RefreshLayout

• setEnableRefresh

   abstract RefreshLayout setEnableRefresh(boolean enabled)

  Whether to enable pull-down refresh (enabled by default). 是否启用下拉刷新（默认启用）

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableLoadMore

   abstract RefreshLayout setEnableLoadMore(boolean enabled)

  Set whether to enable pull-up loading more (enabled by default). 设置是否启用上拉加载更多（默认启用）

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableAutoLoadMore

   abstract RefreshLayout setEnableAutoLoadMore(boolean enabled)

  Sets whether to listen for the list to trigger a load event when scrolling to the bottom (default true). 设置是否监听列表在滚动到底部时触发加载事件（默认true）

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableHeaderTranslationContent

   abstract RefreshLayout setEnableHeaderTranslationContent(boolean enabled)

  Set whether to pull down the content while pulling down the header. 设置是否启在下拉 Header 的同时下拉内容

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableFooterTranslationContent

   abstract RefreshLayout setEnableFooterTranslationContent(boolean enabled)

  Set whether to pull up the content while pulling up the header. 设置是否启在上拉 Footer 的同时上拉内容

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableOverScrollBounce

   abstract RefreshLayout setEnableOverScrollBounce(boolean enabled)

  Set whether to enable cross-border rebound function. 设置是否启用越界回弹

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnablePureScrollMode

   abstract RefreshLayout setEnablePureScrollMode(boolean enabled)

  Set whether to enable the pure scroll mode. 设置是否开启纯滚动模式

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableScrollContentWhenLoaded

   abstract RefreshLayout setEnableScrollContentWhenLoaded(boolean enabled)

  Set whether to scroll the content to display new data after loading more complete. 设置是否在加载更多完成之后滚动内容显示新数据

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableScrollContentWhenRefreshed

   abstract RefreshLayout setEnableScrollContentWhenRefreshed(boolean enabled)

  Set whether to scroll the content to display new data after the refresh is complete. 是否在刷新完成之后滚动内容显示新数据

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableLoadMoreWhenContentNotFull

   abstract RefreshLayout setEnableLoadMoreWhenContentNotFull(boolean enabled)

  Set whether to pull up and load more when the content is not full of one page. 设置在内容不满一页的时候，是否可以上拉加载更多

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableOverScrollDrag

   abstract RefreshLayout setEnableOverScrollDrag(boolean enabled)

  Set whether to enable cross-border drag (imitation iphone effect). 设置是否启用越界拖动（仿苹果效果）

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableFooterFollowWhenNoMoreData

   abstract RefreshLayout setEnableFooterFollowWhenNoMoreData(boolean enabled)

  Set whether or not Footer follows the content after there is no more data. 设置是否在没有更多数据之后 Footer 跟随内容

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableClipHeaderWhenFixedBehind

   abstract RefreshLayout setEnableClipHeaderWhenFixedBehind(boolean enabled)

  Set whether to clip header when the Header is in the FixedBehind state. 设置是否在当 Header 处于 FixedBehind 状态的时候剪裁遮挡 Header

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableClipFooterWhenFixedBehind

   abstract RefreshLayout setEnableClipFooterWhenFixedBehind(boolean enabled)

  Set whether to clip footer when the Footer is in the FixedBehind state. 设置是否在当 Footer 处于 FixedBehind 状态的时候剪裁遮挡 Footer

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setEnableNestedScroll

   abstract RefreshLayout setEnableNestedScroll(boolean enabled)

  Setting whether nesting scrolling is enabled (default off + smart on). 设置是会否启用嵌套滚动功能（默认关闭+智能开启）

  Parameters:

  enabled - 是否启用

  Returns:

  RefreshLayout

• setFixedHeaderViewId

   abstract RefreshLayout setFixedHeaderViewId(int id)

  设置固定在 Header 下方的视图Id，可以在 Footer 上下滚动的时候保持不跟谁滚动

  Parameters:

  id - 固定在头部的视图Id

  Returns:

  RefreshLayout

• setFixedFooterViewId

   abstract RefreshLayout setFixedFooterViewId(int id)

  设置固定在 Footer 上方的视图Id，可以在 Header 上下滚动的时候保持不跟谁滚动

  Parameters:

  id - 固定在底部的视图Id

  Returns:

  RefreshLayout

• setHeaderTranslationViewId

   abstract RefreshLayout setHeaderTranslationViewId(int id)

  设置在 Header 上下滚动时，需要跟随滚动的视图Id，默认整个内容视图

  Parameters:

  id - 固定在头部的视图Id

  Returns:

  RefreshLayout

• setFooterTranslationViewId

   abstract RefreshLayout setFooterTranslationViewId(int id)

  设置在 Footer 上下滚动时，需要跟随滚动的视图Id，默认整个内容视图

  Parameters:

  id - 固定在头部的视图Id

  Returns:

  RefreshLayout

• setDisableContentWhenRefresh

   abstract RefreshLayout setDisableContentWhenRefresh(boolean disable)

  Set whether to enable the action content view when refreshing. 设置是否开启在刷新时候禁止操作内容视图

  Parameters:

  disable - 是否禁止

  Returns:

  RefreshLayout

• setDisableContentWhenLoading

   abstract RefreshLayout setDisableContentWhenLoading(boolean disable)

  Set whether to enable the action content view when loading. 设置是否开启在加载时候禁止操作内容视图

  Parameters:

  disable - 是否禁止

  Returns:

  RefreshLayout

• setOnRefreshListener

   abstract RefreshLayout setOnRefreshListener(OnRefreshListener listener)

  Set refresh listener separately. 单独设置刷新监听器

  Parameters:

  listener - OnRefreshListener 刷新监听器

  Returns:

  RefreshLayout

• setOnLoadMoreListener

   abstract RefreshLayout setOnLoadMoreListener(OnLoadMoreListener listener)

  Set load more listener separately. 单独设置加载监听器

  Parameters:

  listener - OnLoadMoreListener 加载监听器

  Returns:

  RefreshLayout

• setOnRefreshLoadMoreListener

   abstract RefreshLayout setOnRefreshLoadMoreListener(OnRefreshLoadMoreListener listener)

  Set refresh and load listeners at the same time. 同时设置刷新和加载监听器

  Parameters:

  listener - OnRefreshLoadMoreListener 刷新加载监听器

  Returns:

  RefreshLayout

• setOnMultiListener

   abstract RefreshLayout setOnMultiListener(OnMultiListener listener)

  Set up a multi-function listener. Recommended SimpleMultiListener 设置多功能监听器 建议使用 SimpleMultiListener

  Parameters:

  listener - OnMultiPurposeListener 多功能监听器

  Returns:

  RefreshLayout

• setScrollBoundaryDecider

   abstract RefreshLayout setScrollBoundaryDecider(ScrollBoundaryDecider boundary)

  Set the scroll boundary Decider, Can customize when you can refresh. Recommended 设置滚动边界判断器 建议使用 SimpleBoundaryDecider

  Parameters:

  boundary - ScrollBoundaryDecider 判断器

  Returns:

  RefreshLayout

• setPrimaryColors

   abstract RefreshLayout setPrimaryColors(Array<int> primaryColors)

  Set theme color int (primaryColor and accentColor). 设置主题颜色

  Parameters:

  primaryColors - ColorInt 主题颜色

  Returns:

  RefreshLayout

• setPrimaryColorsId

   abstract RefreshLayout setPrimaryColorsId(Array<int> primaryColorId)

  Set theme color id (primaryColor and accentColor). 设置主题颜色

  Parameters:

  primaryColorId - ColorRes 主题颜色ID

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh()

  finish refresh. 完成刷新

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh(int delayed)

  finish refresh. 完成刷新

  Parameters:

  delayed - 开始延时

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh(boolean success)

  finish refresh. 完成加载

  Parameters:

  success - 数据是否成功刷新 （会影响到上次更新时间的改变）

  Returns:

  RefreshLayout

• finishRefresh

   abstract RefreshLayout finishRefresh(int delayed, boolean success, Boolean noMoreData)

  finish refresh. 完成刷新

  Parameters:

  delayed - 开始延时

  success - 数据是否成功刷新 （会影响到上次更新时间的改变）

  noMoreData - 是否有更多数据

  Returns:

  RefreshLayout

• finishRefreshWithNoMoreData

   abstract RefreshLayout finishRefreshWithNoMoreData()

  finish load more with no more data. 完成刷新并标记没有更多数据

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore()

  finish load more. 完成加载

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore(int delayed)

  finish load more. 完成加载

  Parameters:

  delayed - 开始延时

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore(boolean success)

  finish load more. 完成加载

  Parameters:

  success - 数据是否成功

  Returns:

  RefreshLayout

• finishLoadMore

   abstract RefreshLayout finishLoadMore(int delayed, boolean success, boolean noMoreData)

  finish load more. 完成加载

  Parameters:

  delayed - 开始延时

  success - 数据是否成功

  noMoreData - 是否有更多数据

  Returns:

  RefreshLayout

• finishLoadMoreWithNoMoreData

   abstract RefreshLayout finishLoadMoreWithNoMoreData()

  finish load more with no more data. 完成加载并标记没有更多数据

  Returns:

  RefreshLayout

• closeHeaderOrFooter

   abstract RefreshLayout closeHeaderOrFooter()

  Close the Header or Footer, can't replace finishRefresh and finishLoadMore. 关闭 Header 或者 Footer 注意： 1.closeHeaderOrFooter 任何时候任何状态都能关闭 header 和 footer 2.finishRefresh 和 finishLoadMore 只能在 刷新 或者 加载 的时候关闭

  Returns:

  RefreshLayout

• setNoMoreData

   abstract RefreshLayout setNoMoreData(boolean noMoreData)

  Restore the original state after finishLoadMoreWithNoMoreData. 设置没有更多数据的状态

  Parameters:

  noMoreData - 是否有更多数据

  Returns:

  RefreshLayout 尽量使用下面三个方法代替，他们可以让状态切换与动画结束合拍 use resetNoMoreData use finishRefreshWithNoMoreData use finishLoadMoreWithNoMoreData

• resetNoMoreData

   abstract RefreshLayout resetNoMoreData()

  Restore the original state after finishLoadMoreWithNoMoreData. 恢复没有更多数据的原始状态

  Returns:

  RefreshLayout

• getRefreshHeader

   abstract RefreshHeader getRefreshHeader()

  Get header of RefreshLayout 获取当前 Header

  Returns:

  RefreshLayout

• getRefreshFooter

   abstract RefreshFooter getRefreshFooter()

  Get footer of RefreshLayout 获取当前 Footer

  Returns:

  RefreshLayout

• getState

   abstract RefreshState getState()

  Get the current state of RefreshLayout 获取当前状态

  Returns:

  RefreshLayout

• getLayout

   abstract ViewGroup getLayout()

  Get the ViewGroup of RefreshLayout 获取实体布局视图

  Returns:

  ViewGroup

• autoRefresh

   abstract boolean autoRefresh()

  Display refresh animation and trigger refresh event. 显示刷新动画并且触发刷新事件

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoRefresh

   abstract boolean autoRefresh(int delayed)

  Display refresh animation and trigger refresh event, Delayed start. 显示刷新动画并且触发刷新事件，延时启动

  Parameters:

  delayed - 开始延时

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoRefreshAnimationOnly

   abstract boolean autoRefreshAnimationOnly()

  Display refresh animation without triggering events. 显示刷新动画，不触发事件

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoRefresh

   abstract boolean autoRefresh(int delayed, int duration, float dragRate, boolean animationOnly)

  Display refresh animation, Multifunction. 显示刷新动画并且触发刷新事件

  Parameters:

  delayed - 开始延时

  duration - 拖拽动画持续时间

  dragRate - 拉拽的高度比率

  animationOnly - animation only 只有动画

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoLoadMore

   abstract boolean autoLoadMore()

  Display load more animation and trigger load more event. 显示加载动画并且触发刷新事件

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoLoadMore

   abstract boolean autoLoadMore(int delayed)

  Display load more animation and trigger load more event, Delayed start. 显示加载动画并且触发刷新事件, 延时启动

  Parameters:

  delayed - 开始延时

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoLoadMoreAnimationOnly

   abstract boolean autoLoadMoreAnimationOnly()

  Display load more animation without triggering events. 显示加载动画，不触发事件

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• autoLoadMore

   abstract boolean autoLoadMore(int delayed, int duration, float dragRate, boolean animationOnly)

  Display load more animation and trigger load more event, Delayed start. 显示加载动画, 多功能选项

  Parameters:

  delayed - 开始延时

  duration - 拖拽动画持续时间

  dragRate - 拉拽的高度比率

  animationOnly - 是否只是显示动画，不回调

  Returns:

  true or false, Status non-compliance will fail. 是否成功（状态不符合会失败）

• isRefreshing

   abstract boolean isRefreshing()

  是否正在刷新

  Returns:

  RefreshLayout

• isLoading

   abstract boolean isLoading()

  是否正在加载

  Returns:

  RefreshLayout