XAdapter (xycode 0.3.63 API)

java.lang.Object
- RecyclerView.Adapter
- - xyz.xmethod.xycode.adapter.XAdapter<T>

```
public abstract class XAdapter<T>
extends RecyclerView.Adapter
```
Created by xiuYe on 2016/4/3.
Item可以使用不同的Mark加载不同的布局，也可以与RN的ScrollView一样，使用不同的Mark来达到所有Holder不重用，在列表数量大的时候请谨慎使用不重复的Mark 使用getViewTypeUnitForLayout(Object)来自定义Holder 使用bindingHolder(CustomHolder, List, int) 和creatingHolder(CustomHolder, ViewTypeUnit) 来展示
Header可以添加多个 bindingHeader(CustomHolder, int)和creatingHeader(CustomHolder, int)
Footer默认为2个，一个是加载信息，另一个是可自定义的Footer，重写下面方法实现 bindingFooter(CustomHolder)和creatingFooter(CustomHolder)
（在第一版中部分注释我不用英文，可惜水平有限且并不直观，后面添加了中文注释）

嵌套类概要

嵌套类
限定符和类型类和说明

static interface XAdapter.ILoadMoreListener
加载更多接口

嵌套类
限定符和类型	类和说明
`static interface`	`XAdapter.ILoadMoreListener` 加载更多接口

字段概要

字段
限定符和类型	字段和说明
`protected android.content.Context`	`context` Context
`static int`	`LOADER_CAN_LOAD`
`static int`	`LOADER_INIT` 加载状态 LOADER_NO_DATA 没有数据 LOADER_NO_MORE 已加载全部，有footerLayoutId显示Footer LOADER_CAN_LOAD 可以加载更多 LOADER_LOADING 正在加载中，等待LoadMoreListener返回结果 LOADER_RETRY 加载更多失败
`static int`	`LOADER_LOADING`
`static int`	`LOADER_NO_DATA`
`static int`	`LOADER_NO_MORE`
`static int`	`LOADER_RETRY`
`static int`	`VIEW_TYPE_BLANK` 空布局Mark
`static int`	`VIEW_TYPE_FOOTER` Footer布局Mark
`static int`	`VIEW_TYPE_FOOTER_LOADING` Footer 加载中布局Mark
`static int`	`VIEW_TYPE_FOOTER_NO_DATA` Footer 没有数据布局Mark
`static int`	`VIEW_TYPE_FOOTER_NO_MORE` Footer 没有更多布局Mark
`static int`	`VIEW_TYPE_FOOTER_RETRY` Footer 重试布局Mark
`static int[]`	`VIEW_TYPE_FOOTERS` Footers的几种新动态布局Mark合集

构造器概要

构造器
构造器和说明

XAdapter(android.content.Context context)
use single Layout

XAdapter(android.content.Context context, OnInitList initList)

