HT for web Class: EnumColumn

new EnumColumn()

枚举列，对枚举数据提供渲染和编辑功能

Example

var column = new ht.ui.EnumColumn();
column.setDatas([
     {
         icon: 'node_icon',
         id: 0,
         label: 'Female'
     },
     {
         icon: 'shape_icon',
         id: 1,
         label: 'Male
     }
]);

columnModel.add(column);

Extends

ht.ui.Column

Methods

formatValue(value, data) → {Object}

将要显示的值传入此方法格式化处理并返回，一般用于将数字转换更易读的文本格式

Parameters:

Name	Type	Description
`value`	Object	格式化之前值
`data`	ht.Data	数据元素

Inherited From:

ht.ui.Column#formatValue

Returns:

格式化之后的值

Type: Object

getAccessType() → {String|null}

获取列的属性类型，值列表如下：

null: 默认类型，如 name 为 age，采用g etAge() 和 setAge(98) 的 get/set 或 is/set 方式存取
style: 如 name 为 age，采用 getStyle('age') 和 setStyle('age', 98) 的方式存取
field：如 name 为age，采用 data.age 和 data.age = 98 的方式存取
attr：如 name 为 age，采用 getAttr('age') 和 setAttr('age', 98) 的方式存取

Inherited From:

ht.ui.Column#getAccessType

Returns:

Type: String | null

getAlign() → {String}

获取文字(表头和内容)的水平对齐方式，可用值有 left|right|center，默认为 left

Inherited From:

ht.ui.Column#getAlign

Returns:

Type: String

getDatas() → {Array}

获取枚举数组

Returns:

枚举数据

Type: Array

getDisplayField() → {String}

获取数据对象中用于显示的属性，默认为 label

Returns:

属性名

Type: String

getDropDownConfig() → {Object}

获取下拉模板属性配置表

Returns:

属性配置表

Type: Object

getEditorClass() → {String|function}

获取列的编辑类, 如 'ht.editor.StringEditor'

Inherited From:

ht.ui.Column#getEditorClass

Returns:

编辑器类或类名

Type: String | function

getFixed() → {String}

获取锁定方式

Inherited From:

ht.ui.Column#getFixed

Returns:

Type: String

getIconField() → {String}

获取数据对象中的图标属性名，默认为 icon

Returns:

属性名

Type: String

getPaddingLeft() → {Number}

获取列左侧内边距

Inherited From:

ht.ui.Column#getPaddingLeft

Returns:

左侧内边距

Type: Number

getPaddingRight() → {Number}

获取列右侧内边距

Inherited From:

ht.ui.Column#getPaddingRight

Returns:

右侧内边距

Type: Number

getSortFunc() → {function}

获取排序函数

Inherited From:

ht.ui.Column#getSortFunc

Returns:

排序函数

Type: function

getSortOrder() → {String}

获取排序状态

asc: 升序
desc: 降序

Inherited From:

ht.ui.Column#getSortOrder

Returns:

Type: String

getSummary() → {String}

获取统计方式

Inherited From:

ht.ui.Column#getSummary

Returns:

统计方式

Type: String

getToolTip(data, tableView) → {String}

获取提示文字

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素
`tableView`	ht.ui.TableView	视图对象

Inherited From:

ht.ui.Column#getToolTip

Returns:

Type: String

getValue(data, column, view) → {Object}

自定义要显示的单元格内容

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素
`column`	ht.ui.Column	列
`view`	ht.View	视图组件

Inherited From:

ht.ui.Column#getValue

Returns:

自定义的显示内容

Type: Object

getValueField() → {String}

获取数据对象中的 id 属性名

Returns:

属性名

Type: String

getValueType() → {String}

获取值类型，值类型用于提示组件提供合适的 renderer 渲染

null：默认类型，显示为文本方式
string：字符串类型，显示为文本方式
boolean：布尔类型，显示为勾选框
color：颜色类型，以填充背景色的方式显示
int：整型类型，文本编辑器改变值时自动通过 parseInt 进行转换
number：浮点数类型，文本编辑器改变值时自动通过 parseFloat 转换

Inherited From:

ht.ui.Column#getValueType

Returns:

Type: String

getWidth() → {Number}

获取列宽度, 默认为 80

Inherited From:

ht.ui.Column#getWidth

Returns:

宽度值

Type: Number

isBatchEditable() → {Boolean}

判断该列是否允许多选时批量编辑

Inherited From:

ht.ui.Column#isBatchEditable

Returns:

是否可批量编辑

Type: Boolean

isEditable(data) → {Boolean}

判断此列是否可编辑

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素

Inherited From:

ht.ui.Column#isEditable

Returns:

是否可编辑

Type: Boolean

isReadOnly() → {Boolean}

获取编辑时的下拉框是否是只读的

Returns:

只读

Type: Boolean

isSortable() → {Boolean}

判断当前列是否可排序

Inherited From:

ht.ui.Column#isSortable

Returns:

是否可排序

Type: Boolean

isVisible() → {Boolean}

判断当前列是否是否可见

Inherited From:

ht.ui.Column#isVisible

