DataList

FineUI.create({
	type: 'DataList', renderTo: document.body, width: 300, height: 300, title: '城市列表',
	data: [['bj', '北京'], ['sh', '上海'], ['gz', '广州'], ['sz', '深圳']]
});

FineUI.create({
	type: 'DataList', renderTo: document.body, width: 300, height: 300, title: '可多选',
	data: [['a', '选项 A'], ['b', '选项 B'], ['c', '选项 C'], ['d', '选项 D']],
	selectable: true, multiSelect: true
});

FineUI.create({
	type: 'DataList', renderTo: document.body, width: 300, height: 350, title: '分组列表', group: true,
	fields: ['value', 'text', 'group'],
	data: [
		['bj', '北京', '直辖市'],
		['sh', '上海', '直辖市'],
		['gz', '广州', '广东省'],
		['sz', '深圳', '广东省']
	]
});

FineUI.create({
	type: 'DataList', renderTo: document.body, width: 300, height: 250, selectable: true,
	data: [['a', '选项 A'], ['b', '选项 B'], ['c', '选项 C']],
	listeners: {
		itemclick: function (event, itemValue) {
			FineUI.alert('点击了 value：' + itemValue);
		}
	}
});

Extends

• FineUI.Container

Members

el :jQuery

Description:

• 控件对应的jQuery节点对象

Inherited From:

• FineUI.Component#el

Type:

• jQuery

items :Object

Description:

• 子控件列表

Inherited From:

• FineUI.Container#items

Type:

• Object

Methods

add(value)

Description:

• 添加新的子控件到当前控件（追加到子项末尾）

Inherited From:

• FineUI.Container#add

Examples

向菜单末尾追加一个分隔符和一个新菜单项（'-' 是 MenuSeparator 的快捷字符串形式）：

// 假设 menu1 当前 items 为：[菜单1, 菜单2]
FineUI.ui.menu1.add([
    '-',
    { type: 'MenuItem', text: '新菜单项', iconFont: 'plus' }
]);
// 追加后 items 顺序：[菜单1, 菜单2, ----, 新菜单项]

动态在工具栏末尾追加一个按钮：

FineUI.ui.toolbar1.add({
    type: 'Button', text: '导出', iconFont: 'download',
    handler: function () {
        FineUI.alert('导出');
    }
});

Parameters:

appendData(data)

Description:

• 追加数据（在现有数据末尾追加，不会清空；移动端"加载更多"场景常用）

Example

"加载更多"按钮场景：

FineUI.ui.datalist1.appendData([
    ['nj', '南京'],
    ['hz', '杭州']
]);

Parameters:

clearDirty()

Description:

• 清空容器内字段的改变状态（接受当前值为新的初始值；提交服务端成功后调用，isDirty随后会返回 false）

Inherited From:

• FineUI.Container#clearDirty

clearSelection()

Description:

• 清空全部选中项

deselectAllItems()

Description:

• 取消选中全部列表项

deselectItem(row)

Description:

• 取消选中列表项

Parameters:

deselectItems(itemValues)

Description:

• 取消选中多列表项

Parameters:

disable()

Description:

• 禁用控件（按钮变灰、表单字段不可输入；可用isDisabled查询当前状态）

Inherited From:

• FineUI.Component#disable

Example

提交期间禁用按钮，避免重复提交（用 jQuery 的 $.ajax）：

FineUI.create({
    type: 'Button', text: '提交',
    handler: function () {
        var me = this;
        me.disable();
        $.ajax({
            url: '/api/save', method: 'POST', dataType: 'json',
            complete: function () {
                me.enable();
            }
        });
    }
});

doLayout(startFormTopmostComonentopt)

Description:

• 执行布局操作

Inherited From:

• FineUI.Component#doLayout

Parameters:

enable()

Description:

• 启用控件（与disable对应）

Inherited From:

• FineUI.Component#enable

getAttr(key) → {string}

Description:

• 获取节点属性

Inherited From:

• FineUI.Component#getAttr

Parameters:

Returns:

Type

string

getEncodedText(text) → {string}

Description:

• 获取编码后的字符串

Inherited From:

• FineUI.Component#getEncodedText

Parameters:

Returns:

Type

string

getFormFields() → {Array.<FineUI.Field>}

Description:

• 获取容器内（深度遍历）所有表单字段实例（FineUI.Field的子类，如TextBox/NumberBox/DatePicker等）

Inherited From:

• FineUI.Container#getFormFields

Example

遍历表单全部字段，序列化为 name → value 的对象（用于自定义 ajax 提交；字段未声明name时改用id）：

var values = {};
FineUI.ui.form1.getFormFields().forEach(function (field) {
    values[field.name || field.id] = field.getValue();
});
// values 形如：{ tbxUserName: 'FineUIPro', numberAge: 30, ... }

Returns:

Type

Array.<FineUI.Field>

getHeight() → {number}

Description:

• 获取控件高度

Inherited From:

• FineUI.Component#getHeight

Returns:

Type

number

getItem(value) → {FineUI.Component}

Description:

• 获取子控件（按索引/标识符/匹配函数查找；通常配合items无显式 id 的场景，比按FineUI.ui[id]更精准）

Inherited From:

• FineUI.Container#getItem

Examples

按索引取第一个子控件：

var firstChild = FineUI.ui.toolbar1.getItem(0);

按 id 取子控件：

var btn = FineUI.ui.toolbar1.getItem('btnSave');

按匹配函数找第一个匹配的子控件（函数对每项返回 true 即匹配）：

var btn = FineUI.ui.toolbar1.getItem(function (item) {
    return item.type === 'Button' && item.text === '保存';
});

Parameters:

Returns:

Type

FineUI.Component

getItemData(item) → {Object}

Description:

• 获取项数据

Parameters:

Returns:

Type

Object

getItemEl(row) → {jQuery}

Description:

• 获取列表列表项元素

Parameters:

Returns:

Type

jQuery

getItemEls() → {jQuery}

Description:

• 获取列表列表项元素集合

Returns:

Type

jQuery

getSelectedItem(returnItemDataopt) → {string|Object}

Description:

• 获取选中的列表项值（单选场景）

Example

单选场景取选中 value：

var value = FineUI.ui.datalist1.getSelectedItem();
// 例如：'bj'

Parameters:

Returns:

Type

string | Object

getSelectedItems(returnItemDataopt) → {Array.<string>|Array.<Object>}

Description:

• 获取选中的列表项值数组（多选场景）

Examples

获取所有选中项的 value 字符串数组：

var values = FineUI.ui.datalist1.getSelectedItems();
// 例如：['bj', 'sh']

获取选中项的完整数据：

var items = FineUI.ui.datalist1.getSelectedItems(true);
// 例如：[{ value: 'bj', text: '北京' }, { value: 'sh', text: '上海' }]

Parameters:

Returns:

Type

Array.<string> | Array.<Object>

getTextByValue(value) → {string}

Description:

• 获取值对应的显示文本

Parameters:

Returns:

Type

string

getTooltip() → {string}

Description:

• 获取提示信息

Inherited From:

• FineUI.Component#getTooltip

Returns:

Type

string

getValueByText(text) → {string}

Description:

• 获取显示文本对应的值

Parameters:

Returns:

Type

string

getWidth() → {number}

Description:

• 获取控件宽度

Inherited From:

• FineUI.Component#getWidth

Returns:

Type

number

hide()

Description:

• 隐藏控件（默认通过 CSS display:none 隐藏；可通过hiddenMode选择 visibility/offsets 模式以保留布局空间）

Inherited From:

• FineUI.Component#hide

Example

根据权限隐藏按钮：

if (!currentUser.canEdit) {
    FineUI.ui.btnEdit.hide();
}

hideLoading()

Description:

• 隐藏加载动画

Inherited From:

• FineUI.Container#hideLoading

hidePopEl()

Description:

• 隐藏容器内的所有弹出框

Inherited From:

• FineUI.Container#hidePopEl

insert(insertIndex, value)

Description:

• 插入新的子控件到当前控件

Inherited From:

• FineUI.Container#insert

Examples

向菜单的开头插入一个新菜单项和一个分隔符（'-' 是 MenuSeparator 的快捷字符串形式）：

// 假设 menu1 当前 items 为：[菜单1, 菜单2, 菜单3]
FineUI.ui.menu1.insert(0, [
    { type: 'MenuItem', text: '新增', iconFont: 'plus' },
    '-'
]);
// 插入后 items 顺序：[新增, ----, 菜单1, 菜单2, 菜单3]

在工具栏第 2 项位置插入一个分隔符和一个新按钮（Toolbar 中的'-' 是 ToolbarSeparator 的快捷字符串形式）：

FineUI.ui.toolbar1.insert(2, [
    '-',
    { type: 'Button', text: '新增', iconFont: 'plus' }
]);

Parameters:

isDirty() → {boolean}