构造器
构造器和说明
`XAdapter(android.content.Context context)` use single Layout
`XAdapter(android.content.Context context, OnInitList initList)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addHeader(int headerLayoutId)` 添加默认Header，Key值为0
`void`	`addHeader(int headerKey, int headerLayoutId)` 添加Header，避免使用Key为0的Header以免与默认Header发生碰撞
`void`	`addItem(T item)` 添加Item
`void`	`addItemNoFilter(int pos, T item)` this method can only use in no filter mode
`protected void`	`beforeSetDataList(java.util.List<T> dataList)` setDataList时，在Notify以前调用此方法，现在是空实现
`protected void`	`bindingFooter(CustomHolder holder)` Footer OnBind
`protected void`	`bindingFooterLoader(CustomHolder holder, int layoutFooterViewType)` 启用加载更多时绑定Footer 建议不想新建Layout的可以继承XAdapter 重写此方法，适应更种加载提示语等
`protected void`	`bindingHeader(CustomHolder holder, int headerKey)` Header OnBind
`void`	`bindingHolder(CustomHolder holder, java.util.List<T> dataList, int pos)` 绑定展示数据时执行，多次执行
`void`	`clearDataList()` useFilter() == true 时有效果
`protected void`	`creatingFooter(CustomHolder holder)` Footer的Holder创建
`protected void`	`creatingHeader(CustomHolder holder, int headerKey)` Header的Holder 创建
`void`	`creatingHolder(CustomHolder holder, ViewTypeUnit viewTypeUnit)` 创建Holder时执行，只执行一次或被销毁后再次会被执行
`T`	`getCurrentItem(CustomHolder holder)` 取得当前Holder的Item
`int`	`getHeaderCount()`
`int`	`getHeaderPos(int headerKey)`
`T`	`getItem(int itemPosWithoutHeaderCount)` 取得列表Item
`int`	`getItemCount()` Please use getDataList().size() to get items count，this method would add header and Footer if they exist
`int`	`getItemViewType(int position)` when you use layout list, you can override this method when binding holder views
`int`	`getLayoutId(java.lang.String mark)`
`int`	`getLoadingLayoutId()` 取得加载中LayoutId
`XAdapter.ILoadMoreListener`	`getLoadMoreListener()` 加载更多接口
`int`	`getLoadRetryLayoutId()` 取得重试的LayoutId
`int`	`getNoDataLayoutId()` 取得没有数据的LayoutId
`java.util.List<T>`	`getNoFilteredDataList()` 适配器中的所有数据，包括被过滤掉的数据
`OnInitList`	`getOnInitList()` 取得实现的列表
`java.util.List<T>`	`getShowingList()` 取得下在展示的数据集合
`protected ViewTypeUnit`	`getViewTypeUnitForLayout(T item)` 根据Mark确定展示的Layout override this method can show different holder for layout don't return LAYOUT_FOOTER = -20331
`protected void`	`handleItemViewClick(CustomHolder holder, T item, int viewId, ViewTypeUnit viewTypeUnit)` override this method to add holder rootView onclick event，when handle over continue to on ClickListener in creating holder set.
`protected boolean`	`handleItemViewLongClick(CustomHolder holder, T item, int viewId, ViewTypeUnit viewTypeUnit)`
`boolean`	`hasFooter()`
`boolean`	`isHeader(int pos)` 是否Header
`void`	`loadingMoreEnd(boolean noMoreData)` 加载更多结束
`void`	`loadingMoreError()` 加载更多异常显示加载重试Footer
`void`	`onBindViewHolder(RecyclerView.ViewHolder holder, int position)` 展示
`RecyclerView.ViewHolder`	`onCreateViewHolder(android.view.ViewGroup parent, int viewType)` only do once method or not use immediately adapterPosition method, like clickListener
`void`	`onViewAttachedToWindow(RecyclerView.ViewHolder holder)` Called when a view created by this adapter has been attached to a window.
`void`	`openLoadAnimation()` To open the animation when loading
`void`	`openLoadAnimation(BaseAnimation animation)` Set Custom ObjectAnimator
`void`	`refreshedNoData()` 没有数据
`void`	`removeItem(int pos)`
`void`	`setAnimationDuration(int animationDuration)` 设置动画时长
`void`	`setAnimationInterpolator(android.view.animation.Interpolator animationInterpolator)` 设置动画
`void`	`setDataList(java.util.List<T> dataList)`
`protected java.util.List<T>`	`setFilterForAdapter(java.util.List<T> mainList)` filter local main data list, it can use any time, it won't change the main data list.
`void`	`setFooter(int footerLayout)` 设置Footer Layout
`protected void`	`setFullSpan(RecyclerView.ViewHolder holder)` thanks CymChad for this method When set to true, the item will layout using all span area.
`void`	`setLoadingLayout(int loadingLayoutId)` 设置加载中LayoutId
`void`	`setLoadMoreListener(XAdapter.ILoadMoreListener loadMoreListener)` 设置加载更多监听
`void`	`setLoadRetryLayoutId(int loadRetryLayoutId)` 设置重试的LayoutId
`void`	`setNoDataLayoutId(int noDataLayoutId)` 设置没有数据的LayoutId
`void`	`setNoMoreLayoutId(int noMoreLayoutId)` 设置没有更多的LayoutId
`void`	`setShowNoDataFooter(boolean showNoDataFooter)` 有数据时是是否展示没Footer
`void`	`setUseDefaultLoaderLayout(boolean useDefaultLoaderLayout)` 设置是否使用默认的Laoder Layout
`protected void`	`startItemAnimation(BaseAnimation animation, RecyclerView.ViewHolder holder)` set anim to start when loading
`void`	`updateItem(int pos, T item)` 更新Item
`protected boolean`	`useFilter()` 是否使用过滤列表

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

- 字段详细资料
  - VIEW_TYPE_BLANK
```
public static final int VIEW_TYPE_BLANK
```
    空布局Mark
    
    另请参阅:
    
    常量字段值
  - VIEW_TYPE_FOOTER
```
public static final int VIEW_TYPE_FOOTER
```
    Footer布局Mark
    
    另请参阅:
    
    常量字段值
  - VIEW_TYPE_FOOTER_LOADING
```
public static final int VIEW_TYPE_FOOTER_LOADING
```
    Footer 加载中布局Mark
    
    另请参阅:
    
    常量字段值
  - VIEW_TYPE_FOOTER_NO_MORE
```
public static final int VIEW_TYPE_FOOTER_NO_MORE
```
    Footer 没有更多布局Mark
    
    另请参阅:
    
    常量字段值
  - VIEW_TYPE_FOOTER_RETRY
```
public static final int VIEW_TYPE_FOOTER_RETRY
```
    Footer 重试布局Mark
    
    另请参阅:
    
    常量字段值
  - VIEW_TYPE_FOOTER_NO_DATA
```
public static final int VIEW_TYPE_FOOTER_NO_DATA
```
    Footer 没有数据布局Mark
    
    另请参阅:
    
    常量字段值
  - VIEW_TYPE_FOOTERS
```
public static final int[] VIEW_TYPE_FOOTERS
```
    Footers的几种新动态布局Mark合集
  - LOADER_INIT
```
public static final int LOADER_INIT
```
    加载状态 LOADER_NO_DATA 没有数据 LOADER_NO_MORE 已加载全部，有footerLayoutId显示Footer LOADER_CAN_LOAD 可以加载更多 LOADER_LOADING 正在加载中，等待LoadMoreListener返回结果 LOADER_RETRY 加载更多失败
    
    另请参阅:
    
    常量字段值
  - LOADER_NO_DATA
```
public static final int LOADER_NO_DATA
```
    另请参阅:
    
    常量字段值
  - LOADER_NO_MORE
```
public static final int LOADER_NO_MORE
```
    另请参阅:
    
    常量字段值
  - LOADER_CAN_LOAD
```
public static final int LOADER_CAN_LOAD
```
    另请参阅:
    
    常量字段值
  - LOADER_LOADING
```
public static final int LOADER_LOADING
```
    另请参阅:
    
    常量字段值
  - LOADER_RETRY
```
public static final int LOADER_RETRY
```
    另请参阅:
    
    常量字段值
  - context
```
protected android.content.Context context
```
    Context
- 构造器详细资料
  - XAdapter
```
public XAdapter(android.content.Context context)
```
    use single Layout
    
    参数:
    
    context -
  - XAdapter
```
public XAdapter(android.content.Context context,
                OnInitList initList)
```
- 方法详细资料
  - onCreateViewHolder
```
public RecyclerView.ViewHolder onCreateViewHolder(android.view.ViewGroup parent,
                                                  int viewType)
```
    only do once method or not use immediately adapterPosition method, like clickListener
    
    参数:
    
    parent -
    
    viewType -
    
    返回:
  - onBindViewHolder
