new Property()
属性元素,用于定义属性表组件中的属性
Extends
- ht.Data
Methods
-
formatValue(data, value) → {Object}
-
将要显示的值传入此方法格式化处理并返回,一般用于将数字转换更易读的文本格式
Parameters:
Name Type Description data
ht.Data 数据元素
value
Object 格式化之前值
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) 的方式存取
Returns:
- Type
- String | null
-
getAlign() → {String}
-
获取文字的水平对齐方式,可用值有 left|right|center
Returns:
- Type
- String
-
getCategoryName() → {String}
-
获取分类名
Returns:
分类名
- Type
- String
-
getColor() → {color}
-
获取文字颜色
Returns:
颜色值
- Type
- color
-
getEditorClass() → {String|function}
-
获取编辑类, 如 'ht.editor.StringEditor'
Returns:
编辑器类或类名
- Type
- String | function
-
getPaddingLeft() → {Number}
-
获取列左侧内边距
Returns:
左侧内边距
- Type
- Number
-
getPaddingRight() → {Number}
-
获取列右侧内边距
Returns:
右侧内边距
- Type
- Number
-
getToolTip(data, isValue, propertyView) → {String}
-
获取提示文字
Parameters:
Name Type Description data
ht.Data 数据元素
isValue
Boolean 是否在属性值区域
propertyView
ht.ui.PropertyView 视图对象
Returns:
文字内容
- Type
- String
-
getValueType() → {String}
-
获取值类型,值类型用于提示组件提供合适的 renderer 渲染
- null:默认类型,显示为文本方式
- string:字符串类型,显示为文本方式
- boolean:布尔类型,显示为勾选框
- color:颜色类型,以填充背景色的方式显示
- int:整型类型,文本编辑器改变值时自动通过 parseInt 进行转换
- number:浮点数类型,文本编辑器改变值时自动通过 parseFloat 转换
Returns:
- Type
- String
-
isEditable() → {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 -
setAlign(align)
-
设置文字的水平对齐方式,值为:left|right|center;为保持统一的视觉效果,请设置 ht.ui.PropertyView 的 nameAlign 和 valueAlign 属性,尽量避免为每个属性单独设置
Parameters:
Name Type Description align
String 对齐方式
-
setCategoryName(name)
-
设置分类名
Parameters:
Name Type Description name
String 分类名
-
setColor(color)
-
设置文字颜色
Parameters:
Name Type Description color
color 颜色值
-
setEditable(editable)
-
设置是否可编辑
Parameters:
Name Type Description editable
Boolean 是否可编辑
-
setEditorClass(editorClass)
-
设置编辑类, 如 'ht.editor.StringEditor'
Parameters:
Name Type Description editorClass
String | function 编辑器类或类名
-
setPaddingLeft(paddingLeft)
-
设置列左侧内边距;为保持统一的视觉效果,请设置 ht.ui.PropertyView 的 cellPaddingLeft 属性,尽量避免为每个属性单独设置
Parameters:
Name Type Description paddingLeft
Number 左侧内边距
-
setPaddingRight(paddingRight)
-
设置列右侧内边距;为保持统一的视觉效果,请设置 ht.ui.PropertyView 的 cellPaddingRight 属性,尽量避免为每个属性单独设置
Parameters:
Name Type Description paddingRight
Number 右侧内边距
-
setValueType(type)
-
设置值类型,值类型用于提示组件提供合适的 renderer 渲染
- null:默认类型,显示为文本方式
- string:字符串类型,显示为文本方式
- boolean:布尔类型,显示为勾选框
- color:颜色类型,以填充背景色的方式显示
- int:整型类型,文本编辑器改变值时自动通过 parseInt 进行转换
- number:浮点数类型,文本编辑器改变值时自动通过 parseFloat 转换
Parameters:
Name Type Description type
String 值类型