UIListEdit

来自于：APICloud 官方立即使用

open close show hide cancelTopData resetTopData resetRightBtn getIndex getDataByIndex setSwipeBtns reloadData deleteItem updateItem insertItem appendData getCount setListMode getListMode getSelectedIndexs setRefreshHeader setRefreshFooter reset allSelected cancleSelected

概述

UIListEdit 模块封装了一个数据列表控件，列表项水平侧滑可出现控制按钮；开发者可自定义列表的数据源，及列表的样式，支持列表项的增、删、改、查，支持批量更新、追加数据，支持下拉刷新和上拉加载事件。

open

打开 UIListEdit 模块

open({params}, callback(ret, err))

params

rect：

  • 类型：JSON 对象
  • 描述：（可选项）模块的位置及尺寸
  • 备注：Android 必须传此参数。
  • 内部字段：
  1. {
  2.     x: 0,   //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
  3.     y: 0,   //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
  4.     w: 320, //（可选项）数字类型；模块的宽度；默认值：auto
  5.     h: 480  //（可选项）数字类型；模块的高度；默认值：auto
  6. }

data：

  • 类型：数组
  • 描述：列表的数据源，开发者可以自定义唯一的键值对信息（如：uid: ‘1001’），供 getIndex 使用
  • 内部字段：
  1. [{
  2.     imgPath: '',            //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示（这句话不支持iOS）
  3.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示（这句话不支持iOS）
  4.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示（这句话不支持iOS）
  5.     jobTitle:'产品经理',     //（可选项）字符串类型；职称
  6.     label:'同学/标签/标签',    //（可选项）字符串类型，标签
  7.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同下方 rightBtns 参数
  8. }]

topData：

  • 类型：JSON 对象
  • 描述：（可选项）列表顶部的数据源
  • 内部字段：
  1. {
  2.      showData : true,          // （可选项）布尔类型；是否显示数据；默认：false
  3.      topTitle : '',             //（可选项）字符串类型；列表顶部分组的标题
  4.      bottomTitle : '',             //（可选项）字符串类型；列表第二分组的标题
  5.     imgPath: '',            //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示（这句话不支持iOS）
  6.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示（这句话不支持iOS）
  7.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示（这句话不支持iOS）
  8.     jobTitle:'产品经理',     //（可选项）字符串类型；职称
  9.     label:'同学/标签/标签',    //（可选项）字符串类型，标签
  10.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同下方 rightBtns 参数
  11. }

rightBtns：

  • 类型：数组
  • 描述：（可选项）列表项向左滑动露出的按钮组，建议：配置列表每项的通用按钮，用此参数；配置某一项的特定按钮，可在 data 数组的指定项传入 rightBtns 参数
  • 内部字段：
  1. [{
  2.     bgColor: '#388e8e', //（可选项）字符串类型；按钮背景色，支持 rgb、rgba、#；默认：'#388e8e'
  3.     activeBgColor: '',  //（可选项）字符串类型；按钮按下时的背景色，支持 rgb、rgba、#
  4.     width: 70,          //（可选项）数字类型；按钮的宽度；默认：w / 4       
  5.     title: '',          //（可选项）字符串类型；按钮标题，水平、垂直居中
  6.     titleSize: 12,      //（可选项）数字类型；按钮标题文字大小；默认：12
  7.     titleColor: '#fff', //（可选项）字符串类型；按钮标题文字颜色，支持 rgb、rgba、#；默认：'#ffffff'
  8.     icon: '',           //（可选项）字符串类型；按钮标题前的图标路径（本地路径，支持fs://、widget://），水平、垂直居中，图标为正方形
  9.     iconWidth: 20       //（可选项）数字类型；按钮标题前的图标宽度，图标为正方形；默认：20
  10. }]

bounces:

  • 类型：布尔
  • 描述：（可选项）是否开启弹动，android 平台不支持本参数
  • 默认：false

styles:

  • 类型：JSON 对象
  • 描述：（可选项）模块各部分的样式
  • 内部字段：
  1. {
  2.     selectIcon:{                         // JSON对象；选择图标设置
  3.     normalIcon:'',                  //（可选项）字符串类型；非选中状态的图标（支持widget:// fs://）
  4.     selectedIcon:'',                //（可选项）字符串类型；选中状态的图标（支持widget:// fs://）
  5.     size:16                        //（可选项）字符串类型；图标的大小
  6.     },
  7.     deleteIcon:{                        // JSON对象；选择图标设置
  8.     icon:'',                       //（可选项）字符串类型；删除图标（支持widget:// fs://）
  9.     size:16                        //（可选项）字符串类型；图标的大小
  10.     },
  11.     borderColor: '#696969',             //（可选项）字符串类型；列表分割线的颜色，支持 rgb、rgba、#；默认：'#696969'
  12.     item: {                             //（可选项）JSON对象；列表项的样式
  13.         bgColor: '#AFEEEE',             //（可选项）字符串类型；列表项的背景色，支持 rgb、rgba、#；默认：'#AFEEEE'
  14.         activeBgColor: '#F5F5F5',       //（可选项）字符串类型；列表项按下时的背景色，支持 rgb、rgba、#；默认：'#F5F5F5'
  15.         height: 100,                     //（可选项）数字类型；列表项的高度；默认：100 注意：如果height<100,模块会处理为100
  16.         imgWidth: 40,                   //（可选项）数字类型；列表项配图的宽度；默认：列表项的高度减去10px
  17.         imgHeight: 40,                  //（可选项）数字类型；列表项配图的高度；默认：列表项的高度减去10px
  18.         imgCorner: 4,                   //（可选项）数字类型；列表项配图的圆角大小；默认：0
  19.         placeholderImg: '',             //（可选项）字符串类型；列表项配图的占位图路径（本地路径，fs://、widget://）
  20.         titleSize: 12,                  //（可选项）数字类型；列表项标题文字大小；默认：12
  21.         titleColor: '#000',             //（可选项）字符串类型；列表项标题文字颜色，支持 rgb，rgba，#；默认：'#000000'
  22.         titleMaxWidth: 200,                  //（可选项）数字类型；列表项标题文字最大宽度，超过显示省略号；默认：无
  23.         subTitleSize: 12,               //（可选项）数字类型；列表项子标题文字大小；默认：12
  24.         subTitleColor: '#000',          //（可选项）字符串类型：列表项子标题文字颜色，支持 rgb、rgba、#；默认：'#000000' 
  25.     labelColor:'#000',              //（可选项）字符串类型；标签文字颜色；默认：#000
  26.     labelSize:14,                    //（可选项）数字类型；标签文字大小；默认：14
  27.     jobTitleColor:'#000',            //（可选项）字符串类型；职称文字颜色；默认：#000
  28.     jobTitleSize:10,                 //（可选项）数字类型；职称文字大小；默认：10
  29.     }
  30. }

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：模块依附于当前 window

