SWFUpload v2.2.0.1 中文帮助手册

SWFUploadv2.2.0.1中文帮助手册TOC1.关于SWFUpload2.SWFUploadVersion23.概述4.快速指南5.SWFUploadJavaScript对象1.构造函数2.全局变量和常量1.instances2.movieCount3.QUEUE_ERROR4.UPLOAD_ERROR5.FILE_STATUS6.BUTTON_ACTION7.CURSOR8.BUTTON_WINDOW_MODE3.属性1.customSettings2.movieName4.方法1.addSetting(不建议使用)2.getSetting(不建议使用)3.retrieveSetting(在v2.1.0版本中被移除)4.destroy(在v2.1.0版本中添加)5.displayDebugInfo6.selectFile7.selectFiles8.startUpload9.cancelUpload10.stopUpload11.getStats12.setStats13.getFile14.addPostParam15.removePostParam16.addFileParam17.removeFileParam18.setUploadURL19.setPostParams20.setFileTypes21.setFileSizeLimit22.setFileUploadLimit23.setFileQueueLimit24.setFilePostName25.setUseQueryString26.setDebugEnabled27.setButtonImageURL(在v2.2.0版本中添加)28.setButtonDimensions(在v2.2.0版本中添加)29.setButtonText(在v2.2.0版本中添加)30.setButtonTextStyle(在v2.2.0版本中添加)31.setButtonTextPadding(在v2.2.0版本中添加)32.setButtonDisabled(在v2.2.0版本中添加)33.setButtonAction(在v2.2.0版本中添加)34.setButtonCursor(在v2.2.0版本中添加)5.事件1.flashReady2.swfUploadLoaded3.fileDialogStart4.fileQueued5.fileQueueError6.fileDialogComplete7.uploadStart8.uploadProgress9.uploadError10.uploadSuccess11.uploadComplete12.debug6.SWFUpload实用对象1.SettingsObject（设置对象）2.设置说明3.FileObject（文件对象）4.StatsObject（统计对象）6.SWFUpload插件7.兼容性和bug关于SWFUploadSWFUpload是一个由Vinterwebb.se原创开发的客户端文件上传工具。它采用Flash和JavaScript结合的方式来提供文件上传功能，而浏览器仅仅只需提供inputtype=file/标签。SWFUpload的主要功能如下：允许一次上传多个文件。采用AJAX方式上传，页面无须刷新。上传过程中的事件控制。类使用了名称空间，稳定兼容其他JavaScript库(例如jQuery,Prototype等。)。支持Flash9和Flash10。(2.2.0不再支持Flash8)由于设计理念上见解和宗旨的差异，SWFUpload和其它基于Flash的上传工具不一样。SWFUpload将UI的表现交给浏览器，以给开发者尽可能多的发挥余地。开发者可以使用XHTML,CSS和JavaScript来装饰上传UI以满足他们站点的需要。上传状态的更新是通过一系列简单的JavaScript事件完成的。开发者可以在文件上传过程中使用这些事件来更新页面。遗憾的是，FlashPlayer10强制我们在一个flash电影中必须设置一个按钮来触发文件浏览窗口。SWFUpload通过JavaScript仍然向开发者提供按钮和文本覆盖的功能。SWFUploadv2SWFUpload拥有更先进的功能，更高的稳定性，FlashPlayer错误解决方案以及一系列非常有用的插件。新功能如下：安全兼容FlashPlayer10。在上传时发送POST值。按文件发送POST值。完整的事件集合。所有设置可动态更新。从服务器获取数据。不需要取消操作就可以停止上传。可以任意顺序上传文件。可以选择单个或多个文件。可以对上传队列中的文件总数、已上传文件的大小和允许上传的文件大小做限制。正确处理0字节文件。上传之前可以通过事件进行校验。对Flash和浏览器进行bug兼容。概述HTML上传标准的HTML上传提供一个输入框和一个供用户选择单个文件的按钮。文件使用表单提交，整个文件必须在下一个页面显示之前上传完成，在上传之前不能对文件进行校验(如文件大小限制和是否有效的扩展名等)。上传时提供给用户的反馈信息非常少。标准HTML上传的使用方式简单、直接并且支持几乎所有的浏览器。SWFUploadSWFUpload使用一个Flash电影来处理文件选择和上传。Flash电影提供一个自定义按钮，该按钮可以激活Flash的高级文件选择窗口。该文件选择窗口允许用户选择单个或多个文件，文件类型可以被限制，如此一来，用户就只能选择被允许的文件(如*.jpg;*.gif)。一旦被选择，每个文件就已经通过校验并且进入上传队列。当文件被Flash上传时，由开发者控制，用来更新页面UI的若干个JavaScript事件就会被触发，这些事件允许你提供上传的实时状态和错误消息。上传完成的文件将脱离当前页面和表单并且被提交。每个文件都是单独被上传的，以此来使服务端处理上传的脚本不需要太复杂。由于Flash提供上传功能，因此页面无须被提交或重载。SWFUpload的使用方式更像一个AJAX应用而非标准的HTML表单，页面中的表单处理是和文件上传分开的。快速指南SWFUpload不是一个可拖放的上传工具。使用它，需要掌握JavaScript和DOM的相关知识。一些demo展示了SWFUpload可以做到的事情以及它是如何完成普通任务的。SWFUpload由以下4个方面组成：1.初始化和设置(JavaScript)2.JavaScript库:SWFUpload.js3.Flash控制:swfupload.swf4.事件处理(JavaScript)在部署SWFUpload时，大多数问题都是由错误设置、糟糕的事件处理、Flash/浏览器bug或者服务器配置引起的。初始化和设置SWFUpload必须在页面中初始化，这通常在window.onload事件中完成。SWFUpload构造函数使用一个设置对象作为参数，设置对象可以对象原型的形式被直接传递给构造函数。必须使用一个对初始化的SWFUpload对象的引用，因为我们需要它来开始上传和控制SWFUpload。Example:使用一个对象原型来初始化SWFUploadvarswfu;window.onload=function(){swfu=newSWFUpload({upload_url:::20MB});};Example:使用一个存储在变量中的设置对象来初始化SWFUploadvarswfu;window.onload=function(){varsettings_object={upload_url:::20MB};swfu=newSWFUpload(settings_object);};JavaScript库JavaScript库文件(swfupload.js)必须被包含在用户上传页面中。一旦SWFUpload对象被创建，开发者就可以访问一些函数来控制SWFUpload。Example:添加SWFUpload.js到一个页面scripttype=text/javascriptsrc=:使用定义的设置初始化SWFUpload。varswfu=newSWFUpload({upload_url:::spanSWFUploadButton});Flash控制器SWFUploadJavaScript库动态地载入Flash控制器(swfupload.swf)。Flash控制文件的路径必须在初始化时通过SWFUpload设置对象给出。Flash控制器是一个Flash小电影，它被用来处理文件浏览、校验和上传。它作为一个按钮呈现在页面中，并且与JavaScript相联系将上传状态和其他事件通知给浏览器。事件处理器开发者必须创建一系列的JavaScript函数来处理SWFUpload事件，当不同的事件发生时这些函数将被调用。通过处理SWFUpload事件，开发者可以根据上传过程、错误信息和上传完成提供反馈信息。开发者不应该重写存储在SWFUpload.prototype中的函数，而是应该创建你自己的一系列函数并且在设置对象中向它们传递参数。Example:SWFUpload事件处理器和初始化。//上传开始事件处理器，这个函数作为一个变量值在设置对象中被赋予upload_start_handlervarmyCustomUploadStartEventHandler=function(file){varcontinue_with_upload;if(file.name===theskyisblue){continue_with_upload=true;}else{continue_with_upload=false;}returncontinue_with_upload;};//上传成功事件处理器，这个函数作为一个变量值在设置对象中被赋予upload_success_handlervarmyCustomUploadSuccessEventHandler=function(file,server_data,receivedResponse){alert(Thefile+file.name+hasbeendeliveredtotheserver.Theserverrespondedwith+server_data);};//创建SWFUploadObjectvarswfu=newSWFUpload({upload_url:::200MB,upload_start_handler:myCustomUploadStartEventHandler,upload_success_handler:myCustomUploadSuccessEventHandler});SWFUploadJavaScript对象构造函数SWFUpload(settingsobject)返回值:一个SWFUpload实例va