Description:

• 容器内的表单字段是否已经改变（任意字段值与初始值不同时返回 true，可用于提示"未保存"）

Inherited From:

• FineUI.Container#isDirty

Returns:

Type

boolean

isDisabled() → {boolean}

Description:

• 是否禁用

Inherited From:

• FineUI.Component#isDisabled

Returns:

Type

boolean

isType(value) → {boolean}

Description:

• 检测当前实例是否指定的控件类型

Inherited From:

• FineUI.Base#isType

Example

grid1.isType('panel') // 返回true
grid1.isType('grid')  // 返回true

Parameters:

Returns:

Type

boolean

isValid(onlyFirstInvalidFieldopt) → {Array.<Object>}

Description:

• 容器内的表单字段是否有效（会同时触发各字段的校验提示显示；常配合Button的validateForm属性自动调用）

Inherited From:

• FineUI.Container#isValid

Examples

提交按钮显式校验（不依赖validateForm属性）：

FineUI.create({
    type: 'Button', text: '提交',
    handler: function () {
        var result = FineUI.ui.form1.isValid();
        if (result[0]) {
            // 校验通过 → 提交逻辑
        } else {
            // result[1] 是第一个无效字段，可聚焦提示
            result[1].focus();
        }
    }
});

仅检查"是否有效"（推荐的更常用方式：让 Button 的validateForm自动校验，handler 仅在通过时执行）：

FineUI.create({
    type: 'Button', text: '提交', validateForm: 'form1',
    handler: function () {
        // 走到这里说明 form1 已校验通过
    }
});

Parameters:

Returns:

Type

Array.<Object>

isVisible() → {boolean}

Description:

• 是否可见

Inherited From:

• FineUI.Component#isVisible

Returns:

Type

boolean

loadData(data, selectedItemsopt)

Description:

• 加载数据（会替换列表全部项；可同时指定默认选中值）

Examples

加载列表数据：

FineUI.ui.datalist1.loadData([
    ['bj', '北京'],
    ['sh', '上海']
]);

加载并默认选中：

FineUI.ui.datalist1.loadData(
    [['bj', '北京'], ['sh', '上海'], ['gz', '广州']],
    ['bj', 'sh']  // 多选场景默认选中
);

Parameters:

off(eventNames, fnopt)

Description:

• 移除事件

Inherited From:

• FineUI.Component#off

Examples

移除特定回调：

function onMyClick() { ... }
FineUI.ui.btn1.on('click', onMyClick);
// 后续解绑：
FineUI.ui.btn1.off('click', onMyClick);

移除某事件下的全部回调（不传 fn 参数）：

FineUI.ui.btn1.off('click');

Parameters:

on(eventNames, fn)

Description:

• 注册事件（运行时绑定；与配置参数listeners的初始绑定等价，但可在控件创建后动态追加）

Inherited From:

• FineUI.Component#on

Examples

初始绑定形态：在FineUI.create时通过listeners配置项一次性声明：

FineUI.create({
    type: 'Button', renderTo: document.body, text: '按钮',
    listeners: {
        click: function (event) {
            FineUI.alert('button clicked');
        },
        // 同一个 listeners 内可以同时声明多个事件
        beforeclick: function (event) {
            // 返回 false 可阻止 click 事件
        }
    }
});

运行时绑定形态：控件创建后通过on()追加，效果与上面的listeners等价：

FineUI.ui.btn1.on('click', function (event) {
    FineUI.alert('button clicked');
});

on()一次绑定多个事件（事件名之间空格分隔）：

FineUI.ui.tbxName.on('focus blur', function () {
    console.log('focus 或 blur 触发');
});

Parameters:

remove()

Description:

• 从父控件中移除当前控件并销毁其 DOM（不可恢复；移除后 FineUI.ui[id] 也会清除）。触发 remove 事件可用于清理外部资源。

Inherited From:

• FineUI.Component#remove

Example

动态添加 + 移除子控件：

var btn = FineUI.create({
    type: 'Button', text: '临时按钮', renderTo: document.body
});
// 5 秒后移除
setTimeout(function () {
    btn.remove();
}, 5000);

removeAttr(key)

Description:

• 删除节点属性

Inherited From:

• FineUI.Component#removeAttr

Parameters:

removeTooltip()

Description:

• 删除提示信息

Inherited From:

• FineUI.Component#removeTooltip

reset()

Description:

• 重置容器内的全部字段（将所有字段恢复到初始值；初始值是字段创建时的value，或上次clearDirty后的值）