```
public void onBindViewHolder(RecyclerView.ViewHolder holder,
                             int position)
```
    展示
    
    参数:
    
    holder -
    
    position -
  - onViewAttachedToWindow
```
public void onViewAttachedToWindow(RecyclerView.ViewHolder holder)
```
    Called when a view created by this adapter has been attached to a window. simple to solve item will layout using all setFullSpan(RecyclerView.ViewHolder)
    
    参数:
    
    holder -
  - setFullSpan
```
protected void setFullSpan(RecyclerView.ViewHolder holder)
```
    thanks CymChad for this method When set to true, the item will layout using all span area. That means, if orientation is vertical, the view will have full width; if orientation is horizontal, the view will have full height. if the hold view use StaggeredGridLayoutManager they should using all span area
    
    参数:
    
    holder - True if this item should traverse all spans.
  - startItemAnimation
```
protected void startItemAnimation(BaseAnimation animation,
                                  RecyclerView.ViewHolder holder)
```
    set anim to start when loading
    
    参数:
    
    animation -
    
    holder -
  - openLoadAnimation
```
public void openLoadAnimation(BaseAnimation animation)
```
    Set Custom ObjectAnimator
    
    参数:
    
    animation - ObjectAnimator
  - openLoadAnimation
```
public void openLoadAnimation()
```
    To open the animation when loading
  - creatingHolder
```
public void creatingHolder(CustomHolder holder,
                           ViewTypeUnit viewTypeUnit)
                    throws java.lang.Exception
```
    创建Holder时执行，只执行一次或被销毁后再次会被执行
    
    参数:
    
    holder -
    
    viewTypeUnit -
    
    抛出:
    
    java.lang.Exception
  - bindingHolder
```
public void bindingHolder(CustomHolder holder,
                          java.util.List<T> dataList,
                          int pos)
                   throws java.lang.Exception
```
    绑定展示数据时执行，多次执行
    
    参数:
    
    holder -
    
    dataList -
    
    pos -
    
    抛出:
    
    java.lang.Exception
  - getViewTypeUnitForLayout
```
protected ViewTypeUnit getViewTypeUnitForLayout(T item)
```
    根据Mark确定展示的Layout override this method can show different holder for layout don't return LAYOUT_FOOTER = -20331
    
    参数:
    
    item -
    
    返回:
  - getItemViewType
```
public int getItemViewType(int position)
```
    when you use layout list, you can override this method when binding holder views
    
    参数:
    
    position -
    
    返回:
  - getItemCount
```
public int getItemCount()
```
    Please use getDataList().size() to get items count，this method would add header and Footer if they exist
    
    返回:
  - isHeader
```
public boolean isHeader(int pos)
```
    是否Header
    
    参数:
    
    pos -
    
    返回:
  - getItem
```
public T getItem(int itemPosWithoutHeaderCount)
```
    取得列表Item
    
    参数:
    
    itemPosWithoutHeaderCount - 列表中的Item位置, 不包括Header的Item, 如使用getAdapterPosition()需要减掉getHeaderCount()
    
    返回:
  - getCurrentItem
```
public T getCurrentItem(CustomHolder holder)
```
    取得当前Holder的Item
    
    参数:
    
    holder -
    
    返回:
  - getOnInitList
```
public OnInitList getOnInitList()
```
    取得实现的列表
    
    返回:
  - setAnimationDuration
```
public void setAnimationDuration(int animationDuration)
```
    设置动画时长
    
    参数:
    
    animationDuration -
  - setAnimationInterpolator
```
public void setAnimationInterpolator(android.view.animation.Interpolator animationInterpolator)
```
    设置动画
    
    参数:
    
    animationInterpolator -
  - hasFooter
```
public boolean hasFooter()
```
  - getHeaderCount
```
public int getHeaderCount()
```
  - getHeaderPos
```
public int getHeaderPos(int headerKey)
```
  - getLayoutId
```
public int getLayoutId(java.lang.String mark)
```
  - getNoFilteredDataList
