详细介绍SWFUpload
详细介绍SWFUpload
来源:详细介绍SWFUpload
网上的例子介绍的文档真的很多。下面简单介绍一下
SWFUpload的文件上传流程是这样的:
1、引入相应的js文件
2、实例化SWFUpload对象,传入一个配置参数对象进行各方面的配置。
3、点击SWFUpload提供的Flash按钮,弹出文件选取窗口选择要上传的文件;
4、文件选取完成后符合规定的文件会被添加到上传的队列里;
5、调用startUpload方法让队列里文件开始上传;
6、文件上传过程中会触发相应的事件,开发者利用这些事件来更新ui、处理错误、发出提示等等;
SWFUpload包括三部分的内容:SWFUpload.js、swfupload.swf、初始化配置参数及各种事件处理函数。所以首先在页面引入SWFUpload.js
<script src='SWFUpload.js'></script>
然后在页面中实例化一个SWFUpload对象:
var swfu;
window.onload = function () {
var settings_object = {//定义参数配置对象
upload_url : "http://www.swfupload.org/upload.php",
flash_url : "http://www.swfupload.org/swfupload.swf",
file_post_name : "Filedata",
post_params : {
"post_param_name_1" : "post_param_value_1",
"post_param_name_2" : "post_param_value_2",
"post_param_name_n" : "post_param_value_n"
},
use_query_string : false,
requeue_on_error : false,
http_success : [201, 202],
assume_success_timeout : 0,
file_types : "*.jpg;*.gif",
file_types_description: "Web Image Files",
file_size_limit : "1024",
file_upload_limit : 10,
file_queue_limit : 2,
debug : false,
prevent_swf_caching : false,
preserve_relative_urls : false,
button_placeholder_id : "element_id",
button_image_url : "http://www.swfupload.org/button_sprite.png",
button_width : 61,
button_height : 22,
button_text : "<b>Click</b> <span class="redText">here</span>",
button_text_style : ".redText { color: #FF0000; }",
button_text_left_padding : 3,
button_text_top_padding : 2,
button_action : SWFUpload.BUTTON_ACTION.SELECT_FILES,
button_disabled : false,
button_cursor : SWFUpload.CURSOR.HAND,
button_window_mode : SWFUpload.WINDOW_MODE.TRANSPARENT,
swfupload_loaded_handler : swfupload_loaded_function,
file_dialog_start_handler : file_dialog_start_function,
file_queued_handler : file_queued_function,
file_queue_error_handler : file_queue_error_function,
file_dialog_complete_handler : file_dialog_complete_function,
upload_start_handler : upload_start_function,
upload_progress_handler : upload_progress_function,
upload_error_handler : upload_error_function,
upload_success_handler : upload_success_function,
upload_complete_handler : upload_complete_function,
debug_handler : debug_function,
};
swfu = new SWFUpload(settings_object);//实例化一个SWFUpload,传入参数配置对象
};
/*定义各种事件监听函数*/
function swfupload_loaded_function(){}
function file_dialog_start_function(){}
//...等等
我们看到要实现一个SWFUpload上传功能很简单,就是实例化一个SWFUpload对象。但繁琐的地方就在于实例化实要用到的参数配置对象,以及各种事件的发生时机以和提供的参数。所以重点来了。下面几个表格对开发中要用到的东西列举了出来,虽然已经蛮多了,但并不是SWFUpload的全部,我列出来的只是常用的。要查看完整的文档,请到SWFUpload官网上查询。
(一)、配置参数对象中的常用属性及说明
属性 | 类型 | 默认值 | 描述 |
---|---|---|---|
upload_url | String | 处理上传文件的服务器端页面的url地址,可以是绝对地址,也可以是相对地址,当为相对地址时相对的是当前代码所在的文档地址 | |
preserve_relative_urls | Boolean | false | 如果为false则SWFUpload会把swfupload.swf用到的相对地址转换为绝对地址,以达到更好的兼容性 |
file_post_name | String | Filedata | 相当于用普通的文件域上传文件时的name属性,服务器端接收页面通过该名称来获取上传的文件 |
post_params | Object(直接量) | 一个对象直接量,里面的键/值对会随着每一个文件一起上传,文件上传要附加一些信息时很有用 | |
use_query_string | Boolean | false | 为false时,post_params属性定义的参数会以post方式上传;为true时,则会以get方式上传(即参数会以查询字符串的形式附加到url后面) |
file_types | String | 该属性指定了允许上传的文件类型,当有多个类型时使用分号隔开,比如:.jpg;.png ,允许所有类型时请使用 . | |
file_types_description | String | 指定在文件选取窗口中显示的文件类型描述,起一个提示和说明的作用吧 | |
file_size_limit | String | 指定要上传的文件的最大体积,可以带单位,合法的单位有:B、KB、MB、GB,如果省略了单位,则默认为KB。该属性为0时,表示不限制文件的大小。 | |
file_upload_limit | Number | 指定最多能上传多少个文件,当上传成功的文件数量达到了这个最大值后,就不能再上传文件了,也不能往上传队列里添加文件了。把该属性设为0时表示不限制文件的上传数量。 | |
file_queue_limit | Number | 指定文件上传队列里最多能同时存放多少个文件。当超过了这个数目后只有当队列里有文件上传成功、上传出错或被取消上传后,等同数量的其他文件才可以被添加进来。当file_upload_limit的数值或者剩余的能上传的文件数量小于file_queue_limit时,则取那个更小的值 | |
flash_url | String | swfupload.swf文件的绝对或相对地址,相对地址是指相对于当前的页面地址。实例化swfupload后,就不 | |
prevent_swf_caching | Boolean | 为true时会加一个随机数在swfupload.swf地址的后面,以阻止flash影片被缓存,这是为了防止某些版本的IE浏览器在读取缓存的falsh影片时出现的bug | |
button_placeholder_id | String | 指定一个dom元素的id,该dom元素在swfupload实例化后会被Flash按钮代替,这个dom元素相当于一个占位符 | |
button_placeholder | DOMElement | 指定一个dom元素,该dom元素在swfupload实例化后会被Flash按钮代替,这个dom元素相当于一个占位符。当button_placeholder_id与button_placeholder都存在时,以button_placeholder_id为优先 | |
button_image_url | String |
指定Flash按钮的背景图片,相对地址或绝对地址都可以。该地址会受到preserve_relative_urls属性的影响,遵从与upload_url一样的规则。 该背景图片必须是一个sprite图片,从上到下包含了Flash按钮的正常、鼠标悬停、按下、禁用这四种状态。因此该图片的高度应该是Flash按钮高度的四倍 |
|
button_width | Number | 指定Flash按钮的宽度 | |
button_height | Number | 指定Flash按钮的高度,应该为button_image_url所指定的按钮背景图片高度的1/4 | |
button_text | String | 指定Flash按钮上的文字,也可以是html代码 | |
button_text_style | String | Flash按钮上的文字的样式,使用方法见示例 | |
button_text_top_padding | Number | 指定Flash按钮顶部的内边距,可使用负值 | |
button_text_left_padding | Number | 指定Flash按钮左边的内边距,可使用负值 | |
button_disabled | Boolean | false | 为true时Flash按钮将变为禁用状态,点击也不会触发任何行为 |
button_cursor | 指定鼠标悬停在Flash按钮上时的光标样式,可用值为SWFUpload.CURSOR里定义的常量 | ||
button_window_mode | 指定Flash按钮的WMODE属性,可用值为SWFUpload.WINDOW_MODE里定义的常量 | ||
file_dialog_start_handler | Function | fileDialogStart事件侦听函数 | |
file_queued_handler | Function | fileQueued事件侦听函数 | |
file_queue_error_handler | Function | fileQueueError事件侦听函数 | |
file_dialog_complete_handler | Function | fileDialogComplete事件侦听函数 | |
upload_start_handler | Function | uploadStart事件侦听函数 | |
upload_progress_handler | Function | uploadProgress事件侦听函数 | |
upload_error_handler | Function | uploadError事件侦听函数 | |
upload_success_handler | Function | uploadSuccess事件侦听函数 | |
upload_complete_handler | Function | uploadComplete事件侦听函数 |
(二)、各种事件说明
要实现与用户的交互,靠的就是在这些事件上做文章了
名称 | 说明 |
---|---|
fileDialogStart ( ) | 在文件选取窗口将要弹出时触发 |
fileQueued ( file object ) | 当一个文件被添加到上传队列时会触发此事件,提供的唯一参数为包含该文件信息的file object对象 |
fileQueueError ( file object, error code, message ) |
当文件添加到上传队列失败时触发此事件,失败的原因可能是文件大小超过了你允许的数值、文件是空的或者文件队列已经满员了等。 该事件提供了三个参数。第一个参数是当前出现问题的文件对象,第二个参数是具体的错误代码,可以参照SWFUpload.QUEUE_ERROR中定义的常量 |
fileDialogComplete ( number of files selected, number of files queued, total number of files in the queued ) |
当文件选取完毕且选取的文件经过处理后(指添加到上传队列),会立即触发该事件。可以在该事件中调用this.startUpload()方法来实现文件的自动上传 参数number of files selected指本次在文件选取框里选取的文件数量 参数number of files queued指本次被添加到上传队列的文件数量 参数total number of files in the queued指当前上传队列里共有多少个文件(包括了本次添加进去的文件) |
uploadStart ( file object ) |
当文件即将上传时会触发该事件,该事件给了你在文件上传前的最后一次机会来验证文件信息、增加要随之上传的附加信息或做其他工作。可以通过返回false来取消本次文件的上传 参数file object为当前要上传的文件的信息对象 |
uploadProgress ( file object, bytes complete, total bytes ) |
该事件会在文件的上传过程中反复触发,可以利用该事件来实现上传进度条 参数file object为文件信息对象 参数bytes complete为当前已上传的字节数 参数total bytes为文件总的字节数 |
uploadError ( file object, error code, message ) |
文件上传被中断或是文件没有成功上传时会触发该事件。停止、取消文件上传或是在uploadStart事件中返回false都会引发这个事件,但是如果某个文件被取消了但仍然还在队列中则不会触发该事件 参数file object为文件信息对象 参数error code为错误代码,具体的可参照SWFUpload.UPLOAD_ERROR中定义的常量 |
uploadSuccess ( file object, server data, received response ) |
当一个文件上传成功后会触发该事件 参数file object为文件信息对象 参数server data为服务器端输出的数据 |
uploadComplete( file object ) | 当一次文件上传的流程完成时(不管是成功的还是不成功的)会触发该事件,该事件表明本次上传已经完成,上传队列里的下一个文件可以开始上传了。该事件发生后队列中下一个文件的上传将会开始 |
(三)、swfupload实例的方法
方法中大多数是动态改变参数配置对象的方法
名称 | 说明 |
---|---|
destroy ( ) | 当不需要再使用SWFUpload了的时候,可以使用该方法来销毁它的实例和dom元素 |
startUpload( file_id ) |
开始上传队列中指定的文件 参数file_id代表要上传的文件的id,如果未填写这个参数,则会上传队列中第一个文件 |
cancelUpload ( file_id, trigger_error_event ) |
取消文件的上传 参数file_id为要取消的文件的id,如果该参数为undefined或者未填写,则会取消队列里的第一个文件 参数trigger_error_event接受一个布尔值,当为false时取消文件不会触发uploadError事件,默认为true |
stopUpload ( ) | 终止当前正在上传的文件,会触发uploadError事件。如果当前没有文件在上传,则该方法什么都不会做 |
getStats ( ) | 获取队列的stats object |
setStats ( stats_object ) | 修改队列的stats_object,传入修改过的stats_object作为参数 |
getFile ( file_id | index ) |
addPostParam ( name, value) | 往配置对象中post_params指定的附加信息对象中增加键/值对 |
removePostParam ( name) | 移除置配置对象中的post_params包含的某一个键/值对,参数name为要移除的值的键名 |
addFileParam ( file_id, name, value) |
为某个特定文件增加随之一起上传的附加信息。注意,只有在该指定的文件上传时,附加的信息才会一起上传。而配置对象中post_param设置的附加信息在任一文件上传时都会与之一起发送。 参数file_id为要指定的文件id,参数name和value分别为附加信息的名称和值 |
removeFileParam ( file_id, name) | 移除通过addFileParam方法增加的附加信息,两个参数相信就不用我多讲了吧 |
setUploadURL ( url) | 动态设置配置对象中upload_url的值 |
setPostParams ( param_object) |
动态设置配置对象中post_params属性的值,新的值会覆盖旧的值。 参数param_object必须为一个对象直接量,且里面的属性和值都只能为字符串 |
setFileTypes ( types, description) | 动态设置配置对象中file_types 和 file_types_description属性的值。两个参数都不能省略 |
setFileSizeLimit ( file_size_limit) | 动态设置配置对象中file_size_limit属性的值 |
setFileUploadLimit ( file_upload_limit) | 动态设置配置对象中file_upload_limit属性的值 |
setFileQueueLimit ( file_queue_limit) | 动态设置配置对象中file_queue_limit属性的值 |
setFilePostName ( file_post_name) | 动态设置配置对象中file_post_name属性的值 |
setUseQueryString ( use_query_string) | 动态设置配置对象中use_query_string属性的值 |
setButtonImageURL ( url) | 动态设置配置对象中button_image_url属性的值 |
setButtonDimensions ( width, height) | 动态设置Flash按钮的宽度和高度,两个参数分别为宽度和高度的值,类型为数字,且不能带单位 |
setButtonText ( text) | 动态设置配置对象中button_text属性的值 |
setButtonTextStyle ( css_style_text) | 动态设置配置对象中button_text_style属性的值 |
setButtonTextPadding ( left, top ) | 动态设置Flash按钮的左边内边距和顶部内边距 |
setButtonDisabled ( isDisabled ) | 动态对Flash按钮进行禁用和不禁用的操作,参数为一个布尔值 |
setButtonCursor ( buttonCursor ) | 动态设置配置对象中button_cursor的值 |
(四)、文件信息对象 File Object
在事件监听函数中,经常要用到文件信息对象来获取文件的信息以供下一步的操作
属性 | 类型 | 描述 |
---|---|---|
id | String | SWFUpload定义的文件id,用来控制文件的上传 |
index | Number | 文件的索引,用在getFile(i)方法中 |
name | String | 文件的原始名称,不包括路径 |
type | String | 文件类型 |
creationdate | Date | 文件的创建日期 |
modificationdate | Date | 文件的最后修改日期 |
filestatus | Number | 当前文件的状态,详细的请参照SWFUpload.FILE_STATUS中定义的常量 |
(五)、队列状态对象 Stats Object
用来获取当前队列的状况
属性 | 类型 | 描述 |
---|---|---|
in_progress | Number | 得到的值为1或0,表明当前队列是否有文件正在上传中 |
files_queued | Number | 目前上传队列中的文件数量 |
successful_uploads | Number | 已成功上传(指触发了uploadSuccess事件)的文件数量 |
upload_errors | Number | 上传失败的文件数量(包括被取消上传的文件) |
upload_cancelled | Number | 被取消上传的文件数量 |
queue_errors | Number | 触发了fileQueueError事件的文件数量 |
(六)、一些常量
定义的一些常量,便于理解
常量名 | 描述 |
---|---|
SWFUpload.instances | 该常量是一个对象,代表一个页面上所有的SWFUpload实例的引用的集合,用SWFUpload实例的movieName属性进行索引 |
SWFUpload.movieCount | 页面上存在的SWFUpload实例的数量 |
SWFUpload.QUEUE_ERROR.QUEUE_LIMIT_EXCEEDED | 用户选取的文件超过了允许的数量 |
SWFUpload.QUEUE_ERROR.FILE_EXCEEDS_SIZE_LIMIT | 文件的体积超过了允许的大小 |
SWFUpload.QUEUE_ERROR.ZERO_BYTE_FILE | 文件是空的 |
SWFUpload.QUEUE_ERROR.INVALID_FILETYPE | 不允许的文件类型 |
SWFUpload.UPLOAD_ERROR.HTTP_ERROR | 服务器返回的状态码不是200 |
SWFUpload.UPLOAD_ERROR.MISSING_UPLOAD_URL | 没有设置 upload_url |
SWFUpload.UPLOAD_ERROR.IO_ERROR | 读取或传输文件时发生错误 |
SWFUpload.UPLOAD_ERROR.SECURITY_ERROR | 上传受到了安全方面的限制 |
SWFUpload.UPLOAD_ERROR.UPLOAD_LIMIT_EXCEEDED | 上传的文件数量超过了允许的最大值 |
SWFUpload.UPLOAD_ERROR.UPLOAD_FAILED | 上传出现错误 |
SWFUpload.UPLOAD_ERROR.SPECIFIED_FILE_ID_NOT_FOUND | 给startUpload()方法传入的文件id不存在 |
SWFUpload.UPLOAD_ERROR.FILE_VALIDATION_FAILED | uploadStart()方法中返回了false |
SWFUpload.UPLOAD_ERROR.FILE_CANCELLED | 上传被取消了 |
SWFUpload.UPLOAD_ERROR.UPLOAD_STOPPED | 上传被终止了 |
SWFUpload.FILE_STATUS.QUEUED | 文件正在队列中等待上传 |
SWFUpload.FILE_STATUS.IN_PROGRESS | 文件正在上传 |
SWFUpload.FILE_STATUS.ERROR | 文件在添加到队列或是上传的时候出现了错误 |
SWFUpload.FILE_STATUS.COMPLETE | 文件已上传成功 |
SWFUpload.FILE_STATUS. | 文件被取消上传 |
SWFUpload.CURSOR.ARROW | 鼠标以箭头显示 |
SWFUpload.CURSOR.HAND | 鼠标以手形显示 |
SWFUpload.WINDOW_MODE.WINDOW | Flash按钮会显示在页面的所有dom元素上面 |
SWFUpload.WINDOW_MODE.OPAQUE | 允许其他dom元素覆盖住Flash按钮 |
SWFUpload.WINDOW_MODE.TRANSPARENT | 允许Flash按钮透明显示 |
官方站点:http://www.swfupload.org/
DEMO地址:http://demo.swfupload.org/
SWFUplaod学习笔记阅读顺序
一、了解SWFUpload
http://hanxin0311.iteye.com/blog/1915611
二、详细介绍SWFUpload
http://hanxin0311.iteye.com/blog/1915615
三、struts2+swfUpload简单例子
http://hanxin0311.iteye.com/blog/1915626
四、struts2+swfUpload深度整合
http://hanxin0311.iteye.com/blog/1915628
SWFUpload像服务器传递参数
http://hanxin0311.iteye.com/blog/1913946
SWFUpload接受服务器Action返回的参数
http://hanxin0311.iteye.com/blog/1915644
SWFUpload中文乱码问题
http://hanxin0311.iteye.com/blog/1915648
详细介绍SWFUpload相关推荐
- HTML页面加载和解析流程详细介绍
浏览器加载和渲染html的顺序.如何加快HTML页面加载速度.HTML页面加载和解析流程等等,在本文将为大家详细介绍下,感兴趣的朋友不要错过 浏览器加载和渲染html的顺序 1. IE下载的顺序是从上 ...
- mysql为什么要压测_mysql集群压测的详细介绍
本篇文章给大家带来的内容是关于mysql集群压测的详细介绍,有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助. mysql压测 mysql自带就有一个叫mysqlslap的压力测试工具,通 ...
- php比较运算符案列,PHP实例:PHP比较运算符的详细介绍
<PHP实例:PHP比较运算符的详细介绍>要点: 本文介绍了PHP实例:PHP比较运算符的详细介绍,希望对您有用.如果有疑问,可以联系我们. 比拟运算符种类 PHP实战如同它们名称所暗示的 ...
- Tempdb数据库详细介绍
Tempdb数据库详细介绍 一.Tempdb简介 tempdb是SQLServer的系统数据库一直都是SQLServer的重要组成部分,用来存储临时对象.可以简单理解tempdb是SQLServer的 ...
- linux路由介绍,Linux的路由表详细介绍
Linux的路由表详细介绍 一 在Linux下执行route命令[root@localhost backup]# route -nKernel IP routing tableDestination ...
- pythonexcel介绍_Python 中pandas.read_excel详细介绍
Python 中pandas.read_excel详细介绍 #coding:utf-8 import pandas as pd import numpy as np filefullpath = r& ...
- 渡神纪帧数测试软件,渡神纪芬尼斯崛起配置要求高吗 渡神纪配置要求详细介绍_游侠网...
渡神纪芬尼斯崛起配置要求高吗?本作将在12月3日登陆主机和PC,很多玩家比较关心游戏的配置,这里给大家带来了渡神纪配置要求详细介绍,快来了解下吧. 渡神纪配置要求详细介绍 最低要求(720p/30 f ...
- C++11 unordered_map详细介绍
整理的算法模板合集: ACM模板 目录: 1.介绍 1.1 特性 2. 模版 2.1 迭代器 3. 功能函数 3.1 构造函数 3.2 容量操作 3.2.1 size 3.2.2 empty 3.3 ...
- autosar中com模块_详细介绍AUTOSAR各个模块作用PART1(OS,SYS)
这片文章中我们详细讲解下每个模块的功能,上图是vector的autosar方案,每个模块的详细介绍后续会有单独文章进行讲解,请关注.以下是各个模块的简介 1.VHSM hardware Securit ...
- python绘图和可视化_Python 绘图和可视化详细介绍
Python之绘图和可视化 1. 启用matplotlib 最常用的Pylab模式的IPython(IPython --pylab) 2. matplotlib的图像都位于Figure对象中. 可以使 ...
最新文章
- sscanf fscanf函数格式化输入遇到\n问题
- CentOS中怎样卸载旧版本Git并安装高版本Git
- Java源码分析:深入探讨Iterator模式
- Eureka-eureka原理分析
- 集合初始化时,指定集合初始值大小
- android第三方登录appid,AndroidQQ第三方登录
- pytorch 绘制多个算法loss_PyTorch线性模型和梯度下降
- 卡巴斯基发现ATM病毒Skimmer改进版
- Android 保持屏幕常亮
- 消息队列 RocketMQ原理和使用整理
- ESP32 学习笔记(二十九) ESP32 低功耗模式
- 实体消歧、实体统一和指代消歧
- 雷达干扰技术(二)数字干扰合成及相关技术
- 计算机网络 自顶向下方法.原书第6版 - 网络层次、应用、发展
- openwrt路由器接华为E3372(E8372)网卡实现4G转有线和WIFI
- 如果让你设计一个微信朋友圈,你怎么设计
- 国产系统UOS上的视频监控系统
- 利用Javascript生成txt文本文件
- 1.2.1 python中的函数
- QQ空间迁移_【SRX550_HA_以及端口绑定高可靠性尝试】