showScrollBar：

  • 类型：布尔
  • 描述：（可选项）是否显示滚动条
  • 默认：true

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'show',  //字符串类型；交互事件类型
  3.                         //取值范围如下：
  4.                         //show（模块加载成功）
  5.                         //clickRightBtn（点击侧滑出现的右侧按钮）
  6.                         //clickContent（点击列表项的内容，除了配图和备注以外的区域）
  7.                         //clickImg（点击列表项的配图）
  9.                         //deleted    (列表删除事件，只有列表模式为删除且触发删除时返回)
  10.                         //selected   (列表选择事件，只有列表模式为选择且触发选择时返回)
  11.                         //unselected (列表选择事件，只有列表模式为非选择且触发非选择时返回)
  12.     index: 0,           //数字类型；列表项的索引
  13.     section: 0,           //数字类型；列表项分组的索引
  14.     btnIndex: 0         //数字类型；列表项侧滑出现的按钮的索引
  15.     data:{}                //JSON对象；data或topData中传入的列表数据
  16. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.open({
  3.     rect: {
  4.         x: 0,
  5.         y: 0,
  6.         w: api.winWidth,
  7.         h: api.frameHeight
  8.     },
  9.     data: [{
  10.         uid: '1001',
  11.         imgPath: 'widget://res/img/apicloud.png',
  12.         title: '标题',
  13.         subTitle: '子标题，说明文字',
  14.         jobTitle:'大客户项目经理',
  15.         label: '同学/标签/标签',
  16.     }, {
  17.         uid: '1001',
  18.         imgPath: 'widget://res/img/apicloud.png',
  19.         title: '标题',
  20.         subTitle: '子标题，说明文字',
  21.         jobTitle:'大客户项目经理',
  22.         label: '同学/标签/标签',
  23.     }, {
  24.         uid: '1001',
  25.         imgPath: 'widget://res/img/apicloud.png',
  26.         title: '标题',
  27.         subTitle: '子标题，说明文字',
  28.         jobTitle:'大客户项目经理',
  29.         label: '同学/标签/标签',
  30.     }, {
  31.         uid: '1001',
  32.         imgPath: 'widget://res/img/apicloud.png',
  33.         title: '标题',
  34.         subTitle: '子标题，说明文字',
  35.         jobTitle:'大客户项目经理',
  36.         label: '同学/标签/标签',
  37.     }, {
  38.         uid: '1001',
  39.         imgPath: 'widget://res/img/apicloud.png',
  40.         title: '标题',
  41.         subTitle: '子标题，说明文字',
  42.         jobTitle:'大客户项目经理',
  43.         label: '同学/标签/标签',
  44.     }, {
  45.         uid: '1001',
  46.         imgPath: 'widget://res/img/apicloud.png',
  47.         title: '标题',
  48.         subTitle: '子标题，说明文字',
  49.         jobTitle:'大客户项目经理',
  50.         label: '同学/标签/标签',
  51.     }, {
  52.         uid: '1001',
  53.         imgPath: 'widget://res/img/apicloud.png',
  54.         title: '标题',
  55.         subTitle: '子标题，说明文字',
  56.         jobTitle:'大客户项目经理',
  57.         label: '同学/标签/标签',
  58.     }, {
  59.         uid: '1001',
  60.         imgPath: 'widget://res/img/apicloud.png',
  61.         title: '标题',
  62.         subTitle: '子标题，说明文字',
  63.         jobTitle:'大客户项目经理',
  64.         label: '同学/标签/标签',
  65.     }, {
  66.         uid: '1001',
  67.         imgPath: 'widget://res/img/apicloud.png',
  68.         title: '标题',
  69.         subTitle: '子标题，说明文字',
  70.         jobTitle:'大客户项目经理',
  71.         label: '同学/标签/标签',
  72.     }, {
  73.         uid: '1001',
  74.         imgPath: 'widget://res/img/apicloud.png',
  75.         title: '标题',
  76.         subTitle: '子标题，说明文字',
  77.         jobTitle:'大客户项目经理',
  78.         label: '同学/标签/标签',
  79.     }, {
  80.         imgPath: 'widget://res/img/apicloud.png',
  81.         title: '标题',
  82.         subTitle: '子标题，说明文字',
  83.         jobTitle:'大客户项目经理',
  84.         label: '同学/标签/标签',
  85.     }],
  86.     rightBtns: [{
  87.         bgColor: '#388e8e',
  88.         activeBgColor: '',
  89.         width: 70,
  90.         title: '按钮',
  91.         titleSize: 12,
  92.         titleColor: '#fff',
  93.         icon: '',
  94.         iconWidth: 20
  95.     }],
  96.     styles: {
  97.         borderColor: '#696969',
  98.         item: {
  99.             bgColor: '#AFEEEE',
  100.             activeBgColor: '#F5F5F5',
  101.             height: 100,
  102.             imgWidth: 40,
  103.             imgHeight: 40,
  104.             imgCorner: 4,
  105.             placeholderImg: '',
  106.             titleSize: 12.0,
  107.             titleColor: '#000',
  108.             subTitleSize: 12.0,
  109.             subTitleColor: '#000',
  110.             labelColor: '#9AC0CD',
  111.             labelSize:13,
  112.             jobTitleColor: '#9F79EE',
  113.             jobTitleSize:10
  114.         }
  115.     },
  116.     fixedOn: api.frameName
  117. }, function(ret, err) {
  118.     if (ret) {
  119.         alert(JSON.stringify(ret));
  120.     } else {
  121.         alert(JSON.stringify(err));
  122.     }
  123. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

close

关闭数据列表模块

close()

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.close();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

show

显示 UIListEdit 模块

show()

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.show();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏 UIListEdit 模块

hide()

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.hide();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cancelTopData

隐藏顶部分组的内容

cancelTopData()

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.cancelTopData();

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

resetTopData

重新设置列表顶部分组数据 resetTopData({params})

params

topData：

  • 类型：JSON 对象
  • 描述：（可选项）列表顶部的数据源
  • 内部字段：
  1. {
  2.      showData : true,          // （可选项）布尔类型；是否显示数据；默认：false
  3.      topTitle : '',             //（可选项）字符串类型；列表顶部分组的标题
  4.      bottomTitle : '',             //（可选项）字符串类型；列表第二分组的标题
  5.     imgPath: '',            //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示（这句话不支持iOS）
  6.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示（这句话不支持iOS）
  7.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示（这句话不支持iOS）
  8.     jobTitle:'产品经理',     //（可选项）字符串类型；职称
  9.     label:'同学/标签/标签',    //（可选项）字符串类型，标签
  10.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同下方 rightBtns 参数
  11. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.resetTopData({topData:[]});

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

resetRightBtn

重新设置列表项向左滑动露出的按钮组（如果有顶部分组，则不包含这一部分）

resetRightBtn({params})

params

rightBtns：

  • 类型：数组
  • 描述：（可选项）列表项向左滑动露出的按钮组
  • 内部字段：
  1. [{
  2.     bgColor: '#388e8e', //（可选项）字符串类型；按钮背景色，支持 rgb、rgba、#；默认：'#388e8e'
  3.     activeBgColor: '',  //（可选项）字符串类型；按钮按下时的背景色，支持 rgb、rgba、#
  4.     width: 70,          //（可选项）数字类型；按钮的宽度；默认：w / 4       
  5.     title: '',          //（可选项）字符串类型；按钮标题，水平、垂直居中
  6.     titleSize: 12,      //（可选项）数字类型；按钮标题文字大小；默认：12
  7.     titleColor: '#fff', //（可选项）字符串类型；按钮标题文字颜色，支持 rgb、rgba、#；默认：'#ffffff'
  8.     icon: '',           //（可选项）字符串类型；按钮标题前的图标路径（本地路径，支持fs://、widget://），水平、垂直居中，图标为正方形
  9.     iconWidth: 20       //（可选项）数字类型；按钮标题前的图标宽度，图标为正方形；默认：20
  10. }]

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.resetRightBtn({rightBtns:[]});

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

getIndex

根据开发者自定义的唯一标识（open 接口的 data 参数中自定义的唯一标识）查找列表项对应的数据

getIndex({params}, callback(ret, err))

params

key：

  • 类型：字符串
  • 描述：调用 open 接口时，data 参数传入的开发者自定义的唯一标识的 key

value：

  • 类型：字符串
  • 描述：调用 open 接口时，data 参数传入的开发者自定义的唯一标识的 value

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     index: 0,   //数字类型；当前列表项的索引
  3.     data: []    //数组类型；当前列表项的数据，内部字段与 open 时的 data 参数一致
  4. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.getIndex({
  3.     key: 'uid',
  4.     value: '1001'
  5. }, function(ret, err) {
  6.     if (ret) {
  7.         alert(JSON.stringify(ret));
  8.     } else {
  9.         alert(JSON.stringify(err));
  10.     }
  11. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getDataByIndex

根据列表项的索引获取对应的数据

getDataByIndex({params}, callback(ret))

params

index：

  • 类型：数字
  • 描述：（可选项）列表项的索引
  • 默认值：0

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     data: {}    //JSON对象；当前列表项的数据，内部字段与 open 时的 data 参数一致；仅在data有参数时才返回此参数
  3.     status:     //布尔类型；仅在data没有参数时才返回此参数；当data没用数据时为false；
  4.     topData:{}  //JSON对象；
  5. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.getDataByIndex({
  3.     index: 0
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setSwipeBtns

设置侧滑显示出来的按钮

setSwipeBtns({params}, callback(ret))

params

index：

  • 类型：数字
  • 描述：（可选项）列表项的索引
  • 默认值：0

btns：

  • 类型：数组
  • 描述：（可选项）列表项侧滑露出的按钮组
  • 内部字段：
  1. [{
  2.     bgColor: '#388e8e', //（可选项）字符串类型；按钮背景色，支持 rgb、rgba、#；默认：'#388e8e'
  3.     activeBgColor: '',  //（可选项）字符串类型；按钮按下时的背景色，支持 rgb、rgba、#
  4.     width: 70,          //（可选项）数字类型；按钮的宽度；默认：w / 4       
  5.     title: '',          //（可选项）字符串类型；按钮标题，水平、垂直居中
  6.     titleSize: 12,      //（可选项）数字类型；按钮标题文字大小；默认：12
  7.     titleColor: '#fff', //（可选项）字符串类型；按钮标题文字颜色，支持 rgb、rgba、#；默认：'#ffffff'
  8.     icon: '',           //（可选项）字符串类型；按钮标题前的图标路径（本地路径，支持fs://、widget://），水平、垂直居中，图标为正方形
  9.     iconWidth: 20       //（可选项）数字类型；按钮标题前的图标宽度，图标为正方形；默认：20
  10. }]

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true       //布尔型；true||false
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.setSwipeBtns({
  3.     index: 0,
  4.     btns: [{
  5.         bgColor: '#388e8e',
  6.         activeBgColor: '',
  7.         width: 70,
  8.         title: '',
  9.         titleSize: 12,
  10.         titleColor: '#fff',
  11.         icon: '',
  12.         iconWidth: 20
  13.     }]
  14. }, function(ret, err) {
  15.     if (ret) {
  16.         alert(JSON.stringify(ret));
  17.     } else {
  18.         alert(JSON.stringify(err));
  19.     }
  20. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

reloadData

刷新列表数据

reloadData({params}, callback(ret))

params

data：

  • 类型：数组
  • 描述：（可选项）列表的数据源，若不传或传空，仅收起下拉刷新组件
  • 内部字段：
  1. [{
  2.     imgPath: '',            //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示
  3.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
  4.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
  5.     remark: '',             //（可选项）字符串类型；右边备注文字
  6.     icon: '',               //（可选项）字符串类型；右侧备注的图标路径（本地路径，支持fs://、widget://）
  7.     forbidden: false,       //（可选项）布尔类型；是否屏蔽本条数据的点击事件，屏蔽后的样式可通过 open->styles->forbidden参数配置
  8.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同 rightBtns 参数
  9. }]

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true        //布尔型；true||false     
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.reloadData({
  3.     data: [{
  4.         imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
  5.         title: '新标题',
  6.         subTitle: '新子标题',
  7.         remark: '新备注',
  8.         icon: ''
  9.     }]
  10. }, function(ret) {
  11.     if (ret) {
  12.         alert(JSON.stringify(ret));
  13.     } else {
  14.         alert(JSON.stringify(err));
  15.     }
  16. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteItem

根据索引删除某一条列表的数据

deleteItem({params}, callback(ret))

params

index：

  • 类型：数字
  • 描述：（可选项）数据列表的索引
  • 默认值：0

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true       //布尔型；true||false
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.deleteItem({
  3.     index: 2
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

updateItem

根据索引更新某一条列表的数据

updateItem({params}, callback(ret))

params

index：

  • 类型：数字
  • 描述：（可选项）数据列表的索引
  • 默认值：0

data：

  • 类型：JSON 对象
  • 描述：列表的数据源
  • 内部字段：
  1. {
  2.     imgPath: '',            //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示
  3.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
  4.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
  5.     remark: '',             //（可选项）字符串类型；右边备注文字
  6.     icon: '',               //（可选项）字符串类型；右侧备注的图标路径（本地路径，支持fs://、widget://）
  7.     forbidden: false,       //（可选项）布尔类型；是否屏蔽本条数据的点击事件，屏蔽后的样式可通过 open->styles->forbidden参数配置
  8.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同 rightBtns 参数
  9. }

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true     //布尔型；true||false
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.updateItem({
  3.     index: 2,
  4.     data: {
  5.         imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
  6.         title: '刷新标题',
  7.         subTitle: '刷新子标题',
  8.         remark: '刷新备注'
  9.     }
  10. }, function(ret, err) {
  11.     if (ret) {
  12.         alert(JSON.stringify(ret));
  13.     } else {
  14.         alert(JSON.stringify(err));
  15.     }
  16. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

insertItem

根据索引向某一条列表插入数据

insertItem({params}, callback(ret, err))

params

index：

  • 类型：数字
  • 描述：（可选项）数据列表的索引
  • 默认值：列表最后一条数据的索引

data：

  • 类型：JSON 对象
  • 描述：列表的数据源
  • 内部字段：
  1. {
  2.     imgPath: '',            //（可选项）字符串类型；列表项的附图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示
  3.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
  4.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
  5.     remark: '',             //（可选项）字符串类型；右边备注文字
  6.     icon: '',               //（可选项）字符串类型；右侧备注的图标路径（本地路径，支持fs://、widget://）
  7.     forbidden: false,       //（可选项）布尔类型；是否屏蔽本条数据的点击事件，屏蔽后的样式可通过 open->styles->forbidden参数配置
  8.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，内部字段同 open 接口的 rightBtns 参数
  9. }

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true          //布尔型；true||false
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.insertItem({
  3.     index: 2,
  4.     data: {
  5.         imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
  6.         title: '12:00',
  7.         subTitle: 'APICloud粉丝互动会',
  8.         remark: '完成'
  9.     }
  10. }, function(ret, err) {
  11.     if (ret) {
  12.         alert(JSON.stringify(ret));
  13.     } else {
  14.         alert(JSON.stringify(err));
  15.     }
  16. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

appendData

向列表末端追加数据

appendData({params}, callback(ret))

params

data：

  • 类型：数组对象
  • 描述：列表的数据源，若不传或传空，仅收起上拉加载组件
  • 内部字段：
  1. [{
  2.     imgPath: '',            //（可选项）字符串类型；列表项的附图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示
  3.     title: '',              //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
  4.     subTitle: '',           //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
  5.     remark: '',             //（可选项）字符串类型；右边备注文字
  6.     icon: '',               //（可选项）字符串类型；右侧备注的图标路径（本地路径，支持fs://、widget://）
  7.     forbidden: false,       //（可选项）布尔类型；是否屏蔽本条数据的点击事件，屏蔽后的样式可通过 open->styles->forbidden参数配置
  8.     rightBtns: []           //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，内部字段同 open 接口的 rightBtns 参数
  9. }]

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true        //布尔型；true||false
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.appendData({
  3.     data: [{
  4.         imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
  5.         title: '新增标题',
  6.         subTitle: '新增子标题',
  7.         remark: '新增备注'
  8.     }]
  9. }, function(ret, err) {
  10.     if (ret) {
  11.         alert(JSON.stringify(ret));
  12.     } else {
  13.         alert(JSON.stringify(err));
  14.     }
  15. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getCount

获取当前列表的总数据量

getCount(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     count: 21        //数字类型；当前列表包含的数据总数
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.getCount(function(ret) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setListMode

设置列表模式

setListMode()

params

mode：

  • 类型：字符串
  • 描述：列表模式
  • 取值范围：
    • select
    • delete
    • normal

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.setListMode({
  3.     mode:'select'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getListMode

获取列表模式

getListMode()

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     mode:'select' // 字符串类型；列表模式；取值范围：
  3.                                         // select 选择模式
  4.                                         // delete 删除模式
  5. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.getListMode(function(ret){
  3.     alert(JSON.stringify(ret));    
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getSelectedIndexs

获取选中的项的索引

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     indexs:[1, 3, 5]; // JSON数组；选中的索引
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.getSelectedIndexs(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setRefreshHeader

设置下拉刷新，通过 reloadData 收起下拉刷新组件

setRefreshHeader({params}, callback(ret))

params

loadingImg：

  • 类型：字符串
  • 描述：下拉刷新时显示的小箭头图标的本地路径，要求本地路径（fs://、widget://）

bgColor：

  • 类型：字符串
  • 描述：（可选项）下拉刷新区域的背景色，支持 rgb、rgba、#
  • 默认值：’#f5f5f5’

textColor：

  • 类型：字符串
  • 描述：（可选项）提示文字颜色，支持 rgb、rgba、#
  • 默认值：’#8e8e8e’

textDown：

  • 类型：字符串
  • 描述：（可选项）下拉提示文字
  • 默认值：下拉可以刷新…

textUp：

  • 类型：字符串
  • 描述：（可选项）松开提示文字
  • 默认值：松开开始刷新…

loadingText:

  • 类型：字符串
  • 描述：（可选项）提示文字
  • 默认值：正在加载…

lastUpdateText:

  • 类型：字符串
  • 描述：（可选项）提示文字
  • 默认值：上次更新时间:

showTime：

  • 类型：布尔值
  • 描述：（可选项）是否显示刷新时间
  • 默认值：true

callback()

下拉刷新的事件回调

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.setRefreshHeader({
  3.     loadingImg: 'widget://res/UIListEdit_arrow.png',
  4.     bgColor: '#F5F5F5',
  5.     textColor: '#8E8E8E',
  6.     textDown: '下拉可以刷新...',
  7.     textUp: '松开开始刷新...',
  8.     showTime: true
  9. }, function(ret, err) {
  10.     if (ret) {
  11.         alert(JSON.stringify(ret));
  12.     } else {
  13.         alert(JSON.stringify(err));
  14.     }
  15. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setRefreshFooter

设置上拉加载，通过 appendData 收起上拉加载组件

setRefreshFooter({params}, callback())

params

loadingImg：

  • 类型：字符串
  • 描述：上拉加载时显示的小箭头图标的本地路径，要求本地路径（fs://、widget://）

bgColor：

  • 类型：字符串
  • 描述：（可选项）上拉加载区域的背景色，支持 rgb、rgba、#
  • 默认值：’#f5f5f5’

textColor：

  • 类型：字符串
  • 描述：（可选项）提示文字颜色，支持 rgb、rgba、#
  • 默认值：’#8e8e8e’

textUp：

  • 类型：字符串
  • 描述：（可选项）上拉提示文字
  • 默认值：’上拉加载更多…’

textDown：

  • 类型：字符串
  • 描述：（可选项）松开提示文字
  • 默认值：’松开开始加载…’

loadingText:

  • 类型：字符串
  • 描述：（可选项）提示文字
  • 默认值：正在加载…

lastUpdateText:

  • 类型：字符串
  • 描述：（可选项）提示文字
  • 默认值：上次更新时间:

showTime：

  • 类型：布尔值
  • 描述：（可选项）是否显示刷新时间
  • 默认值：true

callback(ret)

上拉加载的事件回调

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.setRefreshFooter({
  3.     loadingImg: 'widget://res/UIListEdit_arrow.png',
  4.     bgColor: '#F5F5F5',
  5.     textColor: '#8E8E8E',
  6.     textUp: '上拉加载更多...',
  7.     textDown: '松开开始加载...',
  8.     showTime: true
  9. }, function(ret, err) {
  10.     if (ret) {
  11.         alert(JSON.stringify(ret));
  12.     } else {
  13.         alert(JSON.stringify(err));
  14.     }
  15. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

reset

重新设置列表位置大小及样式

reset({params})

params

rect：

  • 类型：JSON 对象
  • 描述：（可选项）模块的位置及尺寸
  • 备注：Android 必须传此参数。
  • 内部字段：
  1. {
  2.     x: 0,   //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
  3.     y: 0,   //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
  4.     w: 320, //（可选项）数字类型；模块的宽度；默认值：auto
  5.     h: 480  //（可选项）数字类型；模块的高度；默认值：auto
  6. }

styles:

  • 类型：JSON 对象
  • 描述：（可选项）模块各部分的样式
  • 内部字段：
  1. {
  2.     selectIcon:{                         // JSON对象；选择图标设置
  3.     normalIcon:'',                  //（可选项）字符串类型；非选中状态的图标（支持widget:// fs://）
  4.     selectedIcon:'',                //（可选项）字符串类型；选中状态的图标（支持widget:// fs://）
  5.     size:16                        //（可选项）字符串类型；图标的大小
  6.     },
  7.     deleteIcon:{                        // JSON对象；选择图标设置
  8.     icon:'',                       //（可选项）字符串类型；删除图标（支持widget:// fs://）
  9.     size:16                        //（可选项）字符串类型；图标的大小
  10.     },
  11.     borderColor: '#696969',             //（可选项）字符串类型；列表分割线的颜色，支持 rgb、rgba、#；默认：'#696969'
  12.     item: {                             //（可选项）JSON对象；列表项的样式
  13.         bgColor: '#AFEEEE',             //（可选项）字符串类型；列表项的背景色，支持 rgb、rgba、#；默认：'#AFEEEE'
  14.         activeBgColor: '#F5F5F5',       //（可选项）字符串类型；列表项按下时的背景色，支持 rgb、rgba、#；默认：'#F5F5F5'
  15.         height: 100,                     //（可选项）数字类型；列表项的高度；默认：100 注意：如果height<100,模块会处理为100
  16.         imgWidth: 40,                   //（可选项）数字类型；列表项配图的宽度；默认：列表项的高度减去10px
  17.         imgHeight: 40,                  //（可选项）数字类型；列表项配图的高度；默认：列表项的高度减去10px
  18.         imgCorner: 4,                   //（可选项）数字类型；列表项配图的圆角大小；默认：0
  19.         placeholderImg: '',             //（可选项）字符串类型；列表项配图的占位图路径（本地路径，fs://、widget://）
  20.         titleSize: 12,                  //（可选项）数字类型；列表项标题文字大小；默认：12
  21.         titleColor: '#000',             //（可选项）字符串类型；列表项标题文字颜色，支持 rgb，rgba，#；默认：'#000000'
  22.         titleMaxWidth: 200,                  //（可选项）数字类型；列表项标题文字最大宽度，超过显示省略号；默认：无
  23.         subTitleSize: 12,               //（可选项）数字类型；列表项子标题文字大小；默认：12
  24.         subTitleColor: '#000',          //（可选项）字符串类型：列表项子标题文字颜色，支持 rgb、rgba、#；默认：'#000000' 
  25.     labelColor:'#000',              //（可选项）字符串类型；标签文字颜色；默认：#000
  26.     labelSize:14,                    //（可选项）数字类型；标签文字大小；默认：14
  27.     jobTitleColor:'#000',            //（可选项）字符串类型；职称文字颜色；默认：#000
  28.     jobTitleSize:10,                 //（可选项）数字类型；职称文字大小；默认：10
  29.     }
  30. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.reset({
  3.     rect: {
  4.         x: 0,
  5.         y: 0,
  6.         w: api.winWidth,
  7.         h: api.frameHeight
  8.     },
  9.     styles: {
  10.         borderColor: '#696969',
  11.         item: {
  12.             bgColor: '#AFEEEE',
  13.             activeBgColor: '#F5F5F5',
  14.             height: 100,
  15.             imgWidth: 40,
  16.             imgHeight: 40,
  17.             imgCorner: 4,
  18.             placeholderImg: '',
  19.             titleSize: 12.0,
  20.             titleColor: '#000',
  21.             subTitleSize: 12.0,
  22.             subTitleColor: '#000',
  23.             labelColor: '#9AC0CD',
  24.             labelSize:13,
  25.             jobTitleColor: '#9F79EE',
  26.             jobTitleSize:10
  27.         }
  28.     },
  29. }, function(ret) {
  30.     if (ret) {
  31.         alert(JSON.stringify(ret));
  32.     } else {
  33.         alert(JSON.stringify(err));
  34.     }
  35. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

allSelected

全选

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:; // JSON数组；全选成功还是失败
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.allSelected(function(ret) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cancleSelected

取消全选全选

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:; // JSON数组；取消全选成功还是失败
  3. }

示例代码

  1. var UIListEdit = api.require('UIListEdit');
  2. UIListEdit.cancleSelected(function(ret) {
  3.         alert(JSON.stringify(ret));
  4. });