SWFUpload v2.5说明文档

SWFUploadv2.5.0DocumentationSWFUpload2.5.0版官方说明文档中文翻译版TableofContents内容列表详情请点击翻译：yukon123452010.6.101.SWFUpload2.SWFUpload版本23.概览（Overview）4.入门（GettingStarted）5.js对象（SWFUploadJavaScriptObject）1.构造器（Constructor）2.全局变量和常量（GlobalsandConstants）1.【新增内容】instances2.movieCount3.【新增内容】QUEUE_ERROR4.【新增内容】UPLOAD_ERROR5.【新增内容】FILE_STATUS6.【新增】UPLOAD_TYPE7.【新增内容】BUTTON_ACTION8.【新增内容】CURSOR9.【新增内容】BUTTON_WINDOW_MODE10.【新增】RESIZE_ENCODING11.【新增】onload3.属性Properties1.【新增内容】customSettings2.movieName4.方法Methods1.addSetting不推荐（deprecated)2.getSetting不推荐（deprecated)3.retrieveSetting已移除（removedinv2.1.0)4.destroy添加自2.1.0（addedinv2.1.0)5.displayDebugInfo6.selectFile7.selectFiles8.startUpload9.【新增】startResizedUpload(addedinv2.5.0)10.cancelUpload11.stopUpload12.【新增】requeueUpload13.getStats14.setStats15.getFile16.【新增】getQueueFile(addedinv2.5.0)17.addPostParam18.removePostParam19.addFileParam20.removeFileParam21.setUploadURL22.setPostParams23.setFileTypes24.setFileSizeLimit25.setFileUploadLimit26.setFileQueueLimit27.setFilePostName28.setUseQueryString29.setDebugEnabled30.setButtonImageURL(addedinv2.2.0)31.setButtonDimensions(addedinv2.2.0)32.setButtonText(addedinv2.2.0)33.setButtonTextStyle(addedinv2.2.0)34.setButtonTextPadding(addedinv2.2.0)35.setButtonDisabled(addedinv2.2.0)36.setButtonAction(addedinv2.2.0)37.setButtonCursor(addedinv2.2.0)5.【新增内容】事件Events1.flashReady2.【新增】swfUploadPreload3.【新增】swfUploadLoadFailed4.【新增】swfUploadLoaded5.【新增】buttonAction6.fileDialogStart7.fileQueued8.【新增内容】fileQueueError9.fileDialogComplete10.【新增】uploadResizeStart11.uploadStart12.uploadProgress13.uploadError14.【新增】uploadSuccess15.uploadComplete16.debug6.实用功能对象SWFUploadUtilityObjects1.SettingsObject2.SettingsDescription3.【新】SupportObject4.FileObject5.StatsObject6.相关插件SWFUploadPlug-ins7.【新增内容】已知问题KnownIssuesSWFUploadSWFUpload最初是Vinterwebb.se开发的客户端文件上传工具。它联合javascript和flash，在浏览器中提供一个优于传统上传标签inputtype=file/的功能（和良好的用户体验）。SWFUpload的主要特性:文件浏览对话框中可以选择多个文件AJAX风格的上传，不用重刷新上传过程中的各种事件.可以在客户端调节图片大小它使用的类命名空间兼容各种js库(i.e.,jQuery,Prototype,等.).支持Flash9andFlash10(2.2.0版本后取消对flash8的支持)SWFUpload的设计理念与其他基于flash的上传工具不同。SWFUpload给开发者尽可能多的UI控制能力.开发者可以使用XHTML,CSS,JavaScript来使它更符合自己网站的样式风格.它提供一组简单的js事件更新上传状态，开发者可以根据这些事件来在网页中显示文件上传进度不过不幸的是FlashPlayer10迫使我们不得不用一个按钮（点击后）才能触发文件选择对话框，但SWFUpload允许开发者用js来修改这个按钮的文字等外观。SWFUploadv2SWFUploadv2包含了许多新的特性，增强的稳定性，解决了FlashPlayer中的一些bug，提供了一些有用的插件（Plug-ins）.新特性包括:可利用FlashPlayer10安全特性.可以随上传来POST额外的数据针对每一个文件上传发送POST数据完善的各种事件组.所有设置，参数，都可以灵活配置.可获取服务器回传的数据.可暂停正在上传的文件，而不是取消.任意修改上传的次序.可提供单一或多文件的选择对话框.可限制上传文件队列长度，文件大小，上传文件个数可更好地处理0字节文件.每个文件都有上传确认事件.OverviewHTMLUpload标准的HTML上传框只提供一个按钮和一个文本框让用户选择单个文件。然后通过表单提交。整个文件必须等到它上传完毕后才能确认并检查文件大小，文件扩展名，而且上传的过程中，回传反馈很少。这就造成了一些使用上的不便利。但传统的HTML上传十分简单，单一步骤，所有浏览器都支持它。SWFUploadSWFUpload使用Flash影片（flashmovie）来选择和上传文件。影片里有一个可定制的按钮来激活文件选择对话框。文件选择对话框允许用户选择单一的文件或者多个文件。选择的的文件类型也是可以被限制的，开发人员可以限定用户只能选择指定的适当的文件，例如*.jgp;*.gif。一旦选择并点击确定，每个文件都会被验证，并放入队列。当Flash上传文件的时候，由开发人员预定义的Javascript事件会被触发以便来更新页面中的UI显示，并且还能实时提供上传状态和错误信息。文件的上传是独立于页面和表单的。每个文件单独的上传到处理页面，这就使服务器可以简单轻松地处理文件。flash提供的上传服务使得整个页面不必提交或者刷新。这有点像AJAX程序。页面中的Form表单数据会和FLASH控制的文件上传单独处理。入门GettingStartedSWFUpload不是拖放式的上传控件。因此需要一些dom和js的知识。几个demo将会展示swfUpload的能力以及如何使用它们完成任务。SWFUpload包含4部分:1.初始化和设置(JavaScript)2.JavaScript库:SWFUpload.js3.Flash控件:swfupload.swf和swfupload_fp9.swf4.事件处理机制(JavaScript)许多使用SWFUpload的问题都出在设置上。错误的事件处理，Flash/浏览器的Bug,或者服务器配置。初始化和设置InitializationandSettingsSWFUpload必须在页面上初始化.它通常在js的window.onload事件里完成.SWFUpload的构造函数需要获取一个Object类型的对象（js）.这个对象的数据直接的传递给构造函数.初始化的SWFUpload对象的引用（reference）应该保存好，（yukon:即用变量存储起来.如例子中的swfu）因为在启动文件上传以及控制其他特性的时候也需要这个引用。例子:初始化SWFUpload时直接传入一个匿名对象来配置参数varswfu;window.onload=function(){swfu=newSWFUpload({upload_url:处理上传文件的地址flash_url:核心功能swf的地址flash9_url::20MB//文件大小限制});};例子:也可以在初始化SWFUpload时使用一个对象变量（settings_object）传入配置参数varswfu;window.onload=function(){varsettings_object={upload_url::::20MB};swfu=newSWFUpload(settings_object);};js库JavaScriptlibrary如果想使用swfupload，js库文件(swfupload.js)必须被引入到使用的页面中.一旦SWFUpload对象被创建，就可以访问许多功能函数。开发者可以以此来控制SWFUpload。例:如何引入swfupload.js库scripttype=text/javascriptsrc=例:按需初始化SWFUpload.varswfu=newSWFUpload({upload_url::::spanSWFUploadButton//yukon：这里有个新参数，将会使用js在id为“spanSWFUploadButton”的标签容器如span，div中创建一个“选择”按钮});【新增内容】flash控件FlashControlSWFUploadjs库能动态的加载Flash控件(swfupload.swf或swfupload_fp9.swf).Flash控件的文件地址在初始化的时候就必须在SWFUpload设置对象中定义。Flash控件实际上是个Flash小影片，它可以控制文件的选择，验证和上传。它在页面中展现给用户的是一个UI可自定制的按钮，并且能检测FlashPlayer的版本（9，10）自动加载适合用户播放器版本的flash控件使用flash_url和flash9_url可以设置swfupload.swf或者swfupload_fp9.swf的路径。（yukon：前面几个例子