DataList

F. DataList

new DataList(options)

Description:

  • 列表控件

Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
fields Array.<string> ['value','text','enabled','group','href','hrefTarget','arrow'

数据源对应的字段
group boolean false

是否启用分组
selectable boolean false

是否可选择
multiSelect boolean false

是否允许多选（通过 Ctrl, Shift 键进行多选）
enableTextSelection boolean false

是否启用文本选择
keepCurrentSelection boolean false

多选时保持当前已选中项
clickOnContextMenu boolean true

右键点击时选中当前项（默认为true）
type string 'datalist'

控件类型

Extends

Members

el :jQuery

Description:

  • 控件对应的jQuery节点对象

Inherited From:

控件对应的jQuery节点对象

Type:
  • jQuery

Methods

appendData(data)

Description:

  • 追加数据

Parameters:
Name Type Description
data Array.<Object>

数据

clearSelection()

Description:

  • 清空全部选中项

deselectAllItems()

Description:

  • 取消选中全部列表项

deselectItem(row)

Description:

  • 取消选中列表项

Parameters:
Name Type Description
row number | string | jQuery

项索引、项值或者项元素

deselectItems(itemValues)

Description:

  • 取消选中多列表项

Parameters:
Name Type Description
itemValues Array.<number> | Array.<string> | Array.<jQuery>

项索引数组、项值数组或者项元素数组

disable()

Description:

  • 禁用控件

Inherited From:

doLayout(startFormTopmostComonentopt)

Description:

  • 执行布局操作

Inherited From:
Parameters:
Name Type Attributes Default Description
startFormTopmostComonent boolean <optional>
 false

从最顶层的控件开始布局

enable()

Description:

  • 启用控件

Inherited From:

getAttr(key) → {string}

Description:

  • 获取节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
Returns:

节点属性值

Type
string

getHeight() → {number}

Description:

  • 获取控件高度

Inherited From:
Returns:

高度

Type
number

getItemData(item) → {Object}

Description:

  • 获取项数据

Parameters:
Name Type Description
item number | string | jQuery

项索引、项值或者项元素
Returns:

项数据

Type
Object

getItemEl(row) → {jQuery}

Description:

  • 获取列表项元素

Parameters:
Name Type Description
row number | string | jQuery

项索引、项值或者项元素
Returns:

列表项元素

Type
jQuery

getItemEls() → {jQuery}

Description:

  • 获取列表项元素集合

Returns:

列表项元素集合

Type
jQuery

getSelectedItem(returnItemData) → {string}

Description:

  • 获取选中的项值

Parameters:
Name Type Description
returnItemData boolean

返回包含项对象的数组，否则返回包含项值的数组
Returns:

列值

Type
string

getSelectedItems(returnItemData) → {Array.<string>}

Description:

  • 获取选中的项值数组

Parameters:
Name Type Description
returnItemData boolean

返回包含项对象的数组，否则返回包含项值的数组
Returns:

项值数组

Type
Array.<string>

getTextByValue(value) → {string}

Description:

  • 获取值对应的显示文本

Parameters:
Name Type Description
value string

值
Returns:

值对应的显示文本

Type
string

getTooltip() → {string}

Description:

  • 获取提示信息

Inherited From:
Returns:

提示信息

Type
string

getValueByText(text) → {string}

Description:

  • 获取显示文本对应的值

Parameters:
Name Type Description
text string

显示文本
Returns:

显示文本对应的值

Type
string

getWidth() → {number}

Description:

  • 获取控件宽度

Inherited From:
Returns:

宽度

Type
number

hide()

Description:

  • 隐藏控件

Inherited From:

isDisabled() → {boolean}

Description:

  • 是否禁用

Inherited From:
Returns:

是否禁用

Type
boolean

isType(value) → {boolean}

Description:

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

Inherited From:
Example
grid1.isType('panel') // 返回true
grid1.isType('grid')  // 返回true
Parameters:
Name Type Description
value Object

控件类型
Returns:

如果当前实例是指定的控件类型，返回true；否则返回false

Type
boolean

isVisible() → {boolean}

Description:

  • 是否可见

Inherited From:
Returns:

是否可见

Type
boolean

loadData(data, value)

Description:

  • 加载数据

Parameters:
Name Type Description
data Array.<Object>

数据
value string | Array.<string>

选中的值

off(eventNames, fn)

Description:

  • 移除事件

Inherited From:
Parameters:
Name Type Description
eventNames string

事件名称（可以空格分割多个事件名称）
fn F_Component_on

之前注册的事件处理函数

on(eventNames, fn)

Description:

  • 注册事件

Inherited From:
Parameters:
Name Type Description
eventNames string

事件名称（可以空格分割多个事件名称）
fn F_Component_on

触发事件时执行的函数

remove()

Description:

  • 删除父控件中移除当前控件

Inherited From:

removeAttr(key)

Description:

  • 删除节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键

removeTooltip()

Description:

  • 删除提示信息

Inherited From:

selectAllItems()

Description:

  • 选中全部列表项

selectItem(itemValue, options)

Description:

  • 选中列表项

Parameters:
Name Type Description
itemValue number | string | jQuery

项索引、项值或者项元素
options Object

参数

Properties
Name Type Default Description
keep boolean false

是否保持已选中项
keepUnselectable boolean true

是否保持不可选择项的选中状态（options.keep=true时，此参数无效）
scrollTo boolean true

是否滚动到选中项（仅有一项处于选中状态时有效）

selectItems(itemValues, options)

Description:

  • 选中多的列表项

Parameters:
Name Type Description
itemValues Array.<number> | Array.<string> | Array.<jQuery>

项索引数组、项值数组或者项元素数组
options Object

参数

Properties
Name Type Default Description
keep boolean false

是否保持已选中项
keepUnselectable boolean true

是否保持不可选择项的选中状态（options.keep=true时，此参数无效）
scrollTo boolean true

是否滚动到选中项（仅有一项处于选中状态时有效）

setAttr(key, value)

Description:

  • 设置节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
value string

节点属性值

setAttrs(attrs)

Description:

  • 设置节点属性

Inherited From:
Parameters:
Name Type Description
attrs Object

节点属性对象

setDisabled(disabled)

Description:

  • 设置控件的禁用状态

Inherited From:
Parameters:
Name Type Description
disabled boolean

是否禁用

setEnabled(enabled)

Description:

  • 设置控件的启用状态

Inherited From:
Parameters:
Name Type Description
enabled boolean

是否启用

setHeight(height)

Description:

  • 设置控件高度

Inherited From:
Parameters:
Name Type Description
height number

高度

setHidden(hidden)

Description:

  • 设置控件的隐藏状态

Inherited From:
Parameters:
Name Type Description
hidden boolean

是否隐藏

setSize(width, height)

Description:

  • 设置控件尺寸

Inherited From:
Parameters:
Name Type Description
width number

宽度
height number

高度

setTooltip(tooltip)

Description:

  • 设置提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息

setVisible(visible)

Description:

  • 设置控件的显示状态

Inherited From:
Parameters:
Name Type Description
visible boolean

是否可见

setWidth(width)

Description:

  • 设置控件宽度

Inherited From:
Parameters:
Name Type Description
width number

宽度

show()

Description:

  • 显示控件

Inherited From:

toggleEnabled()

Description:

  • 切换启用状态

Inherited From:

toggleVisible()

Description:

  • 切换显示状态

Inherited From:

trigger(eventName, args)

Description:

  • 触发事件

Inherited From:
Parameters:
Name Type Description
eventName string

事件名称
args Object

事件参数

Events

beforehide

Description:

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

Inherited From:

beforeitemcontextmenu

Description:

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

Parameters:
Name Type Description
event jQuery.Event

事件对象
itemValue string

列表项的值

beforeshow

Description:

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

Inherited From:

hide

Description:

  • 隐藏控件时触发

Inherited From:

itemclick

Description:

  • 点击列表项时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象
itemValue string

列表项的值

itemdblclick

Description:

  • 双击行时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象
itemValue string

列表项的值

itemdeselect

Description:

  • 取消选中列表项时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象
itemValue string

项值

itemselect

Description:

  • 选中列表项时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象
itemValue string

项值

layout

Description:

  • 布局控件时触发

Inherited From:

render

Description:

  • 渲染控件时触发

Inherited From:

selectionchange

Description:

  • 选中项改变时触发

Parameters:
Name Type Description
event jQuery.Event

事件对象

show

Description:

  • 显示控件时触发

Inherited From: