RefreshHeader

java.lang.Object
- com.uzmap.pkg.uzcore.uzmodule.RefreshHeader

```
public abstract class RefreshHeader
extends java.lang.Object
```
下拉刷新头模块的父类，所有下拉刷新头类的模块，必须继承该类，并实现相关函数，同时必须在module.json中配置该类。

开发人员可在config文件中配置:
<preference name="customRefreshHeader" value="moduleName" />
字段进行全局的下拉刷新模块配置，也可以通过openWin/Frame时传入下拉刷新模块名为Window或者Frame单独定制某个下拉刷新模块。

引擎会为每个需要下拉刷新的Frame或者Window建立该类的实例，并在Window或者Frame关闭时回收销毁该类

一个下拉刷新头模块的基本生命周期为：
```
 onCreateView -> onScrollY -> onStateChange -> onRefresh -> onRelease -> onDestroyView
 
```
module.json配置示例：
```
 {
  name:'cusHeader',
  class:'com.yonbuilder.moduleRefresh.CusRefreshHeader'
 }
 
```
其中，name为该下拉刷新模块的名称，class为您的某个继承自RefreshHeader的类所在的路径。

字段概要

字段
限定符和类型	字段和说明
`static int`	`STATE_DRAG` 用户手指头在屏幕上处于拖动状态，并未触发下拉刷新阀值，如果此时用户松开手指头，将恢复原始状态
`static int`	`STATE_RELEASE` 用户手指头在屏幕上处于拖动状态，已触发下拉刷新阀值，如果此时用户松开手指头，将进入下拉刷新状态

构造器概要

构造器
构造器和说明
`RefreshHeader()` 构造函数，空实现即可，引擎在初始化该代理类时主动调用该函数。

方法概要

方法
限定符和类型	方法和说明
`abstract int`	`getRefreshingThreshold(Context context)` 要求返回触发下拉刷新的阀值高度，到达这个阀值时，将触发 onStateChange。
`abstract int`	`getViewHeight(Context context)` 要求返回RefreshView的高度，一般为屏幕高度的三分之二
`abstract View`	`onCreateView(Context context)` 要求返回一个任意自定义RefreshView的实例，引擎会在适当的时机将其插入到当前window/frame的下拉刷新头中
`abstract void`	`onDestroyView()` 当Window或者Frame被关闭销毁时，引擎将通过该接口回调
`abstract void`	`onForceRefresh()` 请求RefreshView直接进入下拉刷新loading状态 .
`abstract void`	`onRefresh()` 通知RefreshView，当前Window或者Frame已经进入下拉刷新loading状态
`abstract void`	`onRelease()` 通知RefreshView结束下拉刷新状态，进行复位之类的操作.
`abstract void`	`onScrollY(int curScrollY)` 触发下拉刷新开始，用户手指头在屏幕上拖动时的回调
`abstract void`	`onSetRefreshInfo(UZModuleContext settings)` 来自Js的配置RefreshView相关信息请求 .
`abstract void`	`onSetVisibility(int visibility)` 当引擎请求设置RefreshView的visibility状态时，将通过该接口回调。
`abstract void`	`onStateChange(int state)` 用户手指头移动过程中，触发下拉刷新阀值时，状态临界值发生变化时的回调，如“下拉可以刷新”，“松开刷新”

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - STATE_DRAG
```
public static final int STATE_DRAG
```
    用户手指头在屏幕上处于拖动状态，并未触发下拉刷新阀值，如果此时用户松开手指头，将恢复原始状态
    
    另请参阅:
    
    常量字段值
  - STATE_RELEASE
```
public static final int STATE_RELEASE
```
    用户手指头在屏幕上处于拖动状态，已触发下拉刷新阀值，如果此时用户松开手指头，将进入下拉刷新状态
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - RefreshHeader
```
public RefreshHeader()
```
    构造函数，空实现即可，引擎在初始化该代理类时主动调用该函数。不建议在构造函数中做其他操作。
- 方法详细资料
  - onCreateView
```
public abstract View onCreateView(Context context)
```
    要求返回一个任意自定义RefreshView的实例，引擎会在适当的时机将其插入到当前window/frame的下拉刷新头中
    
    参数:
    
    context - 上下文，通常为Window或Frame所在Activity的实例
    
    返回:
    
    自定义RefreshView的实例
  - onDestroyView
```
public abstract void onDestroyView()
```
    当Window或者Frame被关闭销毁时，引擎将通过该接口回调
  - getViewHeight
```
public abstract int getViewHeight(Context context)
```
    要求返回RefreshView的高度，一般为屏幕高度的三分之二
    
    参数:
    
    context - 上下文，通常为Window或Frame所在Activity的实例
    
    返回:
    
    RefreshView的高度
  - getRefreshingThreshold
```
public abstract int getRefreshingThreshold(Context context)
```
    要求返回触发下拉刷新的阀值高度，到达这个阀值时，将触发 onStateChange。该值的大小通常为RefreshView中可渲染内容总高度
    
    参数:
    
    context - 上下文，通常为Window或Frame所在Activity的实例
    
    返回:
    
    阀值
  - onStateChange
```
public abstract void onStateChange(int state)
```
    用户手指头移动过程中，触发下拉刷新阀值时，状态临界值发生变化时的回调，如“下拉可以刷新”，“松开刷新”
    
    参数:
    
    state - 状态，见STATE_DRAG和STATE_RELEASE
  - onScrollY
```
public abstract void onScrollY(int curScrollY)
```
    触发下拉刷新开始，用户手指头在屏幕上拖动时的回调
    
    参数:
    
    curScrollY - 手指头相对于屏幕顶部的Y位置
  - onRelease
```
public abstract void onRelease()
```
    通知RefreshView结束下拉刷新状态，进行复位之类的操作.
    对应：api.refreshHeaderLoadDone({param})
  - onRefresh
```
public abstract void onRefresh()
```
    通知RefreshView，当前Window或者Frame已经进入下拉刷新loading状态
  - onSetRefreshInfo
```
public abstract void onSetRefreshInfo(UZModuleContext settings)
```
    来自Js的配置RefreshView相关信息请求 .
    对应：api.setCustomRefreshHeaderInfo({param})
    
    参数:
    
    settings - 配置信息，可在模块文档中约定可定制的参数
  - onForceRefresh
```
public abstract void onForceRefresh()
```
    请求RefreshView直接进入下拉刷新loading状态 .
    对应：api.refreshHeaderLoading({param})
  - onSetVisibility
```
public abstract void onSetVisibility(int visibility)
```
    当引擎请求设置RefreshView的visibility状态时，将通过该接口回调。建议重写该函数实现对RefreshView的setVisibility函数，有利于提高渲染效率

类 RefreshHeader

一个下拉刷新头模块的基本生命周期为：

module.json配置示例：

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

STATE_DRAG

STATE_RELEASE

构造器详细资料

RefreshHeader

方法详细资料

onCreateView

onDestroyView

getViewHeight

getRefreshingThreshold

onStateChange

onScrollY

onRelease

onRefresh

onSetRefreshInfo

onForceRefresh

onSetVisibility