CollectionView 类

继承 View

CollectionView, 提供列表功能组件，支持水平、竖直方向滚动，非常适合长列表的展示

@note iOS默认展示滚动指示条，android默认不展示

变量

_priveta_class_name : string

name : string

方法

adapter

设置adapter

参数

返回值

adapter

获取当前CollectionView绑定的adapter

返回值

layout

设置layout

参数

返回值

layout

获取和CollectionView绑定的layout

@note 建议使用CollectionViewLayout

返回值

openReuseCell

设置是否打开多虚拟机cell重用

@note 预留，不建议使用此方法

参数

  • openReuseCell : boolean 是否打开多虚拟机cell重用

返回值

openReuseCell

获取是否打开多虚拟机cell重用

@note 预留，不建议使用此方法

返回值

  • 返回是否打开多虚拟机cell重用 : boolean

scrollDirection

设置滚动方向

参数

返回值

scrollDirection

获取滚动方向

@note 支持横向ScrollDirection.HORIZONTAL、纵向ScrollDirection.VERTICAL

返回值

  • 返回横向ScrollDirection.HORIZONTAL、纵向ScrollDirection.VERTICAL : ScrollDirection

showScrollIndicator

设置是否显示滚动指示器

参数

  • showIndicator : boolean true:显示滚动指示器 false:不显示滚动指示器

返回值

showScrollIndicator

获取是否显示滚动器状态

返回值

  • 返回是否显示滚动器状态 : boolean

loadThreshold

设置回调加载更多方法的阈值

参数

  • loadThreshold : number 默认0，取值范围0~无穷大；eg：0.5表示还剩一半屏幕高度的页面还未显示时，就回调LoadingCallback

返回值

loadThreshold

获取提前加载更多内容的阈值,取值范围0~无穷大, 默认0

返回值

  • 返回提前加载更多内容的阈值 : number 无穷大, 默认0

contentOffset

设置内容偏移量

@note contentOffset，即内容偏移量，我们把tableView内容的左上角坐标看做原点origin(0, 0),内容偏移量即为当前实现内容的左上角坐标pt与origin之间的差值contentOffset(pt.x - origin.x, pt.y - origin.y)

参数

  • contentOffset : Point pt: 内容偏移量坐标, 这里把tableView内容的左上角坐标看做原点origin(0, 0)，pt即为相对origin的偏移量坐标

返回值

contentOffset

获取内容偏移量坐标

@note contentOffset，即内容偏移量，我们把tableView内容的左上角坐标看做原点origin(0, 0),内容偏移量即为当前实现内容的左上角坐标pt与origin之间的差值contentOffset(pt.x - origin.x, pt.y - origin.y)

返回值

  • 内容偏移量坐标，这里把tableView内容的左上角坐标看做原点origin : Point 0, 0)，pt即为相对origin的偏移量坐标

setScrollBeginCallback

设置开始滚动的回调

 function...end

参数

  • scrollBeginCallback : function()

返回值

setScrollingCallback

设置滚动中的回调

 function()...end

参数

  • scrollingCallback : function()

返回值

setEndDraggingCallback

设置停止拖拽的回调

 function...end

参数

  • endDraggingCallback : function()

返回值

setStartDeceleratingCallback

设置开始减速滚动回调

 function...end

参数

  • startDeceleratingCallback : function()

返回值

reloadData

刷新当前控件的所有数据

返回值

reloadAtRow

重新加载指定cell

@note 动画效果仅ios有效，使用时请勿改变其他cell的内容，否则两端会有差异：android可以更新多个cell，ios只能更新单个

参数

  • row : number row:指定重新加载cell的索引
  • section : number section:指定重新加载cell的section
  • animate : boolean animate:是否展现动画，为true时仅ios有效

返回值

reloadAtSection

重新渲染指定section的cell

@note 动画效果仅ios有效，使用时请勿改变其他cell的内容，否则两端会有差异：android可以更新多个cell，ios只能更新单个

参数

  • section : number section:指定重新渲染cell的section
  • animate : boolean animate:是否展现动画，为true时仅ios有效

返回值

scrollToCell

滚动到指定cell

参数

  • row : number row: 指定cell的索引
  • section : number section:指定cell的section
  • animate : boolean animate：是否展现动画

返回值

scrollToTop

滚动到列表顶部

参数

  • animate : boolean animated: 是否以动画的形式滚动

返回值

isStartPosition

是否在最顶端

返回值

  • 返回是否在最顶端 : boolean

deleteCellAtRow

删除指定位置的cell

@note 请勿改变多个cell，或其他cell数据，否则有差异

参数

  • row : number row:指定删除cell的索引
  • section : number section:指定删除cell的section

返回值

insertCellAtRow

在指定位置插入cell

@note 请勿改变多个cell，或其他cell数据，否则有差异，如果在屏幕外插入cell、可能会错位

参数

  • row : number row:指定插入cell的索引
  • section : number section:指定插入cell的section

返回值

insertCellsAtSection

在指定位置插入cell

@note 请勿改变其他cell数据，或越界刷新，否则有差异

参数

  • section : number section:指定插入cell的section
  • startRow : number startRow:指定插入cell的开始索引
  • endRow : number endRow:指定插入cell的结束索引

返回值

