Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / swfupload.queue.html
diff --git a/docs/source/swfupload.queue.html b/docs/source/swfupload.queue.html
new file mode 100644 (file)
index 0000000..82e4684
--- /dev/null
@@ -0,0 +1,107 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js">/*\r
+       Queue Plug-in\r
+       \r
+       Features:\r
+               *Adds a cancelQueue() method for cancelling the entire queue.\r
+               *All queued files are uploaded when startUpload() is called.\r
+               *If false is returned from uploadComplete then the queue upload is stopped.\r
+                If false is not returned (strict comparison) then the queue upload is continued.\r
+               *Adds a QueueComplete event that is fired when all the queued files have finished uploading.\r
+                Set the event handler with the queue_complete_handler setting.\r
+               \r
+       */\r
+\r
+var SWFUpload;\r
+if (typeof(SWFUpload) === "function") {\r
+       SWFUpload.queue = {};\r
+       \r
+       SWFUpload.prototype.initSettings = (function (oldInitSettings) {\r
+               return function () {\r
+                       if (typeof(oldInitSettings) === "function") {\r
+                               oldInitSettings.call(this);\r
+                       }\r
+                       \r
+                       this.queueSettings = {};\r
+                       \r
+                       this.queueSettings.queue_cancelled_flag = false;\r
+                       this.queueSettings.queue_upload_count = 0;\r
+                       \r
+                       this.queueSettings.user_upload_complete_handler = this.settings.upload_complete_handler;\r
+                       this.queueSettings.user_upload_start_handler = this.settings.upload_start_handler;\r
+                       this.settings.upload_complete_handler = SWFUpload.queue.uploadCompleteHandler;\r
+                       this.settings.upload_start_handler = SWFUpload.queue.uploadStartHandler;\r
+                       \r
+                       this.settings.queue_complete_handler = this.settings.queue_complete_handler || null;\r
+               };\r
+       })(SWFUpload.prototype.initSettings);\r
+\r
+       SWFUpload.prototype.startUpload = function (fileID) {\r
+               this.queueSettings.queue_cancelled_flag = false;\r
+               this.callFlash("StartUpload", [fileID]);\r
+       };\r
+\r
+       SWFUpload.prototype.cancelQueue = function () {\r
+               this.queueSettings.queue_cancelled_flag = true;\r
+               this.stopUpload();\r
+               \r
+               var stats = this.getStats();\r
+               while (stats.files_queued > 0) {\r
+                       this.cancelUpload();\r
+                       stats = this.getStats();\r
+               }\r
+       };\r
+       \r
+       SWFUpload.queue.uploadStartHandler = function (file) {\r
+               var returnValue;\r
+               if (typeof(this.queueSettings.user_upload_start_handler) === "function") {\r
+                       returnValue = this.queueSettings.user_upload_start_handler.call(this, file);\r
+               }\r
+               \r
+               // To prevent upload a real "FALSE" value must be returned, otherwise default to a real "TRUE" value.\r
+               returnValue = (returnValue === false) ? false : true;\r
+               \r
+               this.queueSettings.queue_cancelled_flag = !returnValue;\r
+\r
+               return returnValue;\r
+       };\r
+       \r
+       SWFUpload.queue.uploadCompleteHandler = function (file) {\r
+               var user_upload_complete_handler = this.queueSettings.user_upload_complete_handler;\r
+               var continueUpload;\r
+               \r
+               if (file.filestatus === SWFUpload.FILE_STATUS.COMPLETE) {\r
+                       this.queueSettings.queue_upload_count++;\r
+               }\r
+\r
+               if (typeof(user_upload_complete_handler) === "function") {\r
+                       continueUpload = (user_upload_complete_handler.call(this, file) === false) ? false : true;\r
+               } else if (file.filestatus === SWFUpload.FILE_STATUS.QUEUED) {\r
+                       // If the file was stopped and re-queued don't restart the upload\r
+                       continueUpload = false;\r
+               } else {\r
+                       continueUpload = true;\r
+               }\r
+               \r
+               if (continueUpload) {\r
+                       var stats = this.getStats();\r
+                       if (stats.files_queued > 0 && this.queueSettings.queue_cancelled_flag === false) {\r
+                               this.startUpload();\r
+                       } else if (this.queueSettings.queue_cancelled_flag === false) {\r
+                               this.queueEvent("queue_complete_handler", [this.queueSettings.queue_upload_count]);\r
+                               this.queueSettings.queue_upload_count = 0;\r
+                       } else {\r
+                               this.queueSettings.queue_cancelled_flag = false;\r
+                               this.queueSettings.queue_upload_count = 0;\r
+                       }\r
+               }\r
+       };\r
+}</pre>    \r
+</body>\r
+</html>
\ No newline at end of file