fileUplaoder文档更新

xuzicn · xuzicn · commit ef9420be3e2d · 2015-09-07T20:44:43.000+08:00
diff --git a/fileuploader/avalon.fileuploader.ex.css b/fileuploader/avalon.fileuploader.ex.css
@@ -14,4 +14,8 @@ p.end {
 }
 body {
 	padding: 20px 100px;
+}
+
+p > span {
+    display: block;
 }
diff --git a/fileuploader/avalon.fileuploader.ex5.html b/fileuploader/avalon.fileuploader.ex5.html
@@ -98,7 +98,7 @@ <h1><a name="requestaddparam">文件上传的服务器响应侦听</a></h1>
 				};
 
 				vm.$uploaderOptions4 = $$.mix({
-					onFileRequestResponsed: function (file, textStatus, responseText) {
+					onFileRequestResponsed: function (fileObj, textStatus, responseText) {
 						console.log("收到了服务器的数据：", textStatus, ". ", responseText)
 					}
 				}, basicOptions);
diff --git a/fileuploader/avalon.fileuploader.ex6.html b/fileuploader/avalon.fileuploader.ex6.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="utf-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title>fileObj文件对象说明</title>
+	<script src="../avalon.js"></script>
+	<link rel="stylesheet" href="../style/avalon.doc.css"/>
+	<link rel="stylesheet" href="avalon.fileuploader.ex.css"/>
+</head>
+
+
+
+
+
+<body ms-controller="demo">
+	<h1><a name="requestaddparam">基础属性</a></h1>
+	<p style="text-indent:0;" class='end'>
+		<span>name：文件名</span>
+		<span>size：文件尺寸。按字节计算。</span>
+		<span>data：文件的数据。是一个HTML5的File对象。在IE6-9下为空。</span>
+		<span>modifyTime：最后修改时间。</span>
+		<span>fileLocalToken：在客户端生成的一个唯一的文件ID，不会和其他文件重复。</span>
+		<span>status：文件状态。详见<a href="#status" style="color:blue;">文件状态说明</a>。</span>
+		<span>chunked：是否开启分块。</span>
+		<span>uploadedPercentage：已上传的百分比。0到100，精确到小数点后两位。</span>
+		<span>doneBlobs：已成功上传的分块数量。</span>
+	</p>
+
+	<h1><a name="requestaddparam">文件状态说明</a></h1>
+	<p style="text-indent:0;" class='end'>
+		<span>每个fileObj的status属性都代表的文件的状态。文件对象内本身有状态的枚举的常数值，说明如下：</span>
+		<span>1）fileObj.FILE_INIT： 文件被加入后的原始状态，即文件选中后时的状态代码，这个状态非常短暂，会很快被FILE_CACHED代替。</span>
+		<span>2）fileObj.FILE_CACHED：已被runtime缓存。当你看到文件的缩略的时候已经变成了这个状态。</span>
+		<span>3）fileObj.FILE_QUEUED：已进入发送队列。点击上传的时候，会立即进入发送队列并将状态修改为FILE_QUEUED。</span>
+		<span>4）fileObj.FILE_IN_UPLOADING：文件已经开始上传。排队结束，第一个分块已经开始发送。</span>
+		<span>5）fileObj.FILE_UPLOADED：文件上传结束。</span>
+		<span>6）fileObj.FILE_ERROR_FAIL_READ：FileQueue无法读取文件。读取文件错误。</span>
+		<span>7）fileObj.FILE_ERROR_FAIL_UPLOAD：FileQueue发送文件时碰见错误，包含网络错误等。</span>
+	</p>
+</body>
+</html>
+
diff --git a/fileuploader/avalon.fileuploader.js b/fileuploader/avalon.fileuploader.js
@@ -530,7 +530,7 @@ define(["avalon", "text!./avalon.fileuploader.html", "browser/avalon.browser", "
             onFilePoolOverSize: avalon.noop,
             /*
             * @config {Function} 用于自定义Ajax请求的数据。发送Blob数据时，组件会调用此函数。返回的Object键值对会被加入到Ajax请求中。
-            * @param fileObj {Object} 文件对象
+            * @param fileObj {Object} 文件对象。参见文档内的“文件对象说明”。
             * @param blobObj {Object} 文件分块对象
             */
             madeRequestParams: avalon.noop,
@@ -715,7 +715,7 @@ define(["avalon", "text!./avalon.fileuploader.html", "browser/avalon.browser", "
 
             /*
              * @config 获取文件预览上的文本信息。重写此方法可以自定义文件上传时的文本。当文件被加入、开始上传、进度变更、上传完毕以及发生错误时都会调用此方法。
-             * @param fileObj {Object} 文件对象
+             * @param fileObj {Object} 文件对象。参见文档内的“文件对象说明”。
              */
             getFileMessageText: function (fileObj) {
                 var message = "";
@@ -758,7 +758,7 @@ define(["avalon", "text!./avalon.fileuploader.html", "browser/avalon.browser", "
 
             /*
             * @config {Function} 每个文件上传请求成功后的response侦听函数。开启chunk后这个函数侦听的是每个分块的请求。
-            * @param file {Object} 文件对象
+            * @param fileObj {Object} 文件对象。参见文档内的“文件对象说明”。
             * @param textStatus {string} ajax的textStatus
             * @param responseText {string} 服务器返回的请求响应内容。
             */
@@ -793,4 +793,5 @@ define(["avalon", "text!./avalon.fileuploader.html", "browser/avalon.browser", "
  [预览图和进度条配置](avalon.fileuploader.ex2.html)
  [大文件和分块配置](avalon.fileuploader.ex3.html)
  [文件Ajax请求参数的配置](avalon.fileuploader.ex5.html)
+ [fileObj对象说明](avalon.fileuploader.ex6.html)
 */
diff --git a/fileuploader/file.js b/fileuploader/file.js
@@ -11,7 +11,7 @@
  *    <p>fileLocalToken：在客户端生成的一个唯一的文件ID，不会和其他文件重复。</p>
  *    <p>__flashfile：是否为一个由flash产生的文件。IE6-9等不支持File接口的浏览器下始终为true，其他的浏览器下始终是false。</p>
  *    <p>__html5file：与__flashfile互斥。表示是一个HTML5的文件。</p>
- *    <p>status：与__flashfile互斥。表示是一个HTML5的文件。</p>
+ *    <p>status：文件状态</p>
  *    <p>chunked：是否开启分块。</p>
  *    <p>blobs：分块的数组。里面包含1到多个blob类的实例。</p>
  *    <p>uploadedPercentage：已上传的百分比。0到100，精确到小数点后两位。</p>

Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,8 @@ p.end {`
`14`	`14`	`}`
`15`	`15`	`body {`
`16`	`16`	`padding: 20px 100px;`
	`17`	`+}`
	`18`	`+`
	`19`	`+p > span {`
	`20`	`+ display: block;`
`17`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ <h1><a name="requestaddparam">文件上传的服务器响应侦听</a></h1>`
`98`	`98`	`};`
`99`	`99`
`100`	`100`	`vm.$uploaderOptions4 = $$.mix({`
`101`		`- onFileRequestResponsed: function (file, textStatus, responseText) {`
	`101`	`+ onFileRequestResponsed: function (fileObj, textStatus, responseText) {`
`102`	`102`	`console.log("收到了服务器的数据：", textStatus, ". ", responseText)`
`103`	`103`	`}`
`104`	`104`	`}, basicOptions);`