```
public java.util.List<T> getNoFilteredDataList()
```
    适配器中的所有数据，包括被过滤掉的数据
    
    返回:
  - getShowingList
```
public java.util.List<T> getShowingList()
```
    取得下在展示的数据集合
    
    返回:
  - setDataList
```
public void setDataList(java.util.List<T> dataList)
```
  - clearDataList
```
public void clearDataList()
```
    useFilter() == true 时有效果
  - removeItem
```
public void removeItem(int pos)
```
  - addItemNoFilter
```
public void addItemNoFilter(int pos,
                            T item)
```
    this method can only use in no filter mode
    
    参数:
    
    pos -
    
    item -
  - updateItem
```
public void updateItem(int pos,
                       T item)
```
    更新Item
    
    参数:
    
    pos -
    
    item -
  - addItem
```
public void addItem(T item)
```
    添加Item
    
    参数:
    
    item -
  - setFooter
```
public void setFooter(int footerLayout)
```
    设置Footer Layout
    
    参数:
    
    footerLayout -
  - addHeader
```
public void addHeader(int headerLayoutId)
```
    添加默认Header，Key值为0
    
    参数:
    
    headerLayoutId -
  - addHeader
```
public void addHeader(int headerKey,
                      int headerLayoutId)
```
    添加Header，避免使用Key为0的Header以免与默认Header发生碰撞
    
    参数:
    
    headerKey -
    
    headerLayoutId -
  - creatingHeader
```
protected void creatingHeader(CustomHolder holder,
                              int headerKey)
                       throws java.lang.Exception
```
    Header的Holder 创建
    
    参数:
    
    holder -
    
    headerKey -
    
    抛出:
    
    java.lang.Exception
  - bindingHeader
```
protected void bindingHeader(CustomHolder holder,
                             int headerKey)
                      throws java.lang.Exception
```
    Header OnBind
    
    参数:
    
    holder -
    
    headerKey -
    
    抛出:
    
    java.lang.Exception
  - creatingFooter
```
protected void creatingFooter(CustomHolder holder)
```
    Footer的Holder创建
    
    参数:
    
    holder -
  - bindingFooter
```
protected void bindingFooter(CustomHolder holder)
```
    Footer OnBind
    
    参数:
    
    holder -
  - bindingFooterLoader
```
protected void bindingFooterLoader(CustomHolder holder,
                                   int layoutFooterViewType)
```
    启用加载更多时绑定Footer 建议不想新建Layout的可以继承XAdapter 重写此方法，适应更种加载提示语等
    
    参数:
    
    holder -
    
    layoutFooterViewType - LAYOUT_FOOTER
  - beforeSetDataList
```
protected void beforeSetDataList(java.util.List<T> dataList)
```
    setDataList时，在Notify以前调用此方法，现在是空实现
    
    参数:
    
    dataList -
  - handleItemViewClick
```
protected void handleItemViewClick(CustomHolder holder,
                                   T item,
                                   int viewId,
                                   ViewTypeUnit viewTypeUnit)
```
    override this method to add holder rootView onclick event，when handle over continue to on ClickListener in creating holder set. some view if it override Touch method and did't return，can let it no use, eg：RippleView
    
    参数:
    
    holder -
    
    item -
    
    viewTypeUnit -
  - handleItemViewLongClick
```
protected boolean handleItemViewLongClick(CustomHolder holder,
                                          T item,
                                          int viewId,
                                          ViewTypeUnit viewTypeUnit)
```
  - setFilterForAdapter
```
protected java.util.List<T> setFilterForAdapter(java.util.List<T> mainList)
```
    filter local main data list, it can use any time, it won't change the main data list. 列表过滤器
    
    参数:
    
    mainList -
    
    返回:
  - useFilter
```
protected boolean useFilter()
```
    是否使用过滤列表
    
    返回:
  - loadingMoreEnd
```
public void loadingMoreEnd(boolean noMoreData)
```
    加载更多结束
    
    参数:
    
    noMoreData - true:没有更多的数据了， false:可以再次加载更多
  - loadingMoreError
