1N/A <
meta http-
equiv="content-type" content="text/html; charset=UTF-8" />
1N/A<
body id="yahoo-com">
1N/A<
div id="doc3" class="yui-t2">
1N/A <
h3>Uploader <
span class="subtitle">3.1.0</
span></
h3>
1N/A <
a href="/index.html" title="Yahoo! UI Library">Yahoo! UI Library</
a>
1N/A <
form onsubmit="return false">
1N/A <
div id="propertysearch">
1N/A Search: <
input autocomplete="off" id="searchinput" />
1N/A <
div id="searchresults">
1N/A <
form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
1N/A <
legend>Filters</
legend>
1N/A <
span class="classopts"><
input type="checkbox" name="show_private" id="show_private" /> <
label for="show_private">Show Private</
label></
span>
1N/A <
span class="classopts"><
input type="checkbox" name="show_protected" id="show_protected" /> <
label for="show_protected">Show Protected</
label></
span>
1N/A <
span class="classopts"><
input type="checkbox" name="show_deprecated" id="show_deprecated" /> <
label for="show_deprecated">Show Deprecated</
label></
span>
<!-- class tree goes here --> <
div class="summary description" property="yui:description">
Creates the Uploader instance and keeps the initialization data
<
div class="section constructor details" rel="yui:constructor" resource="#constructor">
<
h3 id="constructor">Constructor</
h3>
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">config</
span>
<<
span property="yui:type">Object</
span>>
<
span property="yui:description"> (optional) Configuration parameters for the Uploader. The following parameters are available:
<
dt>boundingBox : String|Node (required)</
dt>
<
dt>buttonSkin : String (optional)</
dt>
<
dt>transparent : String (optional)</
dt>
<
dt>swfURL : String (optional)</
dt>
<
div rel="yui:properties" resource="#properties">
<
div class="section field details">
<
h3 id="properties">Properties</
h3>
<
div class="private" rel="yui:property" resource="#property__id">
<
h4><
a name="property__id" property="yui:name">_id</
a>
- <
code>private <
span property="yui:type">{String}</
span></
code>
<
div class="description" property="yui:description">
The id of this instance of uploader.
<
div class="private" rel="yui:property" resource="#property_uploaderswf">
<
h4><
a name="property_uploaderswf" property="yui:name">uploaderswf</
a>
- <
code>private <
span property="yui:type">{SWF}</
span></
code>
<
div class="description" property="yui:description">
The reference to the instance of
Y.SWF that encapsulates the instance of the Flash player with uploader logic.
<
div class="default" property="yui:defaultValue">
<
div rel="yui:methods" resource="#methods">
<
div class="section method details">
<
h3 id="methods">Methods</
h3>
<
div class="private" rel="yui:method" resource="#method__initializeUploader">
<
a name="method__initializeUploader">_initializeUploader</
a></
h4>
<
strong property="yui:name">_initializeUploader</
strong>
<
div class="description" property="yui:description">
Called when the uploader SWF is initialized
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Object</
span>>
<
span property="yui:description"> The event to be propagated from Flash.</
span>
<
div class="private" rel="yui:method" resource="#method__relayEvent">
<
a name="method__relayEvent">_relayEvent</
a></
h4>
<
strong property="yui:name">_relayEvent</
strong>
<
div class="description" property="yui:description">
Called when an event is dispatched from Uploader
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Object</
span>>
<
span property="yui:description"> The event to be propagated from Flash.</
span>
<
div class="" rel="yui:method" resource="#method_cancel">
<
a name="method_cancel">cancel</
a></
h4>
<
strong property="yui:name">cancel</
strong>
<
div class="description" property="yui:description">
Cancels the upload of a specific file, if currently in progress.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">fileID</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The ID of the file whose upload should be cancelled. If no ID is specified, all uploads are cancelled.</
span>
<
div class="" rel="yui:method" resource="#method_clearFileList">
<
a name="method_clearFileList">clearFileList</
a></
h4>
<
strong property="yui:name">clearFileList</
strong>
<
div class="description" property="yui:description">
<
div class="description">
<
code property="yui:return">
<
dd property="yui:returnInfo">This method always returns true.</
dd>
<
div class="" rel="yui:method" resource="#method_enable">
<
a name="method_enable">enable</
a></
h4>
<
strong property="yui:name">enable</
strong>
<
div class="description" property="yui:description">
Enables the uploader user input (mouse clicks on the 'Browse' button). If the button skin
is applied, the sprite is reset from the "disabled" state.
<
div class="description">
<
div class="protected" rel="yui:method" resource="#method_initializer">
<
a name="method_initializer">initializer</
a></
h4>
<
strong property="yui:name">initializer</
strong>
<
div class="description" property="yui:description">
Construction logic executed during Uploader instantiation.
<
div class="description">
<
div class="" rel="yui:method" resource="#method_removeFile">
<
a name="method_removeFile">removeFile</
a></
h4>
Object} The updated file list, which is an object of the format:
fileList[fileID] = {id: fileID, name: fileName, cDate: fileCDate, mDate: fileMDate, size: fileSize
<
strong property="yui:name">removeFile</
strong>
<
div class="description" property="yui:description">
Removes a specific file from the upload queue.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">fileID</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> The ID of the file to be removed</
span>
<
div class="private" rel="yui:method" resource="#method_setAllowLogging">
<
a name="method_setAllowLogging">setAllowLogging</
a></
h4>
<
strong property="yui:name">setAllowLogging</
strong>
<
div class="description" property="yui:description">
Setter for the 'log' property.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">value</
span>
<<
span property="yui:type">Boolean</
span>>
<
span property="yui:description"> The value for the 'log' property.</
span>
<
div class="private" rel="yui:method" resource="#method_setAllowMultipleFiles">
<
a name="method_setAllowMultipleFiles">setAllowMultipleFiles</
a></
h4>
<
strong property="yui:name">setAllowMultipleFiles</
strong>
<
div class="description" property="yui:description">
Setter for the 'multiFiles' property.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">value</
span>
<<
span property="yui:type">Boolean</
span>>
<
span property="yui:description"> The value for the 'multiFiles' property.</
span>
<
div class="private" rel="yui:method" resource="#method_setFileFilters">
<
a name="method_setFileFilters">setFileFilters</
a></
h4>
<
strong property="yui:name">setFileFilters</
strong>
<
div class="description" property="yui:description">
Setter for the 'fileFilters' property.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">value</
span>
<<
span property="yui:type">Boolean</
span>>
<
span property="yui:description"> The value for the 'fileFilters' property.</
span>
<
div class="private" rel="yui:method" resource="#method_setSimUploadLimit">
<
a name="method_setSimUploadLimit">setSimUploadLimit</
a></
h4>
<
strong property="yui:name">setSimUploadLimit</
strong>
<
div class="description" property="yui:description">
Setter for the 'simLimit' property.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">value</
span>
<<
span property="yui:type">Boolean</
span>>
<
span property="yui:description"> The value for the 'simLimit' property.</
span>
<
div class="" rel="yui:method" resource="#method_upload">
<
a name="method_upload">upload</
a></
h4>
<
strong property="yui:name">upload</
strong>
<
div class="description" property="yui:description">
Starts the upload of a specific file.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">fileID</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> The ID of the file to be uploaded.</
span>
<
code><
span property="yui:name">url</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> The URL to upload the file to.</
span>
<
code><
span property="yui:name">method</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)</
span>
<
code><
span property="yui:name">postVars</
span>
<<
span property="yui:type">Object</
span>>
<
span property="yui:description"> (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.</
span>
<
code><
span property="yui:name">postFileVarName</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)</
span>
<
code property="yui:return">
<
dd property="yui:returnInfo">This method always returns true.</
dd>
<
div class="" rel="yui:method" resource="#method_uploadAll">
<
a name="method_uploadAll">uploadAll</
a></
h4>
<
strong property="yui:name">uploadAll</
strong>
<
div class="description" property="yui:description">
Starts the upload of the files in the upload queue.
The upload queue is managed automatically.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">url</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> The URL to upload the files to.</
span>
<
code><
span property="yui:name">method</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)</
span>
<
code><
span property="yui:name">postVars</
span>
<<
span property="yui:type">Object</
span>>
<
span property="yui:description"> (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.</
span>
<
code><
span property="yui:name">postFileVarName</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default).</
span>
<
div class="" rel="yui:method" resource="#method_uploadThese">
<
a name="method_uploadThese">uploadThese</
a></
h4>
<
strong property="yui:name">uploadThese</
strong>
<
div class="description" property="yui:description">
Starts the upload of a set of files, as specified in the first argument.
The upload queue is managed automatically.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">fileIDs</
span>
<<
span property="yui:type">Array</
span>>
<
span property="yui:description"> The array of IDs of the files to be uploaded.</
span>
<
code><
span property="yui:name">url</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> The URL to upload the files to.</
span>
<
code><
span property="yui:name">method</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)</
span>
<
code><
span property="yui:name">postVars</
span>
<<
span property="yui:type">Object</
span>>
<
span property="yui:description"> (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.</
span>
<
code><
span property="yui:name">postFileVarName</
span>
<<
span property="yui:type">String</
span>>
<
span property="yui:description"> (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)</
span>
<
div rel="yui:events" resource="#events">
<
div class="section method details">
<
h3 id="events">Events</
h3>
<
div class="" rel="yui:event" resource="#event_boundingBoxChange">
<
a name="event_boundingBoxChange">boundingBoxChange</
a></
h4>
<
strong property="yui:name">boundingBoxChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'boundingBox' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_buttonSkinChange">
<
a name="event_buttonSkinChange">buttonSkinChange</
a></
h4>
<
strong property="yui:name">buttonSkinChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'buttonSkin' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_click">
<
a name="event_click">click</
a></
h4>
<
strong property="yui:name">click</
strong>
<
div class="description" property="yui:description">
Fired when the mouse button is clicked on the Uploader's 'Browse' button.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the click.</
span>
<
div class="" rel="yui:event" resource="#event_fileFilters This attribute is an array of Objects, eachin the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}Change">
<
a name="event_fileFilters This attribute is an array of Objects, eachin the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}Change">fileFilters This attribute is an array of Objects, each
in the following format: {description:"SomeDescription", extensions:"*.ext;*.ext;*.ext"}Change</
a></
h4>
<
strong property="yui:name">fileFilters This attribute is an array of Objects, each
in the following format: {description:"SomeDescription", extensions:"*.ext;*.ext;*.ext"}Change</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'fileFilters This attribute is an array of Objects, each
in the following format: {description:"SomeDescription", extensions:"*.ext;*.ext;*.ext"}' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_fileselect">
<
a name="event_fileselect">fileselect</
a></
h4>
<
strong property="yui:name">fileselect</
strong>
<
div class="description" property="yui:description">
Fires when the user has finished selecting a set of files to be uploaded.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event} The event object for the fileSelect.
<
dd>The file list Object with entries in the following format:
fileList[fileID] = {id: fileID, name: fileName, cDate: fileCDate, mDate: fileMDate, size: fileSize</
span>>
<
span property="yui:description"> </
dd>
<
div class="" rel="yui:event" resource="#event_logChange">
<
a name="event_logChange">logChange</
a></
h4>
<
strong property="yui:name">logChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'log' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_mousedown">
<
a name="event_mousedown">mousedown</
a></
h4>
<
strong property="yui:name">mousedown</
strong>
<
div class="description" property="yui:description">
Fired when the mouse button is pressed on the Uploader's 'Browse' button.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the mousedown.</
span>
<
div class="" rel="yui:event" resource="#event_mouseenter">
<
a name="event_mouseenter">mouseenter</
a></
h4>
<
strong property="yui:name">mouseenter</
strong>
<
div class="description" property="yui:description">
Fired when the mouse enters the Uploader's 'Browse' button.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the mouseenter.</
span>
<
div class="" rel="yui:event" resource="#event_mouseleave">
<
a name="event_mouseleave">mouseleave</
a></
h4>
<
strong property="yui:name">mouseleave</
strong>
<
div class="description" property="yui:description">
Fired when the mouse leaves the Uploader's 'Browse' button.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the mouseleave.</
span>
<
div class="" rel="yui:event" resource="#event_mouseup">
<
a name="event_mouseup">mouseup</
a></
h4>
<
strong property="yui:name">mouseup</
strong>
<
div class="description" property="yui:description">
Fired when the mouse button is raised on the Uploader's 'Browse' button.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the mouseup.</
span>
<
div class="" rel="yui:event" resource="#event_multiFilesChange">
<
a name="event_multiFilesChange">multiFilesChange</
a></
h4>
<
strong property="yui:name">multiFilesChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'multiFiles' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_simLimitChange">
<
a name="event_simLimitChange">simLimitChange</
a></
h4>
<
strong property="yui:name">simLimitChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'simLimit' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_swfURLChange">
<
a name="event_swfURLChange">swfURLChange</
a></
h4>
<
strong property="yui:name">swfURLChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'swfURL' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_transparentChange">
<
a name="event_transparentChange">transparentChange</
a></
h4>
<
strong property="yui:name">transparentChange</
strong>
<
div class="description" property="yui:description">
Fires when the value for the configuration attribute 'transparent' is changed. You can listen for the event using the <
a href="Attribute.html#method_on">on</
a> method if you wish to be notified before the attribute's value has changed, or using the <
a href="Event.Target.html#method_after">after</
a> method if you wish to be notified after the attribute's value has changed.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<
span property="yui:description">An Event Facade object with the following attribute specific properties added: <
dl> <
dt>prevVal</
dt> <
dd>The value of the attribute, prior to it being set</
dd> <
dt>newVal</
dt> <
dd>The value the attribute is to be set to</
dd> <
dt>attrName</
dt> <
dd>The name of the attribute being set</
dd> <
dt>subAttrName</
dt> <
dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</
dd> </
dl></
span>
<
div class="" rel="yui:event" resource="#event_uploadcancel">
<
a name="event_uploadcancel">uploadcancel</
a></
h4>
<
strong property="yui:name">uploadcancel</
strong>
<
div class="description" property="yui:description">
Announces that the uploader is ready and available for calling methods
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploaderReady.
<
dd><
code>drag:start</
code> event from the thumb</
dd>
<
div class="" rel="yui:event" resource="#event_uploadcomplete">
<
a name="event_uploadcomplete">uploadcomplete</
a></
h4>
<
strong property="yui:name">uploadcomplete</
strong>
<
div class="description" property="yui:description">
Fires when a specific file's upload is cancelled.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploadcancel.
<
dd>The id of the file whose upload has been cancelled.</
dd>
<
div class="" rel="yui:event" resource="#event_uploadcompletedata">
<
a name="event_uploadcompletedata">uploadcompletedata</
a></
h4>
<
strong property="yui:name">uploadcompletedata</
strong>
<
div class="description" property="yui:description">
If the server has sent a response to the file upload, this event is
fired and the response is added to its payload.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploadcompletedata.
<
dd>The id of the file for which the response is being provided.</
dd>
<
dd>The content of the server response.</
dd>
<
div class="" rel="yui:event" resource="#event_uploaderReady">
<
a name="event_uploaderReady">uploaderReady</
a></
h4>
<
strong property="yui:name">uploaderReady</
strong>
<
div class="description" property="yui:description">
Announces that the uploader is ready and available for calling methods
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploaderReady.</
span>
<
div class="" rel="yui:event" resource="#event_uploaderror">
<
a name="event_uploaderror">uploaderror</
a></
h4>
<
strong property="yui:name">uploaderror</
strong>
<
div class="description" property="yui:description">
Provides error information if an error has occurred during the upload.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploadeerror.
<
dd>The id of the file for which the upload error has occurred.</
dd>
<
dd>Relevant error information.</
dd>
<
div class="" rel="yui:event" resource="#event_uploadprogress">
<
a name="event_uploadprogress">uploadprogress</
a></
h4>
<
strong property="yui:name">uploadprogress</
strong>
<
div class="description" property="yui:description">
Provides progress information on a specific file upload.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploadprogress.
<
dd>The id of the file for which the progress information is being provided.</
dd>
<
dd>The number of bytes of the file that has been uploaded.</
dd>
<
dd>The total number of bytes in the file that is being uploaded.</
dd>
<
div class="" rel="yui:event" resource="#event_uploadstart">
<
a name="event_uploadstart">uploadstart</
a></
h4>
<
strong property="yui:name">uploadstart</
strong>
<
div class="description" property="yui:description">
Announces that the upload has been started for a specific file.
<
div class="description">
<
dl rel="yui:parameters">
<
code><
span property="yui:name">event</
span>
<<
span property="yui:type">Event</
span>>
<
span property="yui:description"> The event object for the uploadstart.
<
dd>The id of the file whose upload has been started.</
dd>
<
div rel="yui:attributes" resource="#configattributes">
<
div class="section field details">
<
h3 id="configattributes">Configuration Attributes</
h3>
<
div class="" rel="yui:attribute" resource="#config_boundingBox">
<
h4><
a name="config_boundingBox">boundingBox</
a>
<
code>- writeonce <
span property="yui:type">{Node}</
span></
code>
<
div class="description" property="yui:description">
The Node containing the uploader's 'Browse' button.
<
div class="" rel="yui:attribute" resource="#config_buttonSkin">
<
h4><
a name="config_buttonSkin">buttonSkin</
a>
<
code>- writeonce <
span property="yui:type">{String}</
span></
code>
<
div class="description" property="yui:description">
The URL of the image sprite for skinning the uploader's 'Browse' button.
<
div class="" rel="yui:attribute" resource="#config_fileFilters This attribute is an array of Objects, eachin the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}">
<
h4><
a name="config_fileFilters This attribute is an array of Objects, eachin the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}">fileFilters This attribute is an array of Objects, each
in the following format: {description:"SomeDescription", extensions:"*.ext;*.ext;*.ext"}</
a>
<
code>- <
span property="yui:type">{Array}</
span></
code>
<
div class="description" property="yui:description">
The array of filters on file extensions for
the 'Browse' dialog. These filters only provide
convenience for the user and do not strictly
limit the selection to certain file extensions.
<
div class="" rel="yui:attribute" resource="#config_log">
<
h4><
a name="config_log">log</
a>
<
code>- <
span property="yui:type">{Boolean}</
span></
code>
<
div class="description" property="yui:description">
The flag that allows Flash player to
output debug messages to its trace stack
(if the Flash debug player is used).
<
div class="" rel="yui:attribute" resource="#config_multiFiles">
<
h4><
a name="config_multiFiles">multiFiles</
a>
<
code>- <
span property="yui:type">{Boolean}</
span></
code>
<
div class="description" property="yui:description">
The flag that allows the user to select
more than one files during the 'Browse'
dialog (using 'Shift' or 'Ctrl' keys).
<
div class="" rel="yui:attribute" resource="#config_simLimit">
<
h4><
a name="config_simLimit">simLimit</
a>
<
code>- <
span property="yui:type">{Number}</
span></
code>
<
div class="description" property="yui:description">
The number of files that can be uploaded
simultaneously if the automatic queue management
is used. This value can be in the range between 2
<
div class="" rel="yui:attribute" resource="#config_swfURL">
<
h4><
a name="config_swfURL">swfURL</
a>
<
code>- writeonce <
span property="yui:type">{String}</
span></
code>
<
div class="description" property="yui:description">
The URL of the uploader's SWF.
<
div class="" rel="yui:attribute" resource="#config_transparent">
<
h4><
a name="config_transparent">transparent</
a>
<
code>- writeonce <
span property="yui:type">{Boolean}</
span></
code>
<
div class="description" property="yui:description">
The flag indicating whether the uploader is rendered
with a transparent background.
<
div id="moduleList" class="module">
<
div id="classList" class="module">
<
div id="fileList" class="module">
<
div id="propertyList" class="module">
<
li class="private"><
a href="#property__id" title="_id">_id</
a></
li>
<
li class="private"><
a href="#property_uploaderswf" title="uploaderswf">uploaderswf</
a></
li>
<
div id="methodsList" class="module">
<
li class="private"><
a href="#method__initializeUploader" title="_initializeUploader">_initializeUploader</
a></
li>
<
li class="private"><
a href="#method__relayEvent" title="_relayEvent">_relayEvent</
a></
li>
<
li class=""><
a href="#method_cancel" title="cancel">cancel</
a></
li>
<
li class=""><
a href="#method_clearFileList" title="clearFileList">clearFileList</
a></
li>
<
li class=""><
a href="#method_enable" title="enable">enable</
a></
li>
<
li class="protected"><
a href="#method_initializer" title="initializer">initializer</
a></
li>
<
li class=""><
a href="#method_removeFile" title="removeFile">removeFile</
a></
li>
<
li class="private"><
a href="#method_setAllowLogging" title="setAllowLogging">setAllowLogging</
a></
li>
<
li class="private"><
a href="#method_setAllowMultipleFiles" title="setAllowMultipleFiles">setAllowMultipleFiles</
a></
li>
<
li class="private"><
a href="#method_setFileFilters" title="setFileFilters">setFileFilters</
a></
li>
<
li class="private"><
a href="#method_setSimUploadLimit" title="setSimUploadLimit">setSimUploadLimit</
a></
li>
<
li class=""><
a href="#method_upload" title="upload">upload</
a></
li>
<
li class=""><
a href="#method_uploadAll" title="uploadAll">uploadAll</
a></
li>
<
li class=""><
a href="#method_uploadThese" title="uploadThese">uploadThese</
a></
li>
<
div id="eventsList" class="module">
<
li class=""><
a href="#event_boundingBoxChange" title="boundingBoxChange">boundingBoxChange</
a></
li>
<
li class=""><
a href="#event_buttonSkinChange" title="buttonSkinChange">buttonSkinChange</
a></
li>
<
li class=""><
a href="#event_click" title="click">click</
a></
li>
<
li class=""><
a href="#event_fileFilters This attribute is an array of Objects, eachin the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}Change" title="fileFilters This attribute is an array of Objects, each in the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}Change">fileFilters This attribute is an array of Objects, each
in the following format: {description:"SomeDescription", extensions:"*.ext;*.ext;*.ext"}Change</
a></
li>
<
li class=""><
a href="#event_fileselect" title="fileselect">fileselect</
a></
li>
<
li class=""><
a href="#event_logChange" title="logChange">logChange</
a></
li>
<
li class=""><
a href="#event_mousedown" title="mousedown">mousedown</
a></
li>
<
li class=""><
a href="#event_mouseenter" title="mouseenter">mouseenter</
a></
li>
<
li class=""><
a href="#event_mouseleave" title="mouseleave">mouseleave</
a></
li>
<
li class=""><
a href="#event_mouseup" title="mouseup">mouseup</
a></
li>
<
li class=""><
a href="#event_multiFilesChange" title="multiFilesChange">multiFilesChange</
a></
li>
<
li class=""><
a href="#event_simLimitChange" title="simLimitChange">simLimitChange</
a></
li>
<
li class=""><
a href="#event_swfURLChange" title="swfURLChange">swfURLChange</
a></
li>
<
li class=""><
a href="#event_transparentChange" title="transparentChange">transparentChange</
a></
li>
<
li class=""><
a href="#event_uploadcancel" title="uploadcancel">uploadcancel</
a></
li>
<
li class=""><
a href="#event_uploadcomplete" title="uploadcomplete">uploadcomplete</
a></
li>
<
li class=""><
a href="#event_uploadcompletedata" title="uploadcompletedata">uploadcompletedata</
a></
li>
<
li class=""><
a href="#event_uploaderReady" title="uploaderReady">uploaderReady</
a></
li>
<
li class=""><
a href="#event_uploaderror" title="uploaderror">uploaderror</
a></
li>
<
li class=""><
a href="#event_uploadprogress" title="uploadprogress">uploadprogress</
a></
li>
<
li class=""><
a href="#event_uploadstart" title="uploadstart">uploadstart</
a></
li>
<
div id="configList" class="module">
<
h4>Configuration Attributes</
h4>
<
li class=""><
a href="#config_boundingBox" title="boundingBox">boundingBox</
a></
li>
<
li class=""><
a href="#config_buttonSkin" title="buttonSkin">buttonSkin</
a></
li>
<
li class=""><
a href="#config_fileFilters This attribute is an array of Objects, eachin the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}" title="fileFilters This attribute is an array of Objects, each in the following format: {description:"SomeDescription", extensions:"*.
ext;*.
ext;*.
ext"}">fileFilters This attribute is an array of Objects, each
in the following format: {description:"SomeDescription", extensions:"*.ext;*.ext;*.ext"}</
a></
li>
<
li class=""><
a href="#config_log" title="log">log</
a></
li>
<
li class=""><
a href="#config_multiFiles" title="multiFiles">multiFiles</
a></
li>
<
li class=""><
a href="#config_simLimit" title="simLimit">simLimit</
a></
li>
<
li class=""><
a href="#config_swfURL" title="swfURL">swfURL</
a></
li>
<
li class=""><
a href="#config_transparent" title="transparent">transparent</
a></
li>
Copyright © 2010 Yahoo! Inc. All rights reserved.
var ALL_YUI_PROPS = [{"access": "", "host": "
YAHOO.widget.Uploader", "name": "boundingBox", "url": "
YAHOO.widget.Uploader.html#config_boundingBox", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "boundingBoxChange", "url": "
YAHOO.widget.Uploader.html#event_boundingBoxChange", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "buttonSkin", "url": "
YAHOO.widget.Uploader.html#config_buttonSkin", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "buttonSkinChange", "url": "
YAHOO.widget.Uploader.html#event_buttonSkinChange", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "cancel", "url": "
YAHOO.widget.Uploader.html#method_cancel", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "clearFileList", "url": "
YAHOO.widget.Uploader.html#method_clearFileList", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "click", "url": "
YAHOO.widget.Uploader.html#event_click", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "enable", "url": "
YAHOO.widget.Uploader.html#method_enable", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "fileFilters This attribute is an array of Objects, each\nin the following format: {description:\"SomeDescription\", extensions:\"*.ext;*.ext;*.ext\"}", "url": "
YAHOO.widget.Uploader.html#config_fileFilters This attribute is an array of Objects, each\nin the following format: {description:\"SomeDescription\", extensions:\"*.ext;*.ext;*.ext\"}", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "fileFilters This attribute is an array of Objects, each\nin the following format: {description:\"SomeDescription\", extensions:\"*.ext;*.ext;*.ext\"}Change", "url": "
YAHOO.widget.Uploader.html#event_fileFilters This attribute is an array of Objects, each\nin the following format: {description:\"SomeDescription\", extensions:\"*.ext;*.ext;*.ext\"}Change", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "fileselect", "url": "
YAHOO.widget.Uploader.html#event_fileselect", "type": "event"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "_id", "url": "
YAHOO.widget.Uploader.html#property__id", "type": "property"}, {"access": "protected", "host": "
YAHOO.widget.Uploader", "name": "initializer", "url": "
YAHOO.widget.Uploader.html#method_initializer", "type": "method"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "_initializeUploader", "url": "
YAHOO.widget.Uploader.html#method__initializeUploader", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "log", "url": "
YAHOO.widget.Uploader.html#config_log", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "logChange", "url": "
YAHOO.widget.Uploader.html#event_logChange", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "mousedown", "url": "
YAHOO.widget.Uploader.html#event_mousedown", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "mouseenter", "url": "
YAHOO.widget.Uploader.html#event_mouseenter", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "mouseleave", "url": "
YAHOO.widget.Uploader.html#event_mouseleave", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "mouseup", "url": "
YAHOO.widget.Uploader.html#event_mouseup", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "multiFiles", "url": "
YAHOO.widget.Uploader.html#config_multiFiles", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "multiFilesChange", "url": "
YAHOO.widget.Uploader.html#event_multiFilesChange", "type": "event"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "_relayEvent", "url": "
YAHOO.widget.Uploader.html#method__relayEvent", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "removeFile", "url": "
YAHOO.widget.Uploader.html#method_removeFile", "type": "method"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "setAllowLogging", "url": "
YAHOO.widget.Uploader.html#method_setAllowLogging", "type": "method"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "setAllowMultipleFiles", "url": "
YAHOO.widget.Uploader.html#method_setAllowMultipleFiles", "type": "method"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "setFileFilters", "url": "
YAHOO.widget.Uploader.html#method_setFileFilters", "type": "method"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "setSimUploadLimit", "url": "
YAHOO.widget.Uploader.html#method_setSimUploadLimit", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "simLimit", "url": "
YAHOO.widget.Uploader.html#config_simLimit", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "simLimitChange", "url": "
YAHOO.widget.Uploader.html#event_simLimitChange", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "swfURL", "url": "
YAHOO.widget.Uploader.html#config_swfURL", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "swfURLChange", "url": "
YAHOO.widget.Uploader.html#event_swfURLChange", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "transparent", "url": "
YAHOO.widget.Uploader.html#config_transparent", "type": "config"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "transparentChange", "url": "
YAHOO.widget.Uploader.html#event_transparentChange", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "upload", "url": "
YAHOO.widget.Uploader.html#method_upload", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadAll", "url": "
YAHOO.widget.Uploader.html#method_uploadAll", "type": "method"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadcancel", "url": "
YAHOO.widget.Uploader.html#event_uploadcancel", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadcomplete", "url": "
YAHOO.widget.Uploader.html#event_uploadcomplete", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadcompletedata", "url": "
YAHOO.widget.Uploader.html#event_uploadcompletedata", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploaderReady", "url": "
YAHOO.widget.Uploader.html#event_uploaderReady", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploaderror", "url": "
YAHOO.widget.Uploader.html#event_uploaderror", "type": "event"}, {"access": "private", "host": "
YAHOO.widget.Uploader", "name": "uploaderswf", "url": "
YAHOO.widget.Uploader.html#property_uploaderswf", "type": "property"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadprogress", "url": "
YAHOO.widget.Uploader.html#event_uploadprogress", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadstart", "url": "
YAHOO.widget.Uploader.html#event_uploadstart", "type": "event"}, {"access": "", "host": "
YAHOO.widget.Uploader", "name": "uploadThese", "url": "
YAHOO.widget.Uploader.html#method_uploadThese", "type": "method"}];