UIListSearch

来自于:官方立即使用

概述(Beta版)

UIListSearch 模块封装了一个数据列表控件,可用于展示搜索到的结果。开发者可自定义列表底部的标签。列表会根据内容多少自适应显示,内容过多时可上下拖动查看。 labelEnabled 模块示意图如下图所示:

open

打开列表模块

open({params}, callback(ret))

params

rect:

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

contacts:

  • 类型:数组对象
  • 描述:列表数据源
  • 内部字段:
[{               
       remark: '张三',            //字符串类型;条目的标题,不传则不显示
       dept_name: '研发部',        //字符串类型;条目的子标题,不传则不显示
       position: '工程师'        //字符串类型;条目的职位,不传则不显示
}]

label:

  • 类型:JSON 对象
  • 描述:(可选项)底部标签配置,若不传则不显示底部标签。此参数即将废弃,用labels参数替代,若传了labels参数,label参数将被忽略。
  • 内部字段:
{               
       icon: 'fs://UILSec/icon.png', //字符串类型;标签头像路径,要求本地路径(fs://、widget://)
       title: 'C专家',                //字符串类型;标签的标题,不传则不显示
       subtitle: '知识地图标签',       //字符串类型;标签的子标题,不传则不显示
       remark: '10人'                //字符串类型;标签的备注,不传则不显示
}

labels:

  • 类型:JSON 对象数组
  • 描述:(可选项)底部标签配置,若不传则不显示底部标签。
  • 内部字段:
[{               
       icon: 'fs://UILSec/icon.png', //字符串类型;标签头像路径,要求本地路径(fs://、widget://)
       title: 'C专家',                //字符串类型;标签的标题,不传则不显示
       subtitle: '知识地图标签',       //字符串类型;标签的子标题,不传则不显示
       remark: '10人'                //字符串类型;标签的备注,不传则不显示
}]

labelEnabled:

  • 类型:布尔
  • 默认:false
  • 描述:(可选项)底部标签是否可以点击交互,若设置为能点击,点击后会回调label的索引及内容。

fixedOn:

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   index: 0,          //数字类型;被点击的条目在所在区域内的索引
   contact: {},       //JSON 对象;所选条目的联系人信息,内容同传入的数据一致
   label: {}          //JSON 对象;所选条目的标签信息,内容同传入的数据一致
}

示例代码

var UIListSearch = api.require('UIListSearch');
UIListSearch.open({
    rect: {
        x: 0,
        y: 0,
        w: api.winWidth,
        h: api.frameHeight
    },
    contacts:[{
        "remark": "张三",
        "position": "工程师",
        "dept_name": "研发部"
    },{
        "remark": "李四",
        "position": "销售经理",
        "dept_name": "销售部"
    }],
    fixedOn: api.frameName
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } 
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭数据列表模块,从内存里清除

close()

示例代码

var UIListSearch = api.require('UIListSearch');
UIListSearch.close();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

show

显示已隐藏的列表模块

show()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

隐藏列表模块,并未从内存里清除

hide()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reloadData

刷新列表数据

reloadData({params})

params

contacts:

  • 类型:数组对象
  • 描述:列表数据源
  • 内部字段:
[{               
       remark: '张三',            //字符串类型;条目的标题,不传则不显示
       dept_name: '研发部',        //字符串类型;条目的子标题,不传则不显示
       position: '工程师'        //字符串类型;条目的职位,不传则不显示
}]

label:

  • 类型:JSON 对象
  • 描述:(可选项)底部标签配置,若不传则不显示底部标签。此参数即将废弃,用labels参数替代,若传了labels参数,label参数将被忽略。
  • 内部字段:
{               
       icon: 'fs://UILSec/icon.png', //字符串类型;标签头像路径,要求本地路径(fs://、widget://)
       title: 'C专家',                //字符串类型;标签的标题,不传则不显示
       subtitle: '知识地图标签',       //字符串类型;标签的子标题,不传则不显示
       remark: '10人'                //字符串类型;标签的备注,不传则不显示
}

labels:

  • 类型:JSON 对象数组
  • 描述:(可选项)底部标签配置,若不传则不显示底部标签。
  • 内部字段:
[{               
       icon: 'fs://UILSec/icon.png', //字符串类型;标签头像路径,要求本地路径(fs://、widget://)
       title: 'C专家',                //字符串类型;标签的标题,不传则不显示
       subtitle: '知识地图标签',       //字符串类型;标签的子标题,不传则不显示
       remark: '10人'                //字符串类型;标签的备注,不传则不显示
}]

示例代码

var UIListSearch = api.require('UIListSearch');
UIListSearch.reloadData({
    contacts:[{
        "remark": "张三",
        "position": "工程师",
        "dept_name": "研发部"
    },{
        "remark": "李四",
        "position": "销售经理",
        "dept_name": "销售部"
    }]
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本