SwfUploadV2.2.0中文说明文档

### SwfUpload V2.2.0 中文说明文档概览 #### 1. SwfUpload简介 SwfUpload是一款由Vinterwebb.se开发的客户端文件上传工具，结合了Flash与JavaScript的功能，旨在为用户提供一种更为先进的文件上传体验，超越传统浏览器中`<input type="file">`标签所能提供的功能。 **主要特点：** - **文件多选：** 用户可以在文件选择对话框中一次选择多个文件。 - **页面无刷新上传：** 在上传过程中无需刷新整个页面。 - **上传进度事件：** 支持上传进度的事件回调，能够实时显示上传进度。 - **优秀的浏览器兼容性：** 能够在多种浏览器环境中稳定运行。 - **命名空间支持：** 为了兼容其他JavaScript库（如jQuery, Prototype等），SwfUpload采用了命名空间设计。 - **Flash播放器支持：** 兼容Flash 8、Flash 9及Flash 10播放器，但V2.2.0版本已经放弃了对Flash 8的支持。 #### 2. SwfUpload设计思想 与其他基于Flash的上传工具不同，SwfUpload允许开发者完全控制浏览器中的用户界面(UI)。这意味着开发者可以使用XHTML、CSS以及JavaScript来自定义符合其网站风格的上传元素。SwfUpload提供了一组简单易用的JavaScript事件，通过这些事件，开发者可以实时更新页面上的上传进度和其他UI元素。 由于Flash Player 10引入了更严格的安全限制，SwfUpload V2.2.0被迫在Flash影片中嵌入了一个Flash Button。尽管如此，SwfUpload依然提供了丰富的API，使得开发者可以通过图片、文本或CSS自定义按钮样式，从而实现更加灵活的UI设计。 #### 3. SwfUpload JavaScript对象详解 ##### 3.1 构造器 - **SWFUpload构造器：** 用于创建SwfUpload实例，初始化时可传递配置参数。 ##### 3.2 全局变量和常量 - **instances：** 存储所有SwfUpload实例的数组。 - **movieCount：** 当前已加载的Flash影片数量。 - **QUEUE_ERROR：** 文件队列错误代码枚举。 - **UPLOAD_ERROR：** 上传错误代码枚举。 - **FILE_STATUS：** 文件状态枚举。 - **DefaultEventHandlers：** 默认事件处理器集合。 - **BUTTON_ACTION：** 按钮动作类型。 - **BUTTON_CURSOR：** 按钮光标类型。 - **BUTTON_WINDOW_MODE：** Flash影片窗口模式。 ##### 3.3 属性 - **customSettings：** 自定义设置对象，用于存储开发者指定的任何额外配置信息。 - **movieName：** Flash影片的名称，用于标识SwfUpload实例。 ##### 3.4 方法 - **addSetting：** 添加设置项（不推荐）。 - **getSetting：** 获取设置项值（不推荐）。 - **retrieveSetting：** 已在v2.1.0中移除。 - **destroy：** 销毁SwfUpload实例，释放资源。 - **displayDebugInfo：** 显示调试信息。 - **selectFile/Files：** 选择文件（不推荐）。 - **startUpload：** 开始上传文件。 - **cancelUpload：** 取消当前正在上传的文件。 - **stopUpload：** 停止所有正在进行的上传操作。 - **getStats：** 获取上传统计信息。 - **setStats：** 设置上传统计信息。 - **getFile：** 获取文件对象。 - **addPostParam/removePostParam：** 添加/移除POST参数。 - **addFileParam/removeFileParam：** 添加/移除文件参数。 - **setUploadURL：** 设置上传服务器URL。 - **setPostParams：** 设置POST参数集合。 - **setFileTypes：** 设置允许上传的文件类型。 - **setFileSizeLimit：** 设置文件大小上限。 - **setFileUploadLimit：** 设置同时上传的最大文件数。 - **setFileQueueLimit：** 设置文件队列的最大容量。 - **setFilePostName：** 设置POST请求中文件字段的名称。 - **setUseQueryString：** 控制是否使用查询字符串传递参数。 - **setDebugEnabled：** 启用或禁用调试模式。 - **setButtonImageURL/setButtonDimensions/setButtonText/setButtonTextStyle/setButtonTextPadding/setButtonDisabled/setButtonAction/setButtonCursor：** 这些方法允许开发者自定义按钮的各种属性，包括图像、尺寸、文本、样式等。 ##### 3.5 事件 SwfUpload提供了丰富的事件系统，用于通知开发者文件上传过程中的各种状态变化： - **flashReady：** Flash影片准备就绪。 - **swfUploadLoaded：** SwfUpload加载完成。 - **fileDialogStart：** 文件选择对话框打开。 - **fileQueued/fileQueueError：** 文件添加到队列/队列出错。 - **fileDialogComplete：** 文件选择对话框关闭。 - **uploadStart/uploadProgress/uploadError/uploadSuccess/uploadComplete：** 上传开始/进度/错误/成功/完成。 - **debug：** 发送调试信息。 #### 4. 功能对象 除了上述提到的方法和事件之外，SwfUpload还提供了一些功能对象，帮助开发者更好地管理和控制上传过程： - **SettingsObject：** 存储SwfUpload的设置信息。 - **SettingsDescription：** 描述SwfUpload的设置信息。 - **FileObject：** 表示单个文件的信息。 - **StatsObject：** 保存上传统计信息的对象。 #### 5. 插件与问题 SwfUpload支持一系列插件，以增强其功能。然而，由于文档部分未翻译，具体的插件列表和使用方式尚不清楚。同样地，关于SwfUpload已知的问题也未被翻译，因此开发者需要注意查阅英文文档或其他资料来获取相关信息。 总结而言，SwfUpload V2.2.0是一款功能强大的文件上传工具，它不仅提供了丰富的功能，而且具有良好的扩展性和定制性。对于希望提高用户体验并优化文件上传流程的开发者来说，SwfUpload无疑是一个值得考虑的选择。