HT for web Class: EnumProperty

new EnumProperty()

枚举类型的属性元素，对枚举数据提供渲染和编辑功能

Example

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

propertyModel.add(property);

Extends

ht.ui.Property

Methods

formatValue(data, value) → {Object}

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

Parameters:

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

Inherited From:

ht.ui.Property#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.Property#getAccessType

Returns:

Type: String | null

getAlign() → {String}

获取文字的水平对齐方式，可用值有 left|right|center

Inherited From:

ht.ui.Property#getAlign

Returns:

Type: String

getCategoryName() → {String}

获取分类名

Inherited From:

ht.ui.Property#getCategoryName

Returns:

分类名

Type: String

getColor() → {color}

获取文字颜色

Inherited From:

ht.ui.Property#getColor

Returns:

颜色值

Type: color

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.Property#getEditorClass

Returns:

编辑器类或类名

Type: String | function

getIconField() → {String}

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

Returns:

属性名

Type: String

getPaddingLeft() → {Number}

获取列左侧内边距

Inherited From:

ht.ui.Property#getPaddingLeft

Returns:

左侧内边距

Type: Number

getPaddingRight() → {Number}

获取列右侧内边距

Inherited From:

ht.ui.Property#getPaddingRight

Returns:

右侧内边距

Type: Number

getToolTip(data, isValue, propertyView) → {String}

获取提示文字

Parameters:

Name	Type	Description
`data`	ht.Data	数据元素
`isValue`	Boolean	是否在属性值区域
`propertyView`	ht.ui.PropertyView	视图对象

Inherited From:

ht.ui.Property#getToolTip

Returns:

文字内容

Type: String

getValueField() → {String}

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

Returns:

属性名

Type: String

getValueType() → {String}

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

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

Inherited From:

ht.ui.Property#getValueType

Returns:

Type: String

isEditable() → {Boolean}

判断是否可编辑

Inherited From:

ht.ui.Property#isEditable

Returns:

是否可编辑

Type: Boolean

isReadOnly() → {Boolean}

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

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.Property#setAccessType

setAlign(align)

设置文字的水平对齐方式，值为：left|right|center；为保持统一的视觉效果，请设置 ht.ui.PropertyView 的 nameAlign 和 valueAlign 属性，尽量避免为每个属性单独设置

Parameters:

Name	Type	Description
`align`	String	对齐方式

Inherited From:

ht.ui.Property#setAlign

setCategoryName(name)

设置分类名

Parameters:

Name	Type	Description
`name`	String	分类名

Inherited From:

ht.ui.Property#setCategoryName

setColor(color)

设置文字颜色

Parameters:

Name	Type	Description
`color`	color	颜色值

Inherited From:

ht.ui.Property#setColor

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.Property#setEditable

setEditorClass(editorClass)

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

Parameters:

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

Inherited From:

ht.ui.Property#setEditorClass

setIconField(iconField)

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

Parameters:

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

setPaddingLeft(paddingLeft)

设置列左侧内边距；为保持统一的视觉效果，请设置 ht.ui.PropertyView 的 cellPaddingLeft 属性，尽量避免为每个属性单独设置

Parameters:

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

Inherited From:

ht.ui.Property#setPaddingLeft

setPaddingRight(paddingRight)

设置列右侧内边距；为保持统一的视觉效果，请设置 ht.ui.PropertyView 的 cellPaddingRight 属性，尽量避免为每个属性单独设置

Parameters:

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

Inherited From:

ht.ui.Property#setPaddingRight

setReadOnly(readOnly)

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

Parameters:

Name	Type	Description
`readOnly`	Boolean	只读

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.Property#setValueType