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
Methods
-
formatValue(data, value) → {any}
-
将要显示的值传入此方法格式化处理并返回,一般用于将数字转换更易读的文本格式
Parameters:
Name Type Description data
ht.Data 数据元素
value
any 格式化之前值
Returns:
any -格式化之后的值
- Inherited From:
-
getAccessType() → {string}
-
获取属性访问类型,值列表如下:
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) 的方式存取Returns:
string- Inherited From:
-
getAlign() → {string}
-
获取文字的水平对齐方式,可用值有 left|right|center
Returns:
string- Inherited From:
-
getCategoryName() → {string}
-
获取分类名
Returns:
string -分类名
- Inherited From:
-
getColor() → {string}
-
获取文字颜色
Returns:
string -颜色值
- Inherited From:
-
getDatas() → {Array.<any>}
-
获取枚举数组
Returns:
Array.<any> -枚举数据
-
getDisplayField() → {string}
-
获取数据对象中用于显示的属性,默认为 label
Returns:
string -属性名
-
getDropDownConfig() → {object}
-
获取下拉模板属性配置表
Returns:
object -属性配置表
-
getEditorClass() → {string|function}
-
获取编辑类, 如 'ht.editor.StringEditor'
Returns:
string | function -编辑器类或类名
- Inherited From:
-
getIconField() → {string}
-
获取数据对象中的图标属性名,默认为 icon
Returns:
string -属性名
-
getPaddingLeft() → {number}
-
获取列左侧内边距
Returns:
number -左侧内边距
- Inherited From:
-
getPaddingRight() → {number}
-
获取列右侧内边距
Returns:
number -右侧内边距
- Inherited From:
-
getToolTip(data, isValue, propertyView) → {string}
-
获取提示文字
Parameters:
Name Type Attributes Description data
ht.Data <optional>
数据元素
isValue
boolean <optional>
是否在属性值区域
propertyView
ht.ui.PropertyView <optional>
视图对象
Returns:
string -文字内容
- Inherited From:
-
getValueField() → {string}
-
获取数据对象中的 id 属性名
Returns:
string -属性名
-
getValueType() → {string}
-
获取值类型,值类型用于提示组件提供合适的 renderer 渲染
null:默认类型,显示为文本方式
string:字符串类型,显示为文本方式
boolean:布尔类型,显示为勾选框
color:颜色类型,以填充背景色的方式显示
int:整型类型,文本编辑器改变值时自动通过 parseInt 进行转换
number:浮点数类型,文本编辑器改变值时自动通过 parseFloat 转换Returns:
string- Inherited From:
-
isEditable() → {boolean}
-
判断是否可编辑
Returns:
boolean -是否可编辑
- Inherited From:
-
isReadOnly() → {boolean}
-
获取编辑时的下拉框是否是只读的
Returns:
boolean -只读
-
setAccessType(accessType) → {void}
-
设置属性类型,可选值如下:
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 Returns:
void- Inherited From:
-
setAlign(align) → {void}
-
设置文字的水平对齐方式,值为:left|right|center;为保持统一的视觉效果,请设置 ht.ui.PropertyView 的 nameAlign 和 valueAlign 属性,尽量避免为每个属性单独设置
Parameters:
Name Type Description align
string 对齐方式
Returns:
void- Inherited From:
-
setCategoryName(name) → {void}
-
设置分类名
Parameters:
Name Type Description name
string 分类名
Returns:
void- Inherited From:
-
setColor(color) → {void}
-
设置文字颜色
Parameters:
Name Type Description color
string 颜色值
Returns:
void- Inherited From:
-
setDatas(datas) → {void}
-
设置枚举数据
Parameters:
Name Type Description datas
Array.<any> 枚举数组
Returns:
void -
setDisplayField(displayField) → {void}
-
设置数据对象中用于显示的属性
Parameters:
Name Type Description displayField
string 属性名,默认为 label
Returns:
void -
setDropDownConfig(config) → {void}
-
设置下拉模板属性配置表
Parameters:
Name Type Description config
object 属性配置表
column.setDropDownConfig({
'width': 100, // 下拉框宽度
'height': 100, // 下拉框高度
'dropDownView.background': 'red' // dropDownView.xxx 用来设置下拉组件的属性
});Returns:
void -
setEditable(editable) → {void}
-
设置是否可编辑
Parameters:
Name Type Description editable
boolean 是否可编辑
Returns:
void- Inherited From:
-
setEditorClass(editorClass) → {void}
-
设置编辑类, 如 'ht.editor.StringEditor'
Parameters:
Name Type Description editorClass
string | function 编辑器类或类名
Returns:
void- Inherited From:
-
setIconField(iconField) → {void}
-
设置数据对象中的图标属性名
Parameters:
Name Type Description iconField
string 属性名,默认为 icon
Returns:
void -
setPaddingLeft(paddingLeft) → {void}
-
设置列左侧内边距;为保持统一的视觉效果,请设置 ht.ui.PropertyView 的 cellPaddingLeft 属性,尽量避免为每个属性单独设置
Parameters:
Name Type Description paddingLeft
number 左侧内边距
Returns:
void- Inherited From:
-
setPaddingRight(paddingRight) → {void}
-
设置列右侧内边距;为保持统一的视觉效果,请设置 ht.ui.PropertyView 的 cellPaddingRight 属性,尽量避免为每个属性单独设置
Parameters:
Name Type Description paddingRight
number 右侧内边距
Returns:
void- Inherited From:
-
setReadOnly(readOnly) → {void}
-
设置编辑时的下拉框是否是只读的
Parameters:
Name Type Description readOnly
boolean 只读
Returns:
void -
setValueField(valueField) → {void}
-
设置数据对象中的 id 属性名
Parameters:
Name Type Description valueField
string 属性名
Returns:
void -
setValueType(type) → {void}
-
设置值类型,值类型用于提示组件提供合适的 renderer 渲染
null:默认类型,显示为文本方式
string:字符串类型,显示为文本方式
boolean:布尔类型,显示为勾选框
color:颜色类型,以填充背景色的方式显示
int:整型类型,文本编辑器改变值时自动通过 parseInt 进行转换
number:浮点数类型,文本编辑器改变值时自动通过 parseFloat 转换Parameters:
Name Type Description type
string 值类型
Returns:
void- Inherited From: