构建 AutoCompleteEditor 类的新实例。
| 全称 | mx.editors.AutoCompleteEditor |
| 命名空间 | mx.editors |
| 类 | AutoCompleteEditor |
| 继承层次结构 | AutoCompleteEditorComboEditorEditorControl |
| 源文件 | ~\mx\scripts\editors\AutoCompleteEditor.js |
智能查询控件。
示例 1
| JavaScript 代码 |
var auto = new mx.editors.AutoCompleteEditor({
url: "~/country"
}); |
构造函数
| 名称 | 说明 |
| AutoCompleteEditor() | 构建 AutoCompleteEditor 类的新实例。 |
初始化函数
| 名称 | 说明 |
| init() | 初始化方法。执行设置样式并初始化属性等操作。 |
方法
字段
| 名称 | 说明 |
| alias | 获取或设置一个字符串，表示控件的别名。 |
| allowDropDown | 获取一个 Boolean 值，该值表示 ComboEditor 是否显示下拉框按钮。如果该值为 true，表示显示；反之则不显示。 请使用 setAllowDropDown 方法设置该字段的值。 |
| allowEditing | 获取一个 Boolean 值，该值表示 ComboEditor 是否允许用户编辑（编辑功能还受其它属性的限制，参见 DropDownEditor）。 如果该值为 true，表示允许编辑；反之则不允许。请使用 setAllowEditing 方法设置该字段的值。 |
| border | 获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。 |
| bottom | 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。 |
| cache | 设置和获取一个缓存控件 {@link mx.editors.AutoCompleteEditor.Cache}。 |
| cacheLength | 设置和获取一个数值，该值表示缓存控件最大缓存记录数。 |
| cssClass | 指定css伪类名称，设置控件显示样式 |
customValidate |
自定义验证规则。 可通过重写该方法实现自定义验证的效果。 返回的结果为一个 Boolean 值或者一个 JSON 对象。如“true”、“false”或者“{ successful: false, hint: "验证失败！" }”。 如果返回的是 JSON 对象，“successful”表示是否成功，“hint”表示显示值。 |
| data | 设置和获取一个数组对象，该值表示本地数据源。 |
| differDisplayValue | 获取编辑器的显示值是否与实际值相同。例如，当 {@link DropDownList} 控件的 displayMember 字段和 valueMember 字段不同时，该字段为 true；而多数情况下该字段为 false。 该字段通常由具体的编辑器设定，请不要在程序中直接修改。 |
| display | 获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。 |
| displayMember | 设置和获取显示字段。 |
| dropDownAnimation | 获取或设置下拉框显示的动画效果。
该字段的可选值包括:
|
| dropDownMaxHeight | 设置和获取一个数值，该值表示下拉列表的最大高度。 |
| dropDownMinHeight | 设置和获取一个数值，该值表示下拉列表的最小高度。 |
| droppedDown | 获取一个 Boolean 值，该值表示 ComboEditor 的下拉框是否显示。如果该值为 true，表示已显示；反之则隐藏。 |
| enabled | 获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。 请使用 setEnabled 方法设置该字段的值。 |
| enableEventOnInit | 一个布尔值，指示在me.init方法中是否触发changed事件，默认是触发的。 |
| eTag | 获取控件的标签。 |
| formatString | 获取编辑器的日期（如“yyyy-MM-dd”）或数字（如“0.00”）格式化字符串。 请使用 setFormatString 方法设置该字段的值。 |
| height | 获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。 |
| hint | 获取或者设置一个字符串，该属性表示输入框提示值。 |
| isValidate | 获取一个 Boolean 值，表示编辑器是否通过验证。 |
| layoutConfigs | 获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。 |
| left | 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。 |
| matchCase | 设置和获取一个 Boolean 值，该值表示是否开启大小写敏感。 |
| matchContains | 设置和获取一个 Boolean 值，该值表示在字符串比较时是否要在字符串内部匹配。 |
| matchSubset | 设置和获取一个 Boolean 值，该值表示是否使用本地缓存查询结果。 |
| max | 获取编辑器允许的最大值（仅对 Number 类型有效）。 该字段必须在初始化前设置。 |
| maxItems | 设置和获取一个值，该值表示数据集 data 大小的最大值。 |
| min | 获取编辑器允许的最小值（仅对 Number 类型有效）。 该字段必须在初始化前设置。 |
| minChars | 设置和获取一个值，该值表示在触发 autoComplete 前用户至少需要输入的字符数。 |
| mustMatch | 设置和获取一个 Boolean 值，该值表示是否必须匹配。 |
| padding | 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。 |
| params | 设置和获取一个 JSON 对象，该值表示服务请求的自定义参数。 |
| parent | 获取控件所属的父对象。 |
| permissionID | 获取或设置一个字符串，表示控件的权限标识。 |
| position | 获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
|
| postponesDropDown | 获取一个 Boolean 值，该值表示是否在初始化时创建下拉框。如果该值为 true，表示在点击下拉按钮时创建；如果为 false，表示在控件初始化时创建。 |
| readOnly | 获取编辑器是否只读。 请使用 setReadOnly 方法设置该字段的值。 请参考 isReadOnly 和 setReadOnly 方法。 |
| right | 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。 |
| selectFirst | 设置和获取一个 Boolean 值，该值表示是否选中下拉列表的第一个值。 |
| speed | 设置或者获取一个数值或者字符串，该属性表示动画的时间长度。当该属性为数值时，表示毫秒数（例如：1000），当该属性为字符串时，可选参数有"slow" 、"fast" 和 "normal"。 |
| text | 获取编辑器的文本值。 请使用 setText 方法设置该字段的值。 |
| textTransform | 获取编辑器当前字符转换模式。
该字段必须在初始化前设置。
该字段可选的值包括：
|
| tipPosition | 获取或设置一个字符串，表示编辑器未通过校验时，提示信息的位置。
该字段可选的值包括：
|
| top | 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。 |
| url | 设置和获取一个字符串，该值表示服务地址。 服务返回的数据格式为： {successful: true, resultValue: [{ text: "中国", value: "China"}, {text: "美国", value: "America"}]} |
| validateMessage | 获取编辑器验证提示信息。 |
| validOptions | 设置和获取校验参数。该属性与 validType配合使用。常用参数请参见 ValidatorClass.validator 的 p_options。 |
| validType | 获取或设置一个字符串，表示验证类型。
该字段可选的值包括：
|
| value | |
| valueMember | 设置和获取值字段。 |
| valueType | 获取一个字符串，表示 value 的数据类型。
该字段必须在初始化前设置。
该字段可选的值包括：
|
| visible | 获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。 |
| width | |
| $e | 获取该控件的占位符，该占位符为一个 JQuery 对象。 |
事件
| 名称 | 说明 |
| onchanged | 当编辑器的值发生变化后将触发该事件。通常调用 setValue 方法（其中 p_triggerEvent 参数必须为 true），后会触发该事件。 |
| ondeleted | 当删除输入值的时候，将触发该事件。 |
| ondropdown | 当下拉框显示的时候，将触发该事件。通常调用 dropDown 方法时会触发该事件。 |
方法详细信息
appendItems(p_data) 方法
设置本地数据源。
参数
- p_data一个数组。
dropDown(p_speed) 方法
hideDropDown(p_speed) 方法
isReadOnly() 方法
继承自
moveTo(p_left, p_top) 方法
移动控件到指定位置。
参数
- p_left一个数字，表示 css 样式的 left 属性。
- p_top一个数字，表示 css 样式的 top 属性。
继承自
reset([p_triggerEvent]) 方法
resizeTo(p_width, p_height) 方法
重设控件的大小。
参数
- p_width控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
- p_height控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
继承自
search() 方法
根据输入的值请求匹配的数据。
setAllowDropDown(p_allowDropDown) 方法
setAllowEditing(p_allowEditing) 方法
setBorder(p_border) 方法
setBottom(p_bottom) 方法
setCssClass(p_cssClass) 方法
setDisplay(p_display) 方法
setDisplayValue(p_displayValue) 方法
设置显示值。该方法仅修改显示值，不会修改 Editor.value 字段的值，也不会触发 Editor.onchanged 事件。
参数
- p_displayValue一个字符串，表示要设置的显示值。
继承自
setFormatString(p_formatString) 方法
setHeight(p_height) 方法
setPadding(p_padding) 方法
setPosition(p_position) 方法
setTop(p_top) 方法
setValue(p_value) 方法
setValue(p_value, p_displayValue) 方法
setValue(p_value, p_triggerEvent) 方法
设置 Editor.value 字段的值。
参数
- p_value一个字符串，表示实际值。详见 Editor.value 字段。
- p_triggerEvent一个 Boolean 值，表示是否要触发 Editor.onchanged 事件。
继承自
setValue(p_value, p_displayValue, p_triggerEvent) 方法
设置 Editor.value 字段的值。
参数
- p_value一个字符串，表示实际值。详见 Editor.value 字段。
- p_displayValue一个字符串，表示显示值。
- p_triggerEvent一个 Boolean 值，表示是否要触发 Editor.onchanged 事件。
继承自
setVisible(p_visible) 方法
setWidth(p_width) 方法
validate(p_markError) 方法
验证当前editor的值
返回的结果为一个 Boolean 值或者一个 JSON 对象。如“true”、“false”或者“{ successful: false, hint: "验证失败！" }”。
如果返回的是 JSON 对象，“successful”表示是否成功，“hint”表示显示值。
参数
- p_markError一个布尔值，是否标记错误提示。true表示标记，默认为false
继承自
$wrap([p_obj]) 方法
返回一个 JQuery 对象。
参数
- p_obj可选的。默认值为“me.$e”。一个 JQuery 对象，或继承自 Control 的控件，或字符串，或 HTML DOM 元素。如果参数为 JQuery 对象，则返回本身；如果参数为继承自 Control 的控件，则返回控件的 $e 对象；如果参数为字符串，则返回以字符串为选择器的 JQuery 对象；如果参数为空，则返回控件本身的 $e 对象。
继承自
_initDefaultValue(p_triggerEvent) 方法
_initDropDownControl() 方法
_input_blur() 方法
受保护的。
字段详细信息
allowDropDown 字段
获取一个 Boolean 值，该值表示 ComboEditor 是否显示下拉框按钮。如果该值为 true，表示显示；反之则不显示。
请使用 setAllowDropDown 方法设置该字段的值。
继承自
默认值
true
allowEditing 字段
获取一个 Boolean 值，该值表示 ComboEditor 是否允许用户编辑（编辑功能还受其它属性的限制，参见 DropDownEditor）。
如果该值为 true，表示允许编辑；反之则不允许。请使用 setAllowEditing 方法设置该字段的值。
继承自
默认值
true
cache 字段
设置和获取一个缓存控件 {@link mx.editors.AutoCompleteEditor.Cache}。
cacheLength 字段
设置和获取一个数值，该值表示缓存控件最大缓存记录数。
customValidate 字段
自定义验证规则。
可通过重写该方法实现自定义验证的效果。
返回的结果为一个 Boolean 值或者一个 JSON 对象。如“true”、“false”或者“{ successful: false, hint: "验证失败！" }”。
如果返回的是 JSON 对象，“successful”表示是否成功，“hint”表示显示值。
继承自
示例 1
| JavaScript 代码 |
var editor = new mx.editors.TextEditor({
customValidate:function(p_editor){
// TODO: 验证逻辑
// 如果没有验证通过
return { successful:false, hint:"验证失败！" }
}
}); |
data 字段
设置和获取一个数组对象，该值表示本地数据源。
differDisplayValue 字段
获取编辑器的显示值是否与实际值相同。例如，当 {@link DropDownList} 控件的 displayMember 字段和 valueMember 字段不同时，该字段为 true；而多数情况下该字段为 false。
该字段通常由具体的编辑器设定，请不要在程序中直接修改。
继承自
display 字段
获取控件的显示样式值。如“none”，表示隐藏控件；
“block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。
方法设置该字段的值。
继承自
displayMember 字段
设置和获取显示字段。
默认值
text
dropDownAnimation 字段
获取或设置下拉框显示的动画效果。
该字段的可选值包括:
- none - 无动画效果。
- show - 无动画效果。
- slideDown - 以滑动的方式显示。
- fadeIn - 淡入效果。
继承自
默认值
slideDown
dropDownMaxHeight 字段
设置和获取一个数值，该值表示下拉列表的最大高度。
dropDownMinHeight 字段
设置和获取一个数值，该值表示下拉列表的最小高度。
enabled 字段
enableEventOnInit 字段
layoutConfigs 字段
matchCase 字段
设置和获取一个 Boolean 值，该值表示是否开启大小写敏感。
默认值
true
matchContains 字段
设置和获取一个 Boolean 值，该值表示在字符串比较时是否要在字符串内部匹配。
默认值
false
matchSubset 字段
设置和获取一个 Boolean 值，该值表示是否使用本地缓存查询结果。
默认值
true
minChars 字段
设置和获取一个值，该值表示在触发 autoComplete 前用户至少需要输入的字符数。
mustMatch 字段
设置和获取一个 Boolean 值，该值表示是否必须匹配。
默认值
false
padding 字段
获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2
像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
继承自
params 字段
设置和获取一个 JSON 对象，该值表示服务请求的自定义参数。
position 字段
获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
- static
- relative
- absolute
- fixed
继承自
postponesDropDown 字段
获取一个 Boolean 值，该值表示是否在初始化时创建下拉框。如果该值为 true，表示在点击下拉按钮时创建；如果为 false，表示在控件初始化时创建。
继承自
默认值
false
readOnly 字段
继承自
默认值
false
selectFirst 字段
设置和获取一个 Boolean 值，该值表示是否选中下拉列表的第一个值。
默认值
true.
speed 字段
设置或者获取一个数值或者字符串，该属性表示动画的时间长度。当该属性为数值时，表示毫秒数（例如：1000），当该属性为字符串时，可选参数有"slow" 、"fast" 和 "normal"。
继承自
textTransform 字段
获取编辑器当前字符转换模式。
该字段必须在初始化前设置。
该字段可选的值包括：
- uppercase - 表示输入字符转换为大写格式
- lowercase - 表示输入字符转换为小写格式
继承自
tipPosition 字段
获取或设置一个字符串，表示编辑器未通过校验时，提示信息的位置。
该字段可选的值包括：
- left
- right
- top
- bottom
继承自
默认值
bottom
url 字段
设置和获取一个字符串，该值表示服务地址。 服务返回的数据格式为： {successful: true, resultValue: [{ text: "中国", value: "China"}, {text: "美国", value: "America"}]}
validType 字段
获取或设置一个字符串，表示验证类型。
该字段可选的值包括：
- DIGIT 数字
- INTEGER 整数
- FLOAT 浮点数
- MINUSINTEGER 负整数
- MINUSFLOAT 负浮点数
- PLUSINTEGER 正整数
- PLUSFLOAT 正浮点数
- CHINESE 中文
- LETTER 字母
- ASCII ASCII 码
- DATE 日期。例如：2007-07-01
- DATETIME 日期时间。例如：2007-07-01 14:28:32
- TIME 时间。例如：14:28:32
- EMAIL 邮箱地址
- IP IP 地址
- MOBILE 手机号码
- PHONE 电话号码
- URL 统一资源地址
- ZIPCODE 邮政编码
- SQL 是否包含 SQL 关键字
- IDCARD 身份证号码
- REGEXP 正则表达式，支持通过指定正则表达式进行校验。
继承自
valueMember 字段
设置和获取值字段。
默认值
value
valueType 字段
继承自
默认值
string