open close show hide setAttr getIndex getDataByIndex setSwipeBtns reloadData deleteItem updateItem insertItem appendData getCount setRefreshHeader setRefreshFooter
为帮助用户更好更快的使用插件,论坛维护了一个示例,示例中包含示例代码、知识点讲解、注意事项等,供您参考。
UIListView 插件封装了一个数据列表控件,列表项水平侧滑可出现控制按钮;开发者可自定义列表的数据源,及列表的样式,支持列表项的增、删、改、查,支持批量更新、追加数据,支持下拉刷新和上拉加载事件。UIListView 插件是 listView 插件的优化版。本插件的源码地址
打开 UIListView 插件
open({params}, callback(ret, err))
rect:
{
x: 0, //(可选项)数字类型;插件左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;插件左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 320, //(可选项)数字类型;插件的宽度,支持设置'auto';默认值:所属的 Window 或 Frame 的宽度
h: 480 //(可选项)数字类型;插件的高度,支持设置'auto';默认值:所属的 Window 或 Frame 的高度
}
data:
[{
imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
remark: '', //(可选项)字符串类型;右边备注文字
icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件和侧滑露出按钮功能,屏蔽后的样式可通过 styles->forbidden参数配置
rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同下方 rightBtns 参数
}]
rightBtns:
data
数组的指定项传入 rightBtns
参数[{
bgColor: '#388e8e', //(可选项)字符串类型;按钮背景色,支持 rgb、rgba、#;默认:'#388e8e'
activeBgColor: '', //(可选项)字符串类型;按钮按下时的背景色,支持 rgb、rgba、#
width: 70, //(可选项)数字类型;按钮的宽度;默认:w / 4
title: '', //(可选项)字符串类型;按钮标题,水平、垂直居中
titleSize: 12, //(可选项)数字类型;按钮标题文字大小;默认:12
titleColor: '#fff', //(可选项)字符串类型;按钮标题文字颜色,支持 rgb、rgba、#;默认:'#ffffff'
icon: '', //(可选项)字符串类型;按钮标题前的图标路径(本地路径,支持fs://、widget://),水平、垂直居中,图标为正方形
iconWidth: 20 //(可选项)数字类型;按钮标题前的图标宽度,图标为正方形;默认:20
}]
bounces:
styles:
{
borderColor: '#696969', //(可选项)字符串类型;列表分割线的颜色,支持 rgb、rgba、#;默认:'#696969'
item: { //(可选项)JSON对象;列表项的样式
bgColor: '#AFEEEE', //(可选项)字符串类型;列表项的背景色,支持 rgb、rgba、#;默认:'#AFEEEE'
activeBgColor: '#F5F5F5', //(可选项)字符串类型;列表项按下时的背景色,支持 rgb、rgba、#;默认:'#F5F5F5'
height: 55, //(可选项)数字类型;列表项的高度;默认:55
imgWidth: 40, //(可选项)数字类型;列表项配图的宽度;默认:列表项的高度减去10px
imgHeight: 40, //(可选项)数字类型;列表项配图的高度;默认:列表项的高度减去10px
imgCorner: 4, //(可选项)数字类型;列表项配图的圆角大小;默认:0
placeholderImg: '', //(可选项)字符串类型;列表项配图的占位图路径(本地路径,fs://、widget://),默认:YonBuilder移动开发 图标
titleSize: 12, //(可选项)数字类型;列表项标题文字大小;默认:12
titleColor: '#000', //(可选项)字符串类型;列表项标题文字颜色,支持 rgb,rgba,#;默认:'#000000'
subTitleSize: 12, //(可选项)数字类型;列表项子标题文字大小;默认:12
subTitleColor: '#000', //(可选项)字符串类型:列表项子标题文字颜色,支持 rgb、rgba、#;默认:'#000000'
remarkColor: '#000', //(可选项)字符串类型;备注的文字颜色,支持 rgb、rgba、#;默认:'#000000'
remarkSize: 16, //(可选项)数字类型;备注的文字大小;默认:16
remarkIconWidth: 30 //(可选项)数字类型;当备注是图片时,图片的宽度,图片为正方形;默认:30
},
forbidden: { //(可选项)JSON对象;屏蔽点击事件的列表项的样式配置
bgColor: '#B0C4DE', //(可选项)字符串类型;列表项背景色,支持rgb、#、rgba;默认:#C0C0C0
titleColor: '800000', //(可选项)字符串类型;列表项标题色,支持rgb、#、rgba;默认:#808080
subTitleColor: '#696969', //(可选项)字符串类型;列表项子标题色,支持rgb、#、rgba;默认:#808080
remarkColor: '#FFDEAD', //(可选项)字符串类型;列表项备注色,支持rgb、#、rgba;默认:#808080
sideslip: false //(可选项)布尔类型;是否只屏蔽侧滑;默认:false(侧滑和点击事件都屏蔽)
}
}
fixedOn:
showScrollBar:
ret:
{
eventType: 'show', //字符串类型;交互事件类型
//取值范围如下:
//show(插件加载成功)
//clickRightBtn(点击侧滑出现的右侧按钮)
//clickContent(点击列表项的内容,除了配图和备注以外的区域)
//clickImg(点击列表项的配图)
//clickRemark(点击列表项右侧备注)
//longPress (列表长按事件)
index: 0, //数字类型;列表项的索引
btnIndex: 0 //数字类型;列表项侧滑出现的按钮的索引
}
var UIListView = api.require('UIListView');
UIListView.open({
rect: {
x: 0,
y: 0,
w: api.winWidth,
h: api.frameHeight
},
data: [{
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}, {
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题,说明文字',
remark: '备注',
icon: ''
}],
rightBtns: [{
bgColor: '#388e8e',
activeBgColor: '',
width: 70,
title: '按钮',
titleSize: 12,
titleColor: '#fff',
icon: '',
iconWidth: 20
}],
styles: {
borderColor: '#696969',
item: {
bgColor: '#AFEEEE',
activeBgColor: '#F5F5F5',
height: 55.0,
imgWidth: 40,
imgHeight: 40,
imgCorner: 4,
placeholderImg: '',
titleSize: 12.0,
titleColor: '#000',
subTitleSize: 12.0,
subTitleColor: '#000',
remarkColor: '#000',
remarkSize: 16,
remarkIconWidth: 30
}
},
fixedOn: api.frameName
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **close**关闭数据列表插件
close()
var UIListView = api.require('UIListView');
UIListView.close();
iOS系统,Android系统
可提供的1.0.0及更高版本
# **show**显示 UIListView 插件
show()
var UIListView = api.require('UIListView');
UIListView.show();
iOS系统,Android系统
可提供的1.0.0及更高版本
# **hide**隐藏 UIListView 插件
hide()
var UIListView = api.require('UIListView');
UIListView.hide();
iOS系统,Android系统
可提供的1.0.0及更高版本
# **setAttr**设置列表的纵坐标和高度
setAttr({params}, callback(ret))
y:
h:
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.setAttr({
y: 40,
h: 200
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **getIndex**根据开发者自定义的唯一标识(open 接口的 data 参数中自定义的唯一标识)查找列表项对应的数据
getIndex({params}, callback(ret, err))
key:
value:
ret:
{
index: 0, //数字类型;当前列表项的索引
data: [] //数组类型;当前列表项的数据,内部字段与 open 时的 data 参数一致
}
var UIListView = api.require('UIListView');
UIListView.getIndex({
key: 'uid',
value: '1001'
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **getDataByIndex**根据列表项的索引获取对应的数据
getDataByIndex({params}, callback(ret))
index:
ret:
{
data: [] //数组类型;当前列表项的数据,内部字段与 open 时的 data 参数一致
}
var UIListView = api.require('UIListView');
UIListView.getDataByIndex({
index: 0
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **setSwipeBtns**设置侧滑显示出来的按钮
setSwipeBtns({params}, callback(ret))
index:
btns:
[{
bgColor: '#388e8e', //(可选项)字符串类型;按钮背景色,支持 rgb、rgba、#;默认:'#388e8e'
activeBgColor: '', //(可选项)字符串类型;按钮按下时的背景色,支持 rgb、rgba、#
width: 70, //(可选项)数字类型;按钮的宽度;默认:w / 4
title: '', //(可选项)字符串类型;按钮标题,水平、垂直居中
titleSize: 12, //(可选项)数字类型;按钮标题文字大小;默认:12
titleColor: '#fff', //(可选项)字符串类型;按钮标题文字颜色,支持 rgb、rgba、#;默认:'#ffffff'
icon: '', //(可选项)字符串类型;按钮标题前的图标路径(本地路径,支持fs://、widget://),水平、垂直居中,图标为正方形
iconWidth: 20 //(可选项)数字类型;按钮标题前的图标宽度,图标为正方形;默认:20
}]
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.setSwipeBtns({
index: 0,
btns: [{
bgColor: '#388e8e',
activeBgColor: '',
width: 70,
title: '',
titleSize: 12,
titleColor: '#fff',
icon: '',
iconWidth: 20
}]
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **reloadData**刷新列表数据
reloadData({params}, callback(ret))
data:
[{
imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
remark: '', //(可选项)字符串类型;右边备注文字
icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同 rightBtns 参数
}]
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.reloadData({
data: [{
imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
title: '新标题',
subTitle: '新子标题',
remark: '新备注',
icon: ''
}]
}, function(ret) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **deleteItem**根据索引删除某一条列表的数据
deleteItem({params}, callback(ret))
index:
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.deleteItem({
index: 2
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **updateItem**根据索引更新某一条列表的数据
updateItem({params}, callback(ret))
index:
data:
{
imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
remark: '', //(可选项)字符串类型;右边备注文字
icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同 rightBtns 参数
}
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.updateItem({
index: 2,
data: {
imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
title: '刷新标题',
subTitle: '刷新子标题',
remark: '刷新备注'
}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **insertItem**根据索引向某一条列表插入数据
insertItem({params}, callback(ret, err))
index:
data:
{
imgPath: '', //(可选项)字符串类型;列表项的附图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
remark: '', //(可选项)字符串类型;右边备注文字
icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,内部字段同 open 接口的 rightBtns 参数
}
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.insertItem({
index: 2,
data: {
imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
title: '12:00',
subTitle: 'YonBuilder移动开发粉丝互动会',
remark: '完成'
}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **appendData**向列表末端追加数据
appendData({params}, callback(ret))
data:
[{
imgPath: '', //(可选项)字符串类型;列表项的附图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
remark: '', //(可选项)字符串类型;右边备注文字
icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,内部字段同 open 接口的 rightBtns 参数
}]
ret:
{
status: true //布尔型;true||false
}
var UIListView = api.require('UIListView');
UIListView.appendData({
data: [{
imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
title: '新增标题',
subTitle: '新增子标题',
remark: '新增备注'
}]
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **getCount**获取当前列表的总数据量
getCount(callback(ret))
ret:
{
count: 21 //数字类型;当前列表包含的数据总数
}
var UIListView = api.require('UIListView');
UIListView.getCount(function(ret) {
api.alert({msg: JSON.stringify(ret)});
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **setRefreshHeader**设置下拉刷新,通过 reloadData 收起下拉刷新组件
setRefreshHeader({params}, callback(ret))
loadingImg:
bgColor:
textColor:
textDown:
textUp:
loadingText:
lastUpdateText:
showTime:
下拉刷新的事件回调
var UIListView = api.require('UIListView');
UIListView.setRefreshHeader({
loadingImg: 'widget://res/UIListView_arrow.png',
bgColor: '#F5F5F5',
textColor: '#8E8E8E',
textDown: '下拉可以刷新...',
textUp: '松开开始刷新...',
showTime: true
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
# **setRefreshFooter**设置上拉加载,通过 appendData 收起上拉加载组件
setRefreshFooter({params}, callback())
loadingImg:
bgColor:
textColor:
textUp:
textDown:
loadingText:
lastUpdateText:
showTime:
上拉加载的事件回调
var UIListView = api.require('UIListView');
UIListView.setRefreshFooter({
loadingImg: 'widget://res/UIListView_arrow.png',
bgColor: '#F5F5F5',
textColor: '#8E8E8E',
textUp: '上拉加载更多...',
textDown: '松开开始加载...',
showTime: true
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
为帮助用户更好更快的使用插件,论坛维护了一个示例,示例中包含示例代码、知识点讲解、注意事项等,供您参考。