构建 DropDownEditor 类的新实例。
| 全称 | mx.editors.DropDownEditor |
| 命名空间 | mx.editors |
| 类 | DropDownEditor |
| 继承层次结构 | DropDownEditorComboEditorEditorControl |
| 源文件 | ~\mx\scripts\editors\DropDownEditor.js |
提供一个允许用户从下拉列表中选择数据项的控件的类。该控件支持可编辑和不可编辑两种模式，当 DropDownEditor.displayMember 和 DropDownEditor.valueMember 相同并且
ComboEditor.allowEditing 为 true 时，控件支持编辑；当 DropDownEditor.displayMember 和 DropDownEditor.valueMember 不同时，控件不支持编辑（ComboEditor.allowEditing 属性失效）。
示例 1
以下是一个创建 DropDownEditor 以及如何添加项的示例。
| JavaScript 代码 |
var dropDownEditor = new mx.editors.DropDownEditor(
{
allowEditing: false, // 设置是否允许编辑
displayCheckBox: true,
valueSeparator: "#",
displayMember: "name",
valueMember: "value",
items: [
{ name: "苹果", value: "Apple" },
{ name: "汽车", value: "Car" },
{ name: "学生", value: "Student" }
],
onchanged: _dropDownEditor_changed
});
dropDownEditor.appendItem("书", "Book");
dropDownEditor.appendItems([
{ name: "老师", value: "Teacher" },
{ name: "牛奶", value: "Milk" }
]);
function _dropDownEditor_changed()
{
alert("value 值发生改变，目前为 " + dropDownEditor.value);
} |
示例 2
以下是如何使用 DropDownEditor 的示例。
| JavaScript 代码 |
dropDownEditor.setDisplayValue("苹果"); // 将显示值设为“苹果”。
dropDownEditor.setValue("StudentA", "学生A"); // 将显示值设为“学生A”，实际值设为“StudentA”。由于列表项中没有“StudentA”项，所有不选中任何项，也不触发 onchanged 事件。
dropDownEditor.setValue("Student", true); // 将实际值设为“Student”，选中“Student”项，并显示对应的显示值“学生”，同时触发 onchanged 事件。
dropDownEditor.setValue("Student", "学生A", true); // 将实际值设为“Student”，选中“Student”项，并将显示值设为“学生A”，同时触发 onchanged 事件。 |
构造函数
| 名称 | 说明 |
| DropDownEditor() | 构建 DropDownEditor 类的新实例。 |
初始化函数
| 名称 | 说明 |
| init() | 初始化方法。执行设置样式并初始化属性等操作。 |
方法
字段
| 名称 | 说明 |
| alias | 获取或设置一个字符串，表示控件的别名。 |
| allowDropDown | 获取一个 Boolean 值，该值表示 ComboEditor 是否显示下拉框按钮。如果该值为 true，表示显示；反之则不显示。 请使用 setAllowDropDown 方法设置该字段的值。 |
| allowEditing | 获取一个 Boolean 值，该值表示 ComboEditor 是否允许用户编辑（编辑功能还受其它属性的限制，参见 DropDownEditor）。 如果该值为 true，表示允许编辑；反之则不允许。请使用 setAllowEditing 方法设置该字段的值。 |
| border | 获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。 |
| bottom | 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。 |
| cssClass | 指定css伪类名称，设置控件显示样式 |
customValidate |
自定义验证规则。 可通过重写该方法实现自定义验证的效果。 返回的结果为一个 Boolean 值或者一个 JSON 对象。如“true”、“false”或者“{ successful: false, hint: "验证失败！" }”。 如果返回的是 JSON 对象，“successful”表示是否成功，“hint”表示显示值。 |
| differDisplayValue | 获取编辑器的显示值是否与实际值相同。例如，当 {@link DropDownList} 控件的 displayMember 字段和 valueMember 字段不同时，该字段为 true；而多数情况下该字段为 false。 该字段通常由具体的编辑器设定，请不要在程序中直接修改。 |
| display | 获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。 |
| displayCheckBox | 获取或设置一个值，该值表示列表中的每一项之前是否显示一个选择框。如果该值为 true，则表示显示；反之则不显示。该字段必须在初始化前设置。 |
| displayMember | 获取或设置一个字符串，该字符串对应的属性的值将用作 DropDownEditor 中的项的显示值。 |
| displayNullValue | 获取或设置一个值，表示是否显示空值。 |
| 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 | 获取或者设置一个字符串，该属性表示输入框提示值。 |
| isLoaded | 一个 Boolean 值，表示是否已经根据 url 地址获取完数据。该属性在 url 属性不为空时有效。 |
| isValidate | 获取一个 Boolean 值，表示编辑器是否通过验证。 |
| items | 获取一个集合，包含下拉列表中所有的项（ListItem 类型）。请使用 setItems 方法设置该字段的值。 |
| layoutConfigs | 获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。 |
| left | 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。 |
| listEditor | 获取一个 {@link mx.editors.listEditor} 对象，表示下拉的列表控件。 |
| max | 获取编辑器允许的最大值（仅对 Number 类型有效）。 该字段必须在初始化前设置。 |
| min | 获取编辑器允许的最小值（仅对 Number 类型有效）。 该字段必须在初始化前设置。 |
| padding | 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。 |
| parent | 获取控件所属的父对象。 |
| permissionID | 获取或设置一个字符串，表示控件的权限标识。 |
| position | 获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
|
| postponesDropDown | 获取一个 Boolean 值，该值表示是否在初始化时创建下拉框。如果该值为 true，表示在点击下拉按钮时创建；如果为 false，表示在控件初始化时创建。 |
| readOnly | 获取编辑器是否只读。 请使用 setReadOnly 方法设置该字段的值。 请参考 isReadOnly 和 setReadOnly 方法。 |
| right | 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。 |
| speed | 设置或者获取一个数值或者字符串，该属性表示动画的时间长度。当该属性为数值时，表示毫秒数（例如：1000），当该属性为字符串时，可选参数有"slow" 、"fast" 和 "normal"。 |
| text | 获取编辑器的文本值。 请使用 setText 方法设置该字段的值。 |
| textTransform | 获取编辑器当前字符转换模式。
该字段必须在初始化前设置。
该字段可选的值包括：
|
| tipPosition | 获取或设置一个字符串，表示编辑器未通过校验时，提示信息的位置。
该字段可选的值包括：
|
| top | 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。 |
| url | 一个字符串，表示 REST 服务的地址。如果该属性不为空，会根据这个地址获取下拉框数据然后绘制下拉框。如果为空，则以 items 集合的数据来绘制下拉框。 |
| validateMessage | 获取编辑器验证提示信息。 |
| validOptions | 设置和获取校验参数。该属性与 validType配合使用。常用参数请参见 ValidatorClass.validator 的 p_options。 |
| validType | 获取或设置一个字符串，表示验证类型。
该字段可选的值包括：
|
| value | 获取编辑器的值。 请使用 setValue 方法设置该字段的值。 |
| valueMember | 获取或设置一个字符串，该字符串对应的属性的值将用作 DropDownEditor 中的项的实际值。 |
| valueSeparator | 请参见 ListEditor.valueSeparator。 |
| valueType | 获取一个字符串，表示 value 的数据类型。
该字段必须在初始化前设置。
该字段可选的值包括：
|
| visible | 获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。 |
| width | |
| $e | 获取该控件的占位符，该占位符为一个 JQuery 对象。 |
事件
| 名称 | 说明 |
| onchanged | 当编辑器的值发生变化后将触发该事件。通常调用 setValue 方法（其中 p_triggerEvent 参数必须为 true），后会触发该事件。 |
| ondeleted | 当删除输入值的时候，将触发该事件。 |
| ondropdown | 当下拉框显示的时候，将触发该事件。通常调用 dropDown 方法时会触发该事件。 |
方法详细信息
appendItem(p_item) 方法
向 DropDownEditor 的项列表（items 集合）添加项，并返回添加的项。
参数
- p_item一个 JSON 对象（如 { text: "书", value: "book" }）或 ListItem 对象，表示要添加到列表中的项。
示例 1
可参见 ListEditor.appendItem 方法的示例。
appendItem(p_text, p_value) 方法
向 DropDownEditor 的项列表（items 集合）添加项，并返回添加的项。
参数
- p_text一个字符串，表示添加的 ListItem 对象的显示值（ListItem.text 字段的值）。
- p_value一个字符串，表示添加的 ListItem 对象的实际值（ListItem.value 字段的值）。
示例 1
可参见 ListEditor.appendItem 方法的示例。
appendItems(p_items) 方法
向 DropDownEditor 的项列表（items 集合）添加一组项。
参数
- p_items一个数组，该数组包含了一组 ListItem 对象。
示例 1
可参见 ListEditor.appendItems 方法的示例。
dropDown(p_speed) 方法
hideDropDown(p_speed) 方法
isReadOnly() 方法
继承自
moveTo(p_left, p_top) 方法
移动控件到指定位置。
参数
- p_left一个数字，表示 css 样式的 left 属性。
- p_top一个数字，表示 css 样式的 top 属性。
继承自
removeItem(p_item) 方法
从 items 集合中移除指定的 ListItem 对象，若该对象是控件当前的选中项，则触发 onselectionchanged 事件。从列表中移除项时，有关移除的项的所有信息均会被删除。若要从列表中移除所有项，请使用 clearItems 方法。
参数
- p_item
reset([p_triggerEvent]) 方法
resizeTo(p_width, p_height) 方法
重设控件的大小。
参数
- p_width控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
- p_height控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
继承自
setAllowDropDown(p_allowDropDown) 方法
setAllowEditing(p_allowEditing) 方法
setBorder(p_border) 方法
setBottom(p_bottom) 方法
setCssClass(p_cssClass) 方法
setDisplay(p_display) 方法
setDisplayMember(p_displayMember) 方法
setDisplayValue(p_displayValue) 方法
设置显示值。该方法仅修改显示值，不会修改 Editor.value 字段的值，也不会触发 Editor.onchanged 事件。
参数
- p_displayValue一个字符串，表示要设置的显示值。
继承自
setFormatString(p_formatString) 方法
setHeight(p_height) 方法
setPadding(p_padding) 方法
setPosition(p_position) 方法
setText(p_text, p_triggerEvent) 方法
setTop(p_top) 方法
setValue(p_value, p_displayValue, p_triggerEvent) 方法
setValueMember(p_valueMember) 方法
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() 方法
字段详细信息
allowDropDown 字段
获取一个 Boolean 值，该值表示 ComboEditor 是否显示下拉框按钮。如果该值为 true，表示显示；反之则不显示。
请使用 setAllowDropDown 方法设置该字段的值。
继承自
默认值
true
allowEditing 字段
获取一个 Boolean 值，该值表示 ComboEditor 是否允许用户编辑（编辑功能还受其它属性的限制，参见 DropDownEditor）。
如果该值为 true，表示允许编辑；反之则不允许。请使用 setAllowEditing 方法设置该字段的值。
继承自
默认值
false
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:"验证失败！" }
}
}); |
differDisplayValue 字段
获取编辑器的显示值是否与实际值相同。例如，当 {@link DropDownList} 控件的 displayMember 字段和 valueMember 字段不同时，该字段为 true；而多数情况下该字段为 false。
该字段通常由具体的编辑器设定，请不要在程序中直接修改。
继承自
display 字段
获取控件的显示样式值。如“none”，表示隐藏控件；
“block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。
方法设置该字段的值。
继承自
displayCheckBox 字段
获取或设置一个值，该值表示列表中的每一项之前是否显示一个选择框。如果该值为 true，则表示显示；反之则不显示。该字段必须在初始化前设置。
默认值
false
displayNullValue 字段
获取或设置一个值，表示是否显示空值。
dropDownAnimation 字段
获取或设置下拉框显示的动画效果。
该字段的可选值包括:
- none - 无动画效果。
- show - 无动画效果。
- slideDown - 以滑动的方式显示。
- fadeIn - 淡入效果。
继承自
默认值
slideDown
dropDownMaxHeight 字段
获取一个数字，表示下拉框的最大高度。
默认值
200
dropDownMinHeight 字段
获取一个数字，表示下拉框的最小高度。
默认值
24
enabled 字段
enableEventOnInit 字段
items 字段
layoutConfigs 字段
listEditor 字段
获取一个 {@link mx.editors.listEditor} 对象，表示下拉的列表控件。
padding 字段
获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2
像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
继承自
position 字段
获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
- static
- relative
- absolute
- fixed
继承自
postponesDropDown 字段
获取一个 Boolean 值，该值表示是否在初始化时创建下拉框。如果该值为 true，表示在点击下拉按钮时创建；如果为 false，表示在控件初始化时创建。
继承自
默认值
false
readOnly 字段
继承自
默认值
false
speed 字段
设置或者获取一个数值或者字符串，该属性表示动画的时间长度。当该属性为数值时，表示毫秒数（例如：1000），当该属性为字符串时，可选参数有"slow" 、"fast" 和 "normal"。
继承自
textTransform 字段
获取编辑器当前字符转换模式。
该字段必须在初始化前设置。
该字段可选的值包括：
- uppercase - 表示输入字符转换为大写格式
- lowercase - 表示输入字符转换为小写格式
继承自
tipPosition 字段
获取或设置一个字符串，表示编辑器未通过校验时，提示信息的位置。
该字段可选的值包括：
- left
- right
- top
- bottom
继承自
默认值
bottom
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 正则表达式，支持通过指定正则表达式进行校验。
继承自
valueType 字段
继承自
默认值
string