Returns:

是否可见

Type: Boolean

setAccessType(accessType)

设置列的属性类型，可选值如下：

null: 默认类型，如 name 为 age，采用 getAge() 和 setAge(98) 的 get/set 或 is/set 方式存取
style: 如 name 为 age，采用 getStyle('age') 和 setStyle('age', 98) 的方式存取
field：如 name 为 age，采用 data.age 和 data.age = 98 的方式存取
attr：如 name 为 age，采用 getAttr('age') 和 setAttr('age', 98) 的方式存取

Parameters:

Name	Type	Description
`accessType`	String

Inherited From:

ht.ui.Column#setAccessType

setAlign(align)

设置文字的水平对齐方式，可用值有 left|right|center，默认为 left

Parameters:

Name	Type	Description
`align`	String	对齐方式

Inherited From:

ht.ui.Column#setAlign

setBatchEditable(batchEditable)

设置列是否允许多选时批量编辑

Parameters:

Name	Type	Description
`batchEditable`	Boolean	是否可批量编辑

Inherited From:

ht.ui.Column#setBatchEditable

setDatas(datas)

设置枚举数据

Parameters:

Name	Type	Description
`datas`	Array	枚举数组

setDisplayField(displayField)

设置数据对象中用于显示的属性

Parameters:

Name	Type	Description
`displayField`	String	属性名，默认为 label

setDropDownConfig(config)

设置下拉模板属性配置表

Parameters:

Name	Type	Description
`config`	Object	属性配置表

Example

column.setDropDownConfig({
	'width': 100, // 下拉框宽度
	'height': 100, // 下拉框高度
	'dropDownView.background': 'red' // dropDownView.xxx 用来设置下拉组件的属性
});

setEditable(editable)

设置此列是否可编辑

Parameters:

Name	Type	Description
`editable`	Boolean	是否可编辑

Inherited From:

ht.ui.Column#setEditable

setEditorClass(editorClass)

设置列的编辑类, 如 'ht.editor.StringEditor'

Parameters:

Name	Type	Description
`editorClass`	String \| function	编辑器类或类名

Inherited From:

ht.ui.Column#setEditorClass

setFixed(fixed)

设置锁定方式；锁定列固定显示在表格左侧或右侧，不会跟随横向滚动条滚动

Parameters:

Name	Type	Description
`fixed`	String	'left' 或者 'right'

Inherited From:

ht.ui.Column#setFixed

setIconField(iconField)

设置数据对象中的图标属性名

Parameters:

Name	Type	Description
`iconField`	String	属性名，默认为 icon

setPaddingLeft(paddingLeft)

设置列左侧内边距

Parameters:

Name	Type	Description
`paddingLeft`	Number	左侧内边距

Inherited From:

ht.ui.Column#setPaddingLeft

setPaddingRight(paddingRight)

获取列右侧内边距

Parameters:

Name	Type	Description
`paddingRight`	Number	右侧内边距

Inherited From:

ht.ui.Column#setPaddingRight

setReadOnly(readOnly)

设置编辑时的下拉框是否是只读的

Parameters:

Name	Type	Description
`readOnly`	Boolean	只读

setSortable(sortable)

设置列是否可排序

Parameters:

Name	Type	Description
`sortable`	Boolean	是否允许排序

Inherited From:

ht.ui.Column#setSortable

setSortFunc(func)

设置排序函数

Parameters:

Name	Type	Description
`func`	function	排序函数

Inherited From:

ht.ui.Column#setSortFunc

setSortOrder(sortOrder)

设置排序状态

asc: 升序
desc: 降序

Parameters:

Name	Type	Description
`sortOrder`	String

Inherited From:

ht.ui.Column#setSortOrder

setSummary(summary)

设置统计方式；统计数据显示在 TableFooter 组件中

Parameters:

Name	Type	Description
`summary`	String	统计方式，支持：sum\|min\|max\|average\|first

Inherited From:

ht.ui.Column#setSummary

setValueField(valueField)

设置数据对象中的 id 属性名

Parameters:

Name	Type	Description
`valueField`	String	属性名

setValueType(type)

设置值类型，值类型用于提示组件提供合适的 renderer 渲染

null：默认类型，显示为文本方式
string：字符串类型，显示为文本方式
boolean：布尔类型，显示为勾选框
color：颜色类型，以填充背景色的方式显示
int：整型类型，文本编辑器改变值时自动通过 parseInt 进行转换
number：浮点数类型，文本编辑器改变值时自动通过 parseFloat 转换

Parameters:

Name	Type	Description
`type`	String	值类型

Inherited From:

ht.ui.Column#setValueType

setVisible(visible)

设置列是否是否可见

Parameters:

Name	Type	Description
`visible`	Boolean	是否可见

Inherited From:

ht.ui.Column#setVisible

setWidth(width)

设置列宽度

Parameters:

Name	Type	Description
`width`	Number	宽度值，如果值为负数表示占据表格剩余空间的百分比，如 -0.1，表示当前列的宽度为表格剩余宽度的百分之十

Inherited From:

ht.ui.Column#setWidth