```
public void loadingMoreError()
```
    加载更多异常显示加载重试Footer
  - refreshedNoData
```
public void refreshedNoData()
```
    没有数据
  - getLoadMoreListener
```
public XAdapter.ILoadMoreListener getLoadMoreListener()
```
    加载更多接口
  - setLoadMoreListener
```
public void setLoadMoreListener(XAdapter.ILoadMoreListener loadMoreListener)
```
    设置加载更多监听
    
    参数:
    
    loadMoreListener -
  - setLoadingLayout
```
public void setLoadingLayout(int loadingLayoutId)
```
    设置加载中LayoutId
    
    参数:
    
    loadingLayoutId -
  - getLoadingLayoutId
```
public int getLoadingLayoutId()
```
    取得加载中LayoutId
    
    返回:
  - setNoMoreLayoutId
```
public void setNoMoreLayoutId(int noMoreLayoutId)
```
    设置没有更多的LayoutId
    
    参数:
    
    noMoreLayoutId -
  - getNoDataLayoutId
```
public int getNoDataLayoutId()
```
    取得没有数据的LayoutId
    
    返回:
  - setNoDataLayoutId
```
public void setNoDataLayoutId(int noDataLayoutId)
```
    设置没有数据的LayoutId
    
    参数:
    
    noDataLayoutId -
  - getLoadRetryLayoutId
```
public int getLoadRetryLayoutId()
```
    取得重试的LayoutId
    
    返回:
  - setLoadRetryLayoutId
```
public void setLoadRetryLayoutId(int loadRetryLayoutId)
```
    设置重试的LayoutId
    
    参数:
    
    loadRetryLayoutId -
  - setUseDefaultLoaderLayout
```
public void setUseDefaultLoaderLayout(boolean useDefaultLoaderLayout)
```
    设置是否使用默认的Laoder Layout
    
    参数:
    
    useDefaultLoaderLayout -
  - setShowNoDataFooter
```
public void setShowNoDataFooter(boolean showNoDataFooter)
```
    有数据时是是否展示没Footer
    
    参数:
    
    showNoDataFooter -

类 XAdapter<T>

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

VIEW_TYPE_BLANK

VIEW_TYPE_FOOTER

VIEW_TYPE_FOOTER_LOADING

VIEW_TYPE_FOOTER_NO_MORE

VIEW_TYPE_FOOTER_RETRY

VIEW_TYPE_FOOTER_NO_DATA

VIEW_TYPE_FOOTERS

LOADER_INIT

LOADER_NO_DATA

LOADER_NO_MORE

LOADER_CAN_LOAD

LOADER_LOADING

LOADER_RETRY

context

构造器详细资料

XAdapter

XAdapter

方法详细资料

onCreateViewHolder

onBindViewHolder

onViewAttachedToWindow

setFullSpan

startItemAnimation

openLoadAnimation

openLoadAnimation

creatingHolder

bindingHolder

getViewTypeUnitForLayout

getItemViewType

getItemCount

isHeader

getItem

getCurrentItem

getOnInitList

setAnimationDuration

setAnimationInterpolator

hasFooter

getHeaderCount

getHeaderPos

getLayoutId

getNoFilteredDataList

getShowingList

setDataList

clearDataList

removeItem

addItemNoFilter

updateItem

addItem

setFooter

addHeader

addHeader

creatingHeader

bindingHeader

creatingFooter

bindingFooter

bindingFooterLoader

beforeSetDataList

handleItemViewClick

handleItemViewLongClick

setFilterForAdapter

useFilter

loadingMoreEnd

loadingMoreError

refreshedNoData

getLoadMoreListener

setLoadMoreListener

setLoadingLayout

getLoadingLayoutId

setNoMoreLayoutId

getNoDataLayoutId

setNoDataLayoutId

getLoadRetryLayoutId

setLoadRetryLayoutId