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 )
根据文件id或文件索引来获取一个File Object,当使用文件id时只能获得队列里的文件,当使用文件索引时所有文件(包括队列内和队列外)都可获得
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按钮透明显示

内容太多了,感觉有点乱了,如果还不清楚怎么使用,建议看下官网的使用流程,明白怎么使用后再来看这些属性、事件、方法、常量什么的吧。

上一篇:jQuery插件开发的两种方法及$.fn.extend的详解(转)


下一篇:阅读jquery源码与js依赖加载的模块化!