Inherited From:

• FineUI.Container#reset

Example

"重置"按钮：

FineUI.create({
    type: 'Button', text: '重置',
    handler: function () {
        FineUI.ui.form1.reset();
    }
});

selectAllItems()

Description:

• 选中全部列表项

selectItem(itemValue, options)

Description:

• 选中列表项

Parameters:

selectItems(itemValues, optionsopt)

Description:

• 选中多个列表项

Examples

批量选中多项（替换当前选中）：

FineUI.ui.datalist1.selectItems(['bj', 'sh']);

在已有选中基础上追加：

FineUI.ui.datalist1.selectItems(['gz'], { keep: true });

Parameters:

setAttr(key, value)

Description:

• 设置节点属性

Inherited From:

• FineUI.Component#setAttr

Parameters:

setAttrs(attrs)

Description:

• 设置节点属性

Inherited From:

• FineUI.Component#setAttrs

Parameters:

setDisabled(disabled)

Description:

• 设置控件的禁用状态

Inherited From:

• FineUI.Component#setDisabled

Parameters:

setEnabled(enabled)

Description:

• 设置控件的启用状态

Inherited From:

• FineUI.Component#setEnabled

Parameters:

setHeight(height)

Description:

• 设置控件高度

Inherited From:

• FineUI.Component#setHeight

Parameters:

setHidden(hidden)

Description:

• 设置控件的隐藏状态

Inherited From:

• FineUI.Component#setHidden

Parameters:

setSize(width, height)

Description:

• 设置控件尺寸（同时设置宽高；等价于setWidth + setHeight但只触发一次布局）

Inherited From:

• FineUI.Component#setSize

Example

响应窗口 resize 调整面板尺寸：

$(window).on('resize', function () {
    FineUI.ui.panel1.setSize($(window).width() - 20, $(window).height() - 40);
});

Parameters:

setTooltip(tooltip)

Description:

• 设置提示信息

Inherited From:

• FineUI.Component#setTooltip

Parameters:

setVisible(visible)

Description:

• 设置控件的显示状态

Inherited From:

• FineUI.Component#setVisible

Parameters:

setWidth(width)

Description:

• 设置控件宽度

Inherited From:

• FineUI.Component#setWidth

Parameters:

show()

Description:

• 显示控件（与hide对应）

Inherited From:

• FineUI.Component#show

Example

根据下拉列表的选中项，联动显示某区块：

FineUI.ui.ddlType.on('change', function () {
    if (this.getValue() === 'advanced') {
        FineUI.ui.pnlAdvanced.show();
    } else {
        FineUI.ui.pnlAdvanced.hide();
    }
});

showLoading(opacity, container)

Description:

• 显示加载动画

Inherited From:

• FineUI.Container#showLoading

Parameters:

toggleEnabled()

Description:

• 切换启用状态

Inherited From:

• FineUI.Component#toggleEnabled

toggleVisible()

Description:

• 切换显示状态

Inherited From:

• FineUI.Component#toggleVisible

trigger(eventName, args)

Description:

• 触发事件

Inherited From:

• FineUI.Component#trigger

Parameters:

Events

beforehide

Description:

• 隐藏控件之前触发（返回false则取消隐藏操作）

Inherited From:

• FineUI.Component#event:beforehide

beforeitemcontextmenu

Description:

• 右键点击行时触发（返回false则阻止浏览器默认的右键菜单）

Parameters:

beforeshow

Description:

• 显示控件之前触发（返回false则取消显示操作）

Inherited From:

• FineUI.Component#event:beforeshow

hide

Description:

• 隐藏控件时触发

Inherited From:

• FineUI.Component#event:hide

itemclick

Description:

• 点击列表项时触发

Parameters:

itemdblclick

Description:

• 双击行时触发

Parameters:

itemdeselect

Description:

• 取消选中列表项时触发

Parameters:

itemselect

Description:

• 选中列表项时触发

Parameters:

layout

Description:

• 布局控件时触发

Inherited From:

• FineUI.Component#event:layout

remove

Description:

• 移除控件时触发（调用 remove() 时，控件 DOM 被销毁之前触发；可用于清理外部资源 / 解绑全局事件）

Inherited From:

• FineUI.Component#event:remove

render

Description:

• 渲染控件时触发

Inherited From:

• FineUI.Component#event:render

selectionchange

Description:

• 选中项改变时触发

Parameters:

show

Description:

• 显示控件时触发

Inherited From:

• FineUI.Component#event:show