属性

xworker.lang.MetaDescriptor3/@attribute
事物属性(attribute)

父事物：: MetaDescriptor3

描述者：: 子事物; thing

作用

用于定义一个事物的属性，主要是定义类型、默认值和输入方式等。

比如人有年龄的属性，那么使用该事物可以定义人的年龄属性。

数据仓库

一些输入方式比如下拉列表、下拉多选框等可以使用数据仓库作为数据源，按照优先级数据仓库的一般设置方法是：

在输入扩展属性中设置，通常是输入控件定义的
通过数据仓库属性设置
通过添加数据仓库子节点设置

参看示例。

属性联动

设置修改监听属性，设置为要联动的属性名，可以设置多个，联动的属性必须是数据仓库提供的数据源。设置后自动实现联动。

修改事件

设置修改动作，当属性的编辑框发生变化时可以执行相关动作。

在修改动作里可以实现修改其他属性的值等操作，具体可以参看事物表单。

其他事件

如果想要监听其他事件，那么可以尝试添加SWT编辑设置子节点。

字段摘要
`boolean`	`allowDecimals(允许小数)` False to disallow decimal values (defaults to true)
`boolean`	`allowNegative(允许负数)` False to prevent entering a negative sign (defaults to true)
`string`	`blankText(为空的提示)` The error text to display if the `allowBlank` validation fails (defaults to `'This field is required'`)
`String`	`colspan(跨列)` 属性编辑控件在编辑页面布局时所占的列数。
`String`	`dataStore(数据仓库)` 数据仓库的作用
`String`	`default(默认值)` 属性的默认值，如果属性可以为空，那么不要设置默认值，因为空的值在从存储中读取时认为是默认值。
`String`	`description(描述)` 属性的一段文字描述。在编辑用这个结构描述的事物时，当鼠标移动在事物的属性标签上时会以tol tip的方式显示。
`String`	`extends(继承)` 继承属性，如果有多个继承用,号隔开。
`String`	`group(分组)` 属性在编辑表单里的分组。
`String`	`groupIndex(分组索引)` 决定这个分组的排序先后的索引。
`String`	`inheritDescription(继承描述)` 如果本事物没有编写描述（description），那么使用继承的第一个事物的描述。只对thing.getMetadata().getDescription()方法里获取的描述有效。
`String`	`inputattrs(输入扩展属性)` 属性编辑器可能会需要更多参数，可以在输入扩展属性中指定这些参数。
`String`	`inputtype(输入方式)` 输入方式
`string`	`invalidClass(错误样式)` 当属性校验失败时的样式，可以是样式名称或样式的路径。
`string`	`invalidText(错误提示)` The error text to use when marking a field invalid and no message is provided (defaults to 'The value in this field i...
`String`	`label(标签)` 属性的标签。
`number`	`maxLength(最大长度)` Maximum input field length allowed by validation (defaults to Number.MAX_VALUE). This behavior is intended to provide...
`date/string`	`maxValue(最大值)` The maximum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid ...
`number`	`minLength(最小长度)` Minimum input field length required (defaults to `0`)
`date/string`	`minValue(最小值)` The minimum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid ...
`String`	`modifyAction(修改动作)` 如果不为空，在编辑器里当一个输入控件触发了修改事件，那么会调用该属性指定的本事物的动作。
`String`	`modifyStoreListener(修改监听)` 可以指定一个或者多个其他属性名，当本属性的值发生修改时调用其他属性的DataStore的重新装载事件。
`String`	`name(名称)` 属性的名称。
`String`	`notXmlAttribute` 如果为true表示不是XML的属性或节点，适用于从DTD或Schema导入的结构，再导出XML时用。
`String`	`pattern(模式)` 属性的格式，如yyyy-MM-dd。
`String`	`propertyName(值显示名称)` 默认情况下值名称是何属性名一致的，如果该属性要显示其他字段或者其他字段的组合（使用Ognl表达式），那么可以在此字段里指定。
`String`	`readOnly(是否只读)` 通常是指编辑控件事物可编辑。
`regexp`	`regex(正则表达式)` A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If the test fai...
`String`	`regexText(正则表达式提示)`
`String`	`reserve(保留)` 保留字段。
`String`	`rowspan(跨行)` 属性编辑控件在编辑页面布局中所占的行数。
`String`	`showLabel(显示标签)` 如果设置成false，那么在生成的表单里不显示该标签。
`String`	`size(长度)` 编辑器的长度，不是像素，一个单位相当于一个字符的宽度。
`String`	`subGroup(子分组)`
`String`	`type(类型)` 属性的类型。
`String`	`validateAllowBlank(允许为空)` 是否允许为空。
`boolean`	`validateOnBlur(失去焦点时校验)` Whether the field should validate when it loses focus (defaults to true).
`String`	`validationAction(校验方法)` 执行校验的动作的事物路径。默认是Model实现的校验方法。
`number`	`validationDelay(校验延迟)` The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

方法摘要

子事物摘要
	`DataStore(数据仓库)` 为Select等提供可选数据的数据仓库。
	`SwtObject(SWT编辑设置)` 设置属性的SWT编辑器。
	`actions(动作)` 添加属性的行为。
	`value(可选值)` 当属性的输入方式是下拉选择框、复选框或者输入选择时，可选值提供候选值。

字段详细信息

allowDecimals(允许小数)

False to disallow decimal values (defaults to true)

allowNegative(允许负数)

False to prevent entering a negative sign (defaults to true)

blankText(为空的提示)

The error text to display if the allowBlank validation fails (defaults to 'This field is required')

可以使用Freemarker模板。

colspan(跨列)

属性编辑控件在编辑页面布局时所占的列数。

dataStore(数据仓库)

数据仓库的作用

可以作为下拉列表、多选框等的数据源。

设定方法

值可以是数据仓库的路径。

全局和本地

在此字段设置的数据仓库全部为全局应用，在子节点设置数据仓库为本地。

default(默认值)

属性的默认值，如果属性可以为空，那么不要设置默认值，因为空的值在从存储中读取时认为是默认值。

description(描述)

属性的一段文字描述。在编辑用这个结构描述的事物时，当鼠标移动在事物的属性标签上时会以tol tip的方式显示。

extends(继承)

继承属性，如果有多个继承用,号隔开。

group(分组)

属性在编辑表单里的分组。

groupIndex(分组索引)

决定这个分组的排序先后的索引。

inheritDescription(继承描述)

如果本事物没有编写描述（description），那么使用继承的第一个事物的描述。只对thing.getMetadata().getDescription()方法里获取的描述有效。

inputattrs(输入扩展属性)

属性编辑器可能会需要更多参数，可以在输入扩展属性中指定这些参数。

可以通过点击输入扩展属性输入框后面的*号按钮来打开编辑参数的窗口，编辑参数的窗口根据选择的输入方式弹出相对应的编辑窗口。

inputtype(输入方式)

输入方式

在这里选择属性的编辑方式。

定制输入方式和获取帮助

点击扩展输入属性后的*按钮，会根据选择的输入方法弹出扩充输入属性或帮助等。

如何定义新的输入方式

注册新的输入控件
在xworker.swt.xworker.attributeEditor.EditorConfig中添加新的输入控件。
额外的输入控件属性设置
在xworker.swt.xworker.attributeEditor.OpenWindows添加输入控件的设置窗口。

invalidClass(错误样式)

当属性校验失败时的样式，可以是样式名称或样式的路径。

如果样式找不到，那么使用Model定义的错误样式。由于存在当错误去除时样式要返回原先的样式的问题，但目前没有办法保存原先的样式（有可能原先就没有样式），所以在错误样式中目前只支持背景色、字体、字体颜色、图片、提示语等的恢复。

在不同的编辑器里有不同的解释，以上为XWorker表单的解释方式。

invalidText(错误提示)

The error text to use when marking a field invalid and no message is provided (defaults to 'The value in this field i...

label(标签)

属性的标签。

maxLength(最大长度)

Maximum input field length allowed by validation (defaults to Number.MAX_VALUE). This behavior is intended to provide...

maxValue(最大值)

The maximum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid ...

minLength(最小长度)

Minimum input field length required (defaults to 0)

minValue(最小值)

The minimum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid ...

modifyAction(修改动作)

如果不为空，在编辑器里当一个输入控件触发了修改事件，那么会调用该属性指定的本事物的动作。

其中动作上下文是编辑表单的动作上下文，可以直接如下变量访问：

data
编辑表单的值，通常是map，key是属性名。
model
编辑表单的Model，可以通过它对整个表单取值、赋值和校验等。
<attributeName>+Input
属性控件，有可能是swt的Control，也有可能是Thing或ActionContainer，具体看编辑类型。
<attributeName>+Model
属性模型，可以通过它对某一个属性取值、赋值和校验等。

modifyStoreListener(修改监听)

可以指定一个或者多个其他属性名，当本属性的值发生修改时调用其他属性的DataStore的重新装载事件。

以上可以实现控件的联动，如多个小拉列表之间的联动。

name(名称)

属性的名称。

notXmlAttribute

如果为true表示不是XML的属性或节点，适用于从DTD或Schema导入的结构，再导出XML时用。

见类xworker.xml.XmlUtils。

pattern(模式)

属性的格式，如yyyy-MM-dd。

propertyName(值显示名称)

默认情况下值名称是何属性名一致的，如果该属性要显示其他字段或者其他字段的组合（使用Ognl表达式），那么可以在此字段里指定。

readOnly(是否只读)

通常是指编辑控件事物可编辑。

对有些编辑器，如一个Text框加一个按钮的，点击按钮弹出窗口的，Text可能是只读的，但通过按钮的功能还是可以编辑的。

regex(正则表达式)

A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If the test fai...

regexText(正则表达式提示)

reserve(保留)

保留字段。

rowspan(跨行)

属性编辑控件在编辑页面布局中所占的行数。

showLabel(显示标签)

如果设置成false，那么在生成的表单里不显示该标签。

size(长度)

编辑器的长度，不是像素，一个单位相当于一个字符的宽度。

subGroup(子分组)

type(类型)

属性的类型。

当属性的类型为bytes和object类型时，属性的编辑控件由属性的描述者定义（需提供访问和设置值的数据模型，见swt的Model），当类型为object时只保存序列化的值。

validateAllowBlank(允许为空)

是否允许为空。

validateOnBlur(失去焦点时校验)

Whether the field should validate when it loses focus (defaults to true).

validationAction(校验方法)

执行校验的动作的事物路径。默认是Model实现的校验方法。

validationDelay(校验延迟)

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

方法详细信息

子事物详细信息

xworker.lang.MetaDescriptor3/@attribute 事物 属性(attribute)