UIListEdit

概述

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

open

打开 UIListEdit 插件

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

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)插件的位置及尺寸
  • 备注:Android 必须传此参数。
  • 内部字段:
{
    x: 0,   //(可选项)数字类型;插件左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
    y: 0,   //(可选项)数字类型;插件左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
    w: 320, //(可选项)数字类型;插件的宽度;默认值:auto
    h: 480  //(可选项)数字类型;插件的高度;默认值:auto
}

data:

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

topData:

  • 类型:JSON 对象
  • 描述:(可选项)列表顶部的数据源
  • 内部字段:
{
     showData : true, 		 // (可选项)布尔类型;是否显示数据;默认:false
     topTitle : '',			 //(可选项)字符串类型;列表顶部分组的标题
     bottomTitle : '',			 //(可选项)字符串类型;列表第二分组的标题
    imgPath: '',            //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示(这句话不支持iOS)
    title: '',              //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示(这句话不支持iOS)
    subTitle: '',           //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示(这句话不支持iOS)
    jobTitle:'产品经理',     //(可选项)字符串类型;职称
    label:'同学/标签/标签',    //(可选项)字符串类型,标签
    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:

  • 类型:布尔
  • 描述:(可选项)是否开启弹动,android 平台不支持本参数
  • 默认:false

styles:

  • 类型:JSON 对象
  • 描述:(可选项)插件各部分的样式
  • 内部字段:
{
    selectIcon:{                         // JSON对象;选择图标设置
    normalIcon:'',                  //(可选项)字符串类型;非选中状态的图标(支持widget:// fs://)
    selectedIcon:'',                //(可选项)字符串类型;选中状态的图标(支持widget:// fs://)
    size:16                        //(可选项)字符串类型;图标的大小
    },
    deleteIcon:{                        // JSON对象;选择图标设置
    icon:'',                       //(可选项)字符串类型;删除图标(支持widget:// fs://)
    size:16                        //(可选项)字符串类型;图标的大小
    },
    borderColor: '#696969',             //(可选项)字符串类型;列表分割线的颜色,支持 rgb、rgba、#;默认:'#696969'
    borderWidth:,                  //(可选项)数字类型;列表分割线宽度,默认值:1
    item: {                             //(可选项)JSON对象;列表项的样式
        bgColor: '#AFEEEE',             //(可选项)字符串类型;列表项的背景色,支持 rgb、rgba、#;默认:'#AFEEEE'
        activeBgColor: '#F5F5F5',       //(可选项)字符串类型;列表项按下时的背景色,支持 rgb、rgba、#;默认:'#F5F5F5'
        height: 100,                     //(可选项)数字类型;列表项的高度;默认:100 注意:如果height<100,插件会处理为100
        imgWidth: 40,                   //(可选项)数字类型;列表项配图的宽度;默认:列表项的高度减去10px
        imgHeight: 40,                  //(可选项)数字类型;列表项配图的高度;默认:列表项的高度减去10px
        imgCorner: 4,                   //(可选项)数字类型;列表项配图的圆角大小;默认:0
        placeholderImg: '',             //(可选项)字符串类型;列表项配图的占位图路径(本地路径,fs://、widget://)
        titleSize: 12,                  //(可选项)数字类型;列表项标题文字大小;默认:12
        titleColor: '#000',             //(可选项)字符串类型;列表项标题文字颜色,支持 rgb,rgba,#;默认:'#000000'
        titleMaxWidth: 200,                  //(可选项)数字类型;列表项标题文字最大宽度,超过显示省略号;默认:无
        subTitleSize: 12,               //(可选项)数字类型;列表项子标题文字大小;默认:12
        subTitleColor: '#000',          //(可选项)字符串类型:列表项子标题文字颜色,支持 rgb、rgba、#;默认:'#000000' 
    labelColor:'#000',              //(可选项)字符串类型;标签文字颜色;默认:#000
    labelSize:14,                    //(可选项)数字类型;标签文字大小;默认:14
    jobTitleColor:'#000',            //(可选项)字符串类型;职称文字颜色;默认:#000
    jobTitleSize:10,                 //(可选项)数字类型;职称文字大小;默认:10
    }
}

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)插件视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:插件依附于当前 window

showScrollBar:

  • 类型:布尔
  • 描述:(可选项)是否显示滚动条
  • 默认:true

callback(ret)

