(一)、配置参数对象中的常用属性及说明
类型 |
默认值 |
描述 |
|
upload_url |
String |
|
|
preserve_relative_urls |
Boolean |
false |
如果为false则SWFUpload会把swfupload.swf用到的相对地址转换为绝对地址,以达到更好的兼容性 |
file_post_name |
String |
Filedata |
|
post_params |
Object(直接量) |
|
|
use_query_string |
Boolean |
false |
为false时,post_params属性定义的参数会以post方式上传;为true时,则会以get方式上传(即参数会以查询字符串的形式附加到url后面) |
file_types |
String |
|
|
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一样的规则。 |
button_width |
Number |
|
指定Flash按钮的宽度 |
button_height |
Number |
|
指定Flash按钮的高度,应该为button_image_url所指定的按钮背景图片高度的1/4 |
button_text |
String |
|
|
button_text_style |
String |
|
|
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 ) |
fileQueueError ( file object,error code,message ) |
当文件添加到上传队列失败时触发此事件,失败的原因可能是文件大小超过了你允许的数值、文件是空的或者文件队列已经满员了等。 |
fileDialogComplete ( number of files selected,number of files queued,total number of files in the queued ) |
当文件选取完毕且选取的文件经过处理后(指添加到上传队列),会立即触发该事件。可以在该事件中调用this.startUpload()方法来实现文件的自动上传 |
uploadStart ( file object ) |
当文件即将上传时会触发该事件,该事件给了你在文件上传前的最后一次机会来验证文件信息、增加要随之上传的附加信息或做其他工作。可以通过返回false来取消本次文件的上传 |
uploadProgress ( file object,bytes complete,total bytes ) |
该事件会在文件的上传过程中反复触发,可以利用该事件来实现上传进度条 |
uploadError ( file object,message ) |
文件上传被中断或是文件没有成功上传时会触发该事件。停止、取消文件上传或是在uploadStart事件中返回false都会引发这个事件,但是如果某个文件被取消了但仍然还在队列中则不会触发该事件 |
uploadSuccess ( file object,server data,received response ) |
当一个文件上传成功后会触发该事件 |
uploadComplete( file object ) |
当一次文件上传的流程完成时(不管是成功的还是不成功的)会触发该事件,该事件表明本次上传已经完成,上传队列里的下一个文件可以开始上传了。该事件发生后队列中下一个文件的上传将会开始 |
(三)、swfupload实例的方法
destroy ( ) |
当不需要再使用SWFUpload了的时候,可以使用该方法来销毁它的实例和dom元素 |
startUpload( file_id ) |
cancelUpload ( file_id,trigger_error_event ) |
取消文件的上传 |
stopUpload ( ) |
getStats ( ) |
获取队列的stats object |
setStats ( stats_object ) |
getFile ( file_id|index ) |
根据文件id或文件索引来获取一个File Object,当使用文件id时只能获得队列里的文件,当使用文件索引时所有文件(包括队列内和队列外)都可获得 |
addPostParam ( name,value) |
removePostParam ( name) |
addFileParam ( file_id,name,value) |
为某个特定文件增加随之一起上传的附加信息。注意,只有在该指定的文件上传时,附加的信息才会一起上传。而配置对象中post_param设置的附加信息在任一文件上传时都会与之一起发送。 |
removeFileParam ( file_id,name) |
setUploadURL ( url) |
动态设置配置对象中upload_url的值 |
动态设置配置对象中post_params属性的值,新的值会覆盖旧的值。 |
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按钮的左边内边距和顶部内边距 |
动态对Flash按钮进行禁用和不禁用的操作,参数为一个布尔值 |
setButtonCursor ( buttonCursor ) |
动态设置配置对象中button_cursor的值 |
(四)、文件信息对象 File Object
在事件监听函数中,经常要用到文件信息对象来获取文件的信息以供下一步的操作
类型 |
描述 |
|
id |
String |
|
index |
Number |
|
name |
String |
|
type |
String |
文件类型 |
creationdate |
Date |
文件的创建日期 |
modificationdate |
Date |
|
filestatus |
Number |
当前文件的状态,详细的请参照SWFUpload.FILE_STATUS中定义的常量 |
(五)、队列状态对象 Stats Object
用来获取当前队列的状况
类型 |
描述 |
|
in_progress |
Number |
|
files_queued |
Number |
|
successful_uploads |
Number |
|
upload_errors |
Number |
|
upload_cancelled |
Number |
|
queue_errors |
Number |
(六)、一些常量
定义的一些常量,便于理解
常量名 |
描述 |
SWFUpload.instances |
该常量是一个对象,代表一个页面上所有的SWFUpload实例的引用的集合,用SWFUpload实例的movieName属性进行索引 |
SWFUpload.movieCount |
|
|
|
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 |
|
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 |
|
SWFUpload.WINDOW_MODE.OPAQUE |
允许其他dom元素覆盖住Flash按钮 |
SWFUpload.WINDOW_MODE.TRANSPARENT |
允许Flash按钮透明显示 |