deleteCellsAtSection

删除指定位置cell

@note 请勿改变其他cell数据，或越界刷新，否则有差异

参数

  • section : number section:指定删除cell的section
  • startRow : number startRow:指定删除cell的开始索引
  • endRow : number endRow:指定删除cell的结束索引

返回值

pointAtIndexPath

获取指定section、row的cell的起始坐标，仅iOS存在此方法

@note 仅iOS存在此方法, 不建议使用

参数

  • row : number row: 指定行
  • section : number section: 指定组

返回值

deleteRow

删除指定位置的cell

@note 请勿改变多个cell，或其他cell数据，否则有差异

参数

  • row : number row:指定删除cell的索引
  • section : number section:指定删除cell的section
  • animate : boolean animated:是否执行动画

返回值

insertRow

在指定位置插入cell

@note 请勿改变多个cell，或其他cell数据，否则有差异，如果在屏幕外插入cell、可能会错位

参数

  • row : number row:指定插入cell的索引
  • section : number section:指定插入cell的section
  • animate : boolean animated:是否执行动画

返回值

insertRowsAtSection

在指定位置插入cell

@note 请勿改变其他section数据，或越界刷新，否则有差异

参数

  • section : number section:指定插入cell的section
  • startRow : number startRow:指定插入cell的开始索引
  • endRow : number endRow:指定插入cell的结束索引
  • animate : boolean animated:是否执行动画

返回值

deleteRowsAtSection

删除指定位置cell

@note 请勿改变其他section数据，或越界刷新，否则有差异

参数

  • section : number section:指定删除cell的section>
  • startRow : number startRow:指定删除cell的开始索引
  • endRow : number endRow:指定删除cell的结束索引
  • animate : boolean animated:是否执行动画

返回值

refreshEnable

设置是否支持下拉刷新

@note 默认false，需要增加刷新对应的handler处理,在刷新过程中关闭会导致视图抖动

参数

  • refreshEnable : boolean 是否支持下拉刷新

返回值

refreshEnable

获取是否支持下拉刷新状态

返回值

  • : boolean

isRefreshing

是否正在下拉刷新

返回值

  • : boolean

startRefreshing

移动到列表开头，并开始下拉刷新

返回值

stopRefreshing

停止下拉刷新动画

返回值

setRefreshingCallback

设置下拉刷新触发后的回调

 function()...end

参数

  • refreshingCallback : function()

返回值

loadEnable

设置是否支持加载更多

@note 默认false，需要增加刷新对应的handler处理,在加载过程中关闭会导致视图抖动

参数

  • loadEnable : boolean 是否支持加载更多

返回值

loadEnable

获取是否支持加载更多状态

返回值

  • : boolean

isLoading

是否正在上拉加载

返回值

  • : boolean

stopLoading

停止上拉加载，停止转圈动画

返回值

noMoreData

没有更多数据，之后再上拉不会触发loading回调

返回值

resetLoading

去除“没有更多数据”的状态，将状态变成普通状态

返回值

loadError

显示加载错误，android有效，iOS空实现

返回值

setLoadingCallback

设置上拉加载触发后的回调

 function()...end

参数

  • loadingCallback : function()

返回值

cellWithSectionRow

返回指定位置的cell，只对屏幕内cell有效

参数

  • section : number section:指定返回cell的section
  • row : number row:指定返回cell的索引

返回值

  • 返回cell : table

visibleCells

返回当前屏幕展示的所有cell

返回值

  • 返回当前屏幕展示的所有cell的数组 : Array

setScrollEnable

设置是否可以滚动

参数

  • enable : boolean enable:是否可滚动

返回值

setOffsetWithAnim

滚动到指定位置

@note iOS可用, android sdk version >= 1.5.0可用

参数

  • point : Point 指定位置坐标

返回值

i_bounces

设置是否开启弹性效果

@note iOS私有方法，仅在必要时使用，使用时需判断平台

参数

  • bounces : boolean true:默认值，拖拽有弹性效果 false:关闭弹性效果

返回值

i_bounces

获取是否开启弹性效果

@note iOS私有方法，仅在必要时使用，使用时需判断平台

返回值

  • 是否开启弹性效果 : boolean

i_bounceHorizontal

设置是否开启横向弹性效果

是否开启水平弹性效果，水平排布时，用于处理ContentSize小于尺寸时的体验优化

@note iOS私有方法，仅在必要时使用，使用时需判断平台

参数

  • bounces : boolean true:默认值，拖拽有弹性效果 false:关闭弹性效果

返回值

i_bounceHorizontal

获取是否开启横向弹性效果

@note iOS私有方法，仅在必要时使用，使用时需判断平台

返回值

  • 是否开启横向弹性效果 : boolean

i_bounceVertical

设置是否开启垂直弹性效果

是否开启水平弹性效果，垂直排布时，用于处理ContentSize小于尺寸时的体验优化

@note iOS私有方法，仅在必要时使用，使用时需判断平台

参数

  • bounces : boolean true:默认值，拖拽有弹性效果 false:关闭弹性效果

返回值

i_bounceVertical

获取是否开启垂直弹性效果

@note iOS私有方法，仅在必要时使用，使用时需判断平台

返回值

  • 是否开启垂直弹性效果 : boolean