ret:

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

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.open({
    rect: {
        x: 0,
        y: 0,
        w: api.winWidth,
        h: api.frameHeight
    },
    data: [{
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        uid: '1001',
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }, {
        imgPath: 'widget://res/img/apicloud.png',
        title: '标题',
        subTitle: '子标题,说明文字',
        jobTitle:'大客户项目经理',
        label: '同学/标签/标签',
    }],
    rightBtns: [{
        bgColor: '#388e8e',
        activeBgColor: '',
        width: 70,
        title: '按钮',
        titleSize: 12,
        titleColor: '#fff',
        icon: '',
        iconWidth: 20
    }],
    styles: {
        borderColor: '#696969',
        item: {
            bgColor: '#AFEEEE',
            activeBgColor: '#F5F5F5',
            height: 100,
            imgWidth: 40,
            imgHeight: 40,
            imgCorner: 4,
            placeholderImg: '',
            titleSize: 12.0,
            titleColor: '#000',
            subTitleSize: 12.0,
            subTitleColor: '#000',
            labelColor: '#9AC0CD',
            labelSize:13,
            jobTitleColor: '#9F79EE',
            jobTitleSize:10
        }
    },
    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 UIListEdit = api.require('UIListEdit');
UIListEdit.close();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **show**

显示 UIListEdit 插件

show()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **hide**

隐藏 UIListEdit 插件

hide()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **cancelTopData**

隐藏顶部分组的内容

cancelTopData()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.2及更高版本

# **resetTopData**

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

params

topData:

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

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.2及更高版本

# **resetRightBtn**

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

resetRightBtn({params})

params

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
}]

示例代码

var UIListEdit = api.require('UIListEdit');
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 对象
  • 内部字段:
{
    index: 0,   //数字类型;当前列表项的索引
    data: []    //数组类型;当前列表项的数据,内部字段与 open 时的 data 参数一致
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

index:

  • 类型:数字
  • 描述:(可选项)列表项的索引
  • 默认值:0

callback(ret)

ret:

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

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

index:

  • 类型:数字
  • 描述:(可选项)列表项的索引
  • 默认值:0

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
}]

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true       //布尔型;true||false
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

data:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true        //布尔型;true||false     
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

index:

  • 类型:数字
  • 描述:(可选项)数据列表的索引
  • 默认值:0

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true       //布尔型;true||false
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

index:

  • 类型:数字
  • 描述:(可选项)数据列表的索引
  • 默认值:0

data:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true     //布尔型;true||false
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

index:

  • 类型:数字
  • 描述:(可选项)数据列表的索引
  • 默认值:列表最后一条数据的索引

data:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true          //布尔型;true||false
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

params

data:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true        //布尔型;true||false
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.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))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    count: 21        //数字类型;当前列表包含的数据总数
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.getCount(function(ret) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **setListMode**

设置列表模式

setListMode()

params

mode:

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

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **getListMode**

获取列表模式

getListMode()

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    mode:'select' // 字符串类型;列表模式;取值范围:
                                        // select 选择模式
                                        // delete 删除模式
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.getListMode(function(ret){
    api.alert({msg: JSON.stringify(ret)});	
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **getSelectedIndexs**

获取选中的项的索引

callback(ret)

ret:

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

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.getSelectedIndexs(function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

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()

下拉刷新的事件回调

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.setRefreshHeader({
    loadingImg: 'widget://res/UIListEdit_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())

params

loadingImg:

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

bgColor:

  • 类型:字符串
  • 描述:(可选项)上拉加载区域的背景色,支持 rgb、rgba、#
  • 默认值:'#f5f5f5'

textColor:

  • 类型:字符串
  • 描述:(可选项)提示文字颜色,支持 rgb、rgba、#
  • 默认值:'#8e8e8e'

textUp:

  • 类型:字符串
  • 描述:(可选项)上拉提示文字
  • 默认值:'上拉加载更多...'

textDown:

  • 类型:字符串
  • 描述:(可选项)松开提示文字
  • 默认值:'松开开始加载...'

loadingText:

  • 类型:字符串
  • 描述:(可选项)提示文字
  • 默认值:正在加载...

lastUpdateText:

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

showTime:

  • 类型:布尔值
  • 描述:(可选项)是否显示刷新时间
  • 默认值:true

callback(ret)

上拉加载的事件回调

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.setRefreshFooter({
    loadingImg: 'widget://res/UIListEdit_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及更高版本

# **reset**

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

reset({params})

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)插件的位置及尺寸
  • 备注:Android 必须传此参数。
  • 内部字段:
{
    x: 0,   //(可选项)数字类型;插件左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
    y: 0,   //(可选项)数字类型;插件左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
    w: 320, //(可选项)数字类型;插件的宽度;默认值:auto
    h: 480  //(可选项)数字类型;插件的高度;默认值:auto
}

styles:

  • 类型:JSON 对象
  • 描述:(可选项)插件各部分的样式
  • 内部字段:
{
    selectIcon:{                         // JSON对象;选择图标设置
    normalIcon:'',                  //(可选项)字符串类型;非选中状态的图标(支持widget:// fs://)
    selectedIcon:'',                //(可选项)字符串类型;选中状态的图标(支持widget:// fs://)
    size:16                        //(可选项)字符串类型;图标的大小
    },
    deleteIcon:{                        // JSON对象;选择图标设置
    icon:'',                       //(可选项)字符串类型;删除图标(支持widget:// fs://)
    size:16                        //(可选项)字符串类型;图标的大小
    },
    borderColor: '#696969',             //(可选项)字符串类型;列表分割线的颜色,支持 rgb、rgba、#;默认:'#696969'
    item: {                             //(可选项)JSON对象;列表项的样式
        bgColor: '#AFEEEE',             //(可选项)字符串类型;列表项的背景色,支持 rgb、rgba、#;默认:'#AFEEEE'
        activeBgColor: '#F5F5F5',       //(可选项)字符串类型;列表项按下时的背景色,支持 rgb、rgba、#;默认:'#F5F5F5'
        height: 100,                     //(可选项)数字类型;列表项的高度;默认:100 注意:如果height<100,插件会处理为100
        imgWidth: 40,                   //(可选项)数字类型;列表项配图的宽度;默认:列表项的高度减去10px
        imgHeight: 40,                  //(可选项)数字类型;列表项配图的高度;默认:列表项的高度减去10px
        imgCorner: 4,                   //(可选项)数字类型;列表项配图的圆角大小;默认:0
        placeholderImg: '',             //(可选项)字符串类型;列表项配图的占位图路径(本地路径,fs://、widget://)
        titleSize: 12,                  //(可选项)数字类型;列表项标题文字大小;默认:12
        titleColor: '#000',             //(可选项)字符串类型;列表项标题文字颜色,支持 rgb,rgba,#;默认:'#000000'
        titleMaxWidth: 200,                  //(可选项)数字类型;列表项标题文字最大宽度,超过显示省略号;默认:无
        subTitleSize: 12,               //(可选项)数字类型;列表项子标题文字大小;默认:12
        subTitleColor: '#000',          //(可选项)字符串类型:列表项子标题文字颜色,支持 rgb、rgba、#;默认:'#000000' 
    labelColor:'#000',              //(可选项)字符串类型;标签文字颜色;默认:#000
    labelSize:14,                    //(可选项)数字类型;标签文字大小;默认:14
    jobTitleColor:'#000',            //(可选项)字符串类型;职称文字颜色;默认:#000
    jobTitleSize:10,                 //(可选项)数字类型;职称文字大小;默认:10
    }
}

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.reset({
    rect: {
        x: 0,
        y: 0,
        w: api.winWidth,
        h: api.frameHeight
    },
    styles: {
        borderColor: '#696969',
        item: {
            bgColor: '#AFEEEE',
            activeBgColor: '#F5F5F5',
            height: 100,
            imgWidth: 40,
            imgHeight: 40,
            imgCorner: 4,
            placeholderImg: '',
            titleSize: 12.0,
            titleColor: '#000',
            subTitleSize: 12.0,
            subTitleColor: '#000',
            labelColor: '#9AC0CD',
            labelSize:13,
            jobTitleColor: '#9F79EE',
            jobTitleSize:10
        }
    },
}, function(ret) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **allSelected**

全选

callback(ret)

ret:

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

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.allSelected(function(ret) {
        api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

# **cancleSelected**

取消全选全选

callback(ret)

ret:

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

示例代码

var UIListEdit = api.require('UIListEdit');
UIListEdit.cancleSelected(function(ret) {
        api.alert({msg: JSON.stringify(ret)});
});
是否仍需要帮助? 请保持联络!
最后更新于 2024/12/2