构建 FileEditor 类的新实例。
| 全称 | mx.editors.FileEditor |
| 命名空间 | mx.editors |
| 类 | FileEditor |
| 继承层次结构 | FileEditorCustomEditorEditorControl |
| 源文件 | ~\mx\scripts\editors\FileEditor.js |
提供一个显示上传文件信息的类。
示例 1
以下是一个附件编辑器如何初始化的示例。
| JavaScript 代码 |
var annex = new mx.editors.FileEditor(
{
filePath: "D:\\testUpload\\inner\\",
windowHeight: "400",
width: "100%",
baseUrl: mx.mappath("~/fileUpload")
}); |
示例 2
以下是一个在表单中使用附件编辑器的示例
| JavaScript 代码 |
var dataForm = new mx.datacontrols.DataForm( {
fields: [ {
name: "deptId",
caption: "DEPT_ID",
editorType: "TextEditor",
visible: false
}, {
name: "deptName",
caption: "DEPT_NAME",
editorType: "FileEditor",//类型为文件编辑器
type: "form",//类型声明为 form
uploadMode: "file",//保存方式为file，文件会保存到服务器指定磁盘路径；为blob会保存到数据库的BLOB类型字段中。
tableName: "DEPT",//数据对应的表名，必须是数据库中的物理表名
primaryKey: "DEPT_ID",//数据表的主键字段名
colName: "DEPT_NAME"//当前字段在数据库中的物理名称
} ],
entityContainer: me.formEntityContainer
}); |
构造函数
| 名称 | 说明 |
| FileEditor() | 构建 FileEditor 类的新实例。 |
初始化函数
| 名称 | 说明 |
| init() | 初始化方法。执行设置样式并初始化属性等操作。 |
方法
字段
| 名称 | 说明 |
| alias | 获取或设置一个字符串，表示控件的别名。 |
| allowTypes | 设置或获取一个字符串，表示允许上传的文件类型，多个扩展名用逗号隔开。值为 null 时表示允许上传所有文件。 |
| autoWrap | 设置或获取一个 Boolean 值，表示编辑器文本是否自动换行。请使用 setAutoWrap 方法设置该字段的值。 |
| baseUrl | 获取或设置一个字符串，表示后台服务所在路径。MX 框架提供两个服务路径可供选择。 mx.mappath("~/../mx/servlets/fileUpload") 是管理指定目录下的文件时的默认服务路径； mx.mappath("~/../mx/servlets/dataFileUpload") 是管理表单、表格对应的数据附件时默认服务路径。 用户可以根据需要使用自己的服务路径。 |
| border | 获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。 |
| bottom | 获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。 |
| buttonCaption | 获取按钮标题，当 useSymbol 字段值为 true 时，标题会被转换成为相应的字符图标。请参见 SymbolUtilClass。 |
| colName | 设置或获取一个字符串，表示上传控件在存储表单数据的表中对应的列名。 当控件类型为 form 时，此属性有值。 |
| 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控件中使用。 方法设置该字段的值。 |
| enabled | 获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。 请使用 setEnabled 方法设置该字段的值。 |
| enabledInput | 设置是否禁用输入框,此属性为false时只会禁用输入框，而对按钮没有影响。 它对input的作用，优先级要高于enabled属性。 |
| enableEventOnInit | 一个布尔值，指示在me.init方法中是否触发changed事件，默认是触发的。 |
| eTag | 获取控件的标签。 |
| filePath | 设置或获取一个字符串，表示上传文件在服务器上的保存路径。 |
| filesLimit | 设置或获取一个数字，表示允许上传的文件个数。为 0 时表示没有限制。 |
| formatString | 获取编辑器的日期（如“yyyy-MM-dd”）或数字（如“0.00”）格式化字符串。 请使用 setFormatString 方法设置该字段的值。 |
| height | 获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。 |
| isAdvance | 设置或获取一个 Boolean 值，表示是否使用基于 HTML5 的批量上传控件。值为 true 表示使用；为 false 表示不使用； 值为 null 时，FileEditor 会根据浏览器判断，如果浏览器支持 HTML5 则使用。 该字段必须在初始化前设置。 |
| isValidate | 获取一个 Boolean 值，表示编辑器是否通过验证。 |
| isVirtual | 指示列是否虚拟，如果列是虚拟的话，将不会执行业务表的逻辑 |
| layoutConfigs | 获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。 |
| left | 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。 |
| limitTypes | 设置或获取一个字符串，表示禁止上传的文件类型，多个扩展名用逗号隔开。 |
| max | 获取编辑器允许的最大值（仅对 Number 类型有效）。 该字段必须在初始化前设置。 |
| maxSize | 获取或设置一个数字，表示上传文件的大小所允许的最大值，单位 “KB”。如果为“-1”表示无限制。 |
| min | 获取编辑器允许的最小值（仅对 Number 类型有效）。 该字段必须在初始化前设置。 |
| padding | 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。 |
| parent | 获取控件所属的父对象。 |
| permissionID | 获取或设置一个字符串，表示控件的权限标识。 |
| pkVal | 设置或获取一个字符串，表示上传控件所属数据的主键值。 当控件类型为 form 时，此属性有意义；若此时此属性没有值，控件不会响应点击事件。 |
| position | 获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
|
| primaryKey | 设置或获取一个字符串，表示上传控件所属数据表的主键列名。 当控件类型为 form 时，此属性有值。 |
| readOnly | 获取编辑器是否只读。 请使用 setReadOnly 方法设置该字段的值。 请参考 isReadOnly 和 setReadOnly 方法。 |
| right | 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。 |
| tableName | 设置或获取一个字符串，表示上传控件所属数据的表名。 当控件类型为 form 时，此属性有值。 |
| text | 获取编辑器的文本值。 请使用 setText 方法设置该字段的值。 |
| tipPosition | 获取或设置一个字符串，表示编辑器未通过校验时，提示信息的位置。
该字段可选的值包括：
|
| top | 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。 |
| type | 设置或获取一个字符串，表示当前文件编辑器的类型。 当类型为 path 时，表示管理指定目录下的文件； 当类型为 form 或 grid
时，表示管理表单、表格对应的数据的附件。
该字段可选的值包括：
|
| uploadControl | 获取一个上传控件对象。表示当前文件编辑器使用的上传控件。如果使用 HTML5 批量上传时为 UploadControl 类型的对象； 否则为 DragDataUploadControl。请参考 FileEditor.isAdvance 字段。 |
| uploadMode | 设置或获取一个字符串，表示保存文件的方式。 当控件类型为 form 时，此属性有意义。
该字段可选的值包括：
|
| useSymbol | 获取或设置一个 Boolean 值，表示显示字符图标还是普通文本。请参见 SymbolUtilClass。 |
| validateMessage | 获取编辑器验证提示信息。 |
| validOptions | 设置和获取校验参数。该属性与 validType配合使用。常用参数请参见 ValidatorClass.validator 的 p_options。 |
| validType |
获取或设置一个字符串，表示验证类型。
该字段可选的值包括：
|
| value | 获取编辑器的值。 请使用 setValue 方法设置该字段的值。 |
| valueFormatter | 提供提交值和显示值之间的转换功能，该方法需要覆写实现。 返回值是需要显示的文本。 |
| valueType | 获取一个字符串，表示 value 的数据类型。
该字段必须在初始化前设置。
该字段可选的值包括：
|
| visible | 获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。 |
| width | 获取控件宽度，请参见 Control.width 字段。 |
| windowHeight | 设置或获取一个字符串或者数字，表示弹出窗口的高度。 |
| $e | 获取该控件的占位符，该占位符为一个 JQuery 对象。 |
事件
| 名称 | 说明 |
| onallitemuploaded | 所有附件上传完毕后触发该事件 |
| onchanged | 当编辑器的值发生变化后将触发该事件。通常调用 setValue 方法（其中 p_triggerEvent 参数必须为 true），后会触发该事件。 |
| onclick | 当点击按钮并且 Editor.isReadOnly 方法返回 false 时触发该事件。 |
| onitemuploaded | 上传项上传之后触发该事件。 |
| onitemuploading |
上传项上传之前触发该事件。 |
| onselectionchanged | 当选择的文件改变时触发该事件。 |
方法详细信息
contains($p_target) 方法
返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
参数
- $p_target一个 JQuery 对象，或 JQuery 选择器对应的字符串（如“#container”），或 HTML DOM 元素。
继承自
isReadOnly() 方法
继承自
moveTo(p_left, p_top) 方法
移动控件到指定位置。
参数
- p_left一个数字，表示 css 样式的 left 属性。
- p_top一个数字，表示 css 样式的 top 属性。
继承自
refreshPk(p_items, p_pkColName) 方法
提供一个方法供数据组件调用，用于重置子数据的主键，一般在新增数据保存完成后执行。
参数
- p_items一个数组，包含保存结果的数据。
- p_pkColName一个字符串，表示保存结果中主键属性名。
reset([p_triggerEvent]) 方法
resetInput(p_input) 方法
resizeTo(p_width, p_height) 方法
重设控件的大小。
参数
- p_width控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
- p_height控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
继承自
setBorder(p_border) 方法
setBottom(p_bottom) 方法
setCssClass(p_cssClass) 方法
setDisplay(p_display) 方法
setEnabledInput(p_enabled) 方法
setFormatString(p_formatString) 方法
setHeight(p_height) 方法
setPadding(p_padding) 方法
setPk(p_pkVal) 方法
提供一个方法，设置当前编辑器所属的表单数据的主键值。 当控件类型为 form 时，此方法有意义。
参数
- p_pkVal一个数字或字符串，表示当前数据的主键值。
setPosition(p_position) 方法
setTop(p_top) 方法
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) 方法
字段详细信息
allowTypes 字段
设置或获取一个字符串，表示允许上传的文件类型，多个扩展名用逗号隔开。值为 null 时表示允许上传所有文件。
baseUrl 字段
获取或设置一个字符串，表示后台服务所在路径。MX 框架提供两个服务路径可供选择。
mx.mappath("~/../mx/servlets/fileUpload") 是管理指定目录下的文件时的默认服务路径；
mx.mappath("~/../mx/servlets/dataFileUpload") 是管理表单、表格对应的数据附件时默认服务路径。
用户可以根据需要使用自己的服务路径。
colName 字段
设置或获取一个字符串，表示上传控件在存储表单数据的表中对应的列名。 当控件类型为 form 时，此属性有值。
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控件中使用。
方法设置该字段的值。
继承自
enabled 字段
enabledInput 字段
设置是否禁用输入框,此属性为false时只会禁用输入框，而对按钮没有影响。
它对input的作用，优先级要高于enabled属性。
继承自
默认值
true
enableEventOnInit 字段
filePath 字段
设置或获取一个字符串，表示上传文件在服务器上的保存路径。
filesLimit 字段
设置或获取一个数字，表示允许上传的文件个数。为 0 时表示没有限制。
isAdvance 字段
设置或获取一个 Boolean 值，表示是否使用基于 HTML5 的批量上传控件。值为 true 表示使用；为 false 表示不使用；
值为 null 时，FileEditor 会根据浏览器判断，如果浏览器支持 HTML5 则使用。
该字段必须在初始化前设置。
isVirtual 字段
指示列是否虚拟，如果列是虚拟的话，将不会执行业务表的逻辑
默认值
false
layoutConfigs 字段
limitTypes 字段
设置或获取一个字符串，表示禁止上传的文件类型，多个扩展名用逗号隔开。
maxSize 字段
获取或设置一个数字，表示上传文件的大小所允许的最大值，单位 “KB”。如果为“-1”表示无限制。
padding 字段
获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2
像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
继承自
pkVal 字段
设置或获取一个字符串，表示上传控件所属数据的主键值。 当控件类型为 form 时，此属性有意义；若此时此属性没有值，控件不会响应点击事件。
position 字段
获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition
方法设置该字段的值。
该字段的可选值包括:
- static
- relative
- absolute
- fixed
继承自
primaryKey 字段
设置或获取一个字符串，表示上传控件所属数据表的主键列名。 当控件类型为 form 时，此属性有值。
readOnly 字段
继承自
默认值
false
tableName 字段
设置或获取一个字符串，表示上传控件所属数据的表名。 当控件类型为 form 时，此属性有值。
tipPosition 字段
获取或设置一个字符串，表示编辑器未通过校验时，提示信息的位置。
该字段可选的值包括：
- left
- right
- top
- bottom
继承自
默认值
bottom
type 字段
设置或获取一个字符串，表示当前文件编辑器的类型。 当类型为 path 时，表示管理指定目录下的文件； 当类型为 form 或 grid
时，表示管理表单、表格对应的数据的附件。
该字段可选的值包括：
- path
- form
- grid
uploadControl 字段
获取一个上传控件对象。表示当前文件编辑器使用的上传控件。如果使用 HTML5 批量上传时为 UploadControl 类型的对象；
否则为 DragDataUploadControl。请参考 FileEditor.isAdvance 字段。
uploadMode 字段
设置或获取一个字符串，表示保存文件的方式。 当控件类型为 form 时，此属性有意义。
该字段可选的值包括：
- file表示文件以磁盘文件方式存储
- blob表示文件以blob 类型存储在系统表的附件表中
- uds表示文件存在非结构化系统中
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 正则表达式，支持通过指定正则表达式进行校验。
继承自
示例 1
| JavaScript 代码 |
var editor = new mx.editors.TextEditor({
validType: "INTEGER" //验证输入值是整数
validOptions: {minValue: 12, maxValue: 20, validateMessage: "请输入正整数"}
}); |
valueFormatter 字段
valueType 字段
继承自
默认值
string
windowHeight 字段
设置或获取一个字符串或者数字，表示弹出窗口的高度。
默认值
350
事件详细信息
onallitemuploaded 事件
所有附件上传完毕后触发该事件
onitemuploaded 事件
上传项上传之后触发该事件。
onitemuploading 事件
上传项上传之前触发该事件。
参数
- cancel可通过设置 cancel 参数为 true 来取消当前操作。默认为 false。
- item上传项对象，其 setUdsParam 方法参加 DragUploadItem.setUdsParam 方法。
示例 1
非结构化上传自定义参数示例
| JavaScript 代码 |
var fe = new mx.editors.FileEditor({
baseUrl :mx.mappath("~/../mx/servlets/dataFileUpload"),
filePath: "D:/uploadfile/newpath/",
tableName: "T_GOODS",
primaryKey: "id",
pkVal: "402894263e440be8013e44497529000c",
colName: "IMG",
type:"form",
uploadMode: "uds",
// 非结构化自定义参数可以通过以下方式上传
onitemuploading: function (args){
var udsp = {comp:"公司1", des:"公司描述"};
args.item.setUdsParam(udsp);
}
}); |
onselectionchanged 事件
当选择的文件改变时触发该事件。
参数
- item一个对象，表示当前选中的上传项。 参见 DragDataUploadControl.onselectionchanged 事件和UploadControl.onselectionchanged 事件