uploader-deprecated.js revision 71bbbe94567d63ab107a7eab263595bcc6e47833
/**
* Attention: this is the 3.4.1 `uploader` module has been deprecated in favor of a new
* uploader with an HTML5 layer. Please refer to the new Uploader User Guide for migration
* information.
*
* This module uses Flash player transport to upload files to the server, with support for
* file filtering, multiple file uploads and progress monitoring.
* @module uploader-deprecated
* @deprecated
*/
/*
* <p><strong><span style="color:#ff0000;">Attention: this is the 3.4.1 uploader module, which has
* been deprecated in favor of a new uploader with an HTML5 layer. Please refer to the new
* Uploader User Guide for migration information.</span></strong></p>
* <p>The Uploader widget is a tool for uploading files to the server.</p>
* @module uploader-deprecated
* @title Uploader
* @requires base, node, event, swf
*/
/*
* <p><strong><span style="color:#ff0000;">Attention: this is the 3.4.1 uploader module, which has
* been deprecated in favor of a new uploader with an HTML5 layer. Please refer to the new
* Uploader User Guide for migration information.</span></strong></p>
* <p>Creates the Uploader instance and keeps the initialization data.</p>
*
* @class Uploader
* @extends Y.Base
* @constructor
* @param {Object} config (optional) Configuration parameters for the Uploader. The following parameters are available:
* <dl>
* <dt>boundingBox : String|Node (required)</dt>
* <dd></dd>
* <dt>buttonSkin : String (optional)</dt>
* <dd></dd>
* <dt>transparent : String (optional)</dt>
* <dd></dd>
* <dt>swfURL : String (optional)</dt>
* <dd></dd>
* </dl>
* @deprecated
*/
};
};
};
};
};
/*
* The reference to the instance of Y.SWF that encapsulates the instance of the Flash player with uploader logic.
*
* @private
* @property uploaderswf
* @type {SWF}
* @default null
* @deprecated
*/
uploaderswf:null,
/*
* The id of this instance of uploader.
*
* @private
* @property _id
* @type {String}
* @deprecated
*/
_id:"",
/*
* Construction logic executed during Uploader instantiation.
*
* @method initializer
* @protected
* @deprecated
*/
initializer : function () {
flashVars: {}};
}
if (this.get("transparent")) {
}
var upswf = this.uploaderswf;
/*
* Announces that the uploader is ready and available for calling methods
* and setting properties
*
* @event uploaderReady
* @param event {Event} The event object for the uploaderReady.
* @deprecated
*/
/*
* Fired when the mouse button is clicked on the Uploader's 'Browse' button.
*
* @event click
* @param event {Event} The event object for the click.
* @deprecated
*/
/*
* Fires when the user has finished selecting a set of files to be uploaded.
*
* @event fileselect
* @param event {Event} The event object for the fileSelect.
* <dl>
* <dt>fileList</dt>
* <dd>The file list Object with entries in the following format:
fileList[fileID] = {id: fileID, name: fileName, cDate: fileCDate, mDate: fileMDate, size: fileSize}</dd>
* </dl>
* @deprecated
*/
/*
* Fired when the mouse button is pressed on the Uploader's 'Browse' button.
*
* @event mousedown
* @param event {Event} The event object for the mousedown.
* @deprecated
*/
/*
* Fired when the mouse button is raised on the Uploader's 'Browse' button.
*
* @event mouseup
* @param event {Event} The event object for the mouseup.
* @deprecated
*/
/*
* Fired when the mouse leaves the Uploader's 'Browse' button.
*
* @event mouseleave
* @param event {Event} The event object for the mouseleave.
* @deprecated
*/
/*
* Fired when the mouse enters the Uploader's 'Browse' button.
*
* @event mouseenter
* @param event {Event} The event object for the mouseenter.
* @deprecated
*/
/*
* Announces that the uploader is ready and available for calling methods
* and setting properties
*
* @event uploadcancel
* @param event {Event} The event object for the uploaderReady.
* <dl>
* <dt>ddEvent</dt>
* <dd><code>drag:start</code> event from the thumb</dd>
* </dl>
* @deprecated
*/
/*
* Fires when a specific file's upload is cancelled.
*
* @event uploadcomplete
* @param event {Event} The event object for the uploadcancel.
* <dl>
* <dt>id</dt>
* <dd>The id of the file whose upload has been cancelled.</dd>
* </dl>
* @deprecated
*/
/*
* If the server has sent a response to the file upload, this event is
* fired and the response is added to its payload.
*
* @event uploadcompletedata
* @param event {Event} The event object for the uploadcompletedata.
* <dl>
* <dt>id</dt>
* <dd>The id of the file for which the response is being provided.</dd>
* <dt>data</dt>
* <dd>The content of the server response.</dd>
* </dl>
* @deprecated
*/
/*
* Provides error information if an error has occurred during the upload.
*
* @event uploaderror
* @param event {Event} The event object for the uploadeerror.
* <dl>
* <dt>id</dt>
* <dd>The id of the file for which the upload error has occurred.</dd>
* <dt>status</dt>
* <dd>Relevant error information.</dd>
* </dl>
* @deprecated
*/
/*
* Provides progress information on a specific file upload.
*
* @event uploadprogress
* @param event {Event} The event object for the uploadprogress.
* <dl>
* <dt>id</dt>
* <dd>The id of the file for which the progress information is being provided.</dd>
* <dt>bytesLoaded</dt>
* <dd>The number of bytes of the file that has been uploaded.</dd>
* <dt>bytesTotal</dt>
* <dd>The total number of bytes in the file that is being uploaded.</dd>
* </dl>
* @deprecated
*/
/*
* Announces that the upload has been started for a specific file.
*
* @event uploadstart
* @param event {Event} The event object for the uploadstart.
* <dl>
* <dt>id</dt>
* <dd>The id of the file whose upload has been started.</dd>
* </dl>
* @deprecated
*/
},
/*
* Removes a specific file from the upload queue.
*
* @method removeFile
* @param fileID {String} The ID of the file to be removed
* @return {Object} The updated file list, which is an object of the format:
* fileList[fileID] = {id: fileID, name: fileName, cDate: fileCDate, mDate: fileMDate, size: fileSize}
* @deprecated
*/
},
/*
* Clears the upload queue.
*
* @method clearFileList
* @return {Boolean} This method always returns true.
* @deprecated
*/
clearFileList : function () {
},
/*
* Starts the upload of a specific file.
*
* @method upload
* @param fileID {String} The ID of the file to be uploaded.
* @param url {String} The URL to upload the file to.
* @param method {String} (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)
* @param postVars {Object} (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.
* @param postFileVarName {String} (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)
* @return {Boolean} This method always returns true.
* @deprecated
*/
upload : function (fileID /*String*/, url /*String*/, method /*String*/, postVars /*Object*/, postFileVarName /*String*/) {
}
}
},
/*
* Starts the upload of a set of files, as specified in the first argument.
* The upload queue is managed automatically.
*
* @method uploadThese
* @param fileIDs {Array} The array of IDs of the files to be uploaded.
* @param url {String} The URL to upload the files to.
* @param method {String} (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)
* @param postVars {Object} (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.
* @param postFileVarName {String} (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)
* @deprecated
*/
uploadThese : function (fileIDs /*Array*/, url /*String*/, method /*String*/, postVars /*Object*/, postFileVarName /*String*/) {
},
/*
* Starts the upload of the files in the upload queue.
* The upload queue is managed automatically.
*
* @method uploadAll
* @param url {String} The URL to upload the files to.
* @param method {String} (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)
* @param postVars {Object} (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.
* @param postFileVarName {String} (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default).
* @deprecated
*/
uploadAll : function (url /*String*/, method /*String*/, postVars /*Object*/, postFileVarName /*String*/) {
},
/*
* Cancels the upload of a specific file, if currently in progress.
*
* @method cancel
* @param fileID {String} (optional) The ID of the file whose upload should be cancelled. If no ID is specified, all uploads are cancelled.
* @deprecated
*/
},
/*
* @private
* Setter for the 'log' property.
* @method setAllowLogging
* @param value {Boolean} The value for the 'log' property.
* @deprecated
*/
},
/*
* @private
* Setter for the 'multiFiles' property.
* @method setAllowMultipleFiles
* @param value {Boolean} The value for the 'multiFiles' property.
* @deprecated
*/
},
/*
* @private
* Setter for the 'simLimit' property.
* @method setSimUploadLimit
* @param value {Boolean} The value for the 'simLimit' property.
* @deprecated
*/
},
/*
* @private
* Setter for the 'fileFilters' property.
* @method setFileFilters
* @param value {Boolean} The value for the 'fileFilters' property.
* @deprecated
*/
},
/*
* 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.
*
* @method enable
* @deprecated
*/
enable : function () {
},
/*
* Disables the uploader user input (mouse clicks on the 'Browse' button). If the button skin
* is applied, the sprite is set to the 'disabled' state.
*
* @method enable
* @deprecated
*/
disable : function () {
},
/*
* @private
* Called when the uploader SWF is initialized
* @method _initializeUploader
* @param event {Object} The event to be propagated from Flash.
* @deprecated
*/
_initializeUploader: function (event) {
this.fire("uploaderReady", {});
},
/*
* @private
* Called when an event is dispatched from Uploader
* @method _relayEvent
* @param event {Object} The event to be propagated from Flash.
* @deprecated
*/
_relayEvent: function (event) {
},
toString: function()
{
return "Uploader " + this._id;
}
},
{
ATTRS: {
/*
* The flag that allows Flash player to
* output debug messages to its trace stack
* (if the Flash debug player is used).
*
* @attribute log
* @type {Boolean}
* @default false
* @deprecated
*/
log: {
value: false,
setter : "setAllowLogging"
},
/*
* The flag that allows the user to select
* more than one files during the 'Browse'
* dialog (using 'Shift' or 'Ctrl' keys).
*
* @attribute multiFiles
* @type {Boolean}
* @default false
* @deprecated
*/
multiFiles : {
value: false,
setter : "setAllowMultipleFiles"
},
/*
* 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
* and 5.
*
* @attribute simLimit
* @type {Number}
* @default 2
* @deprecated
*/
simLimit : {
value: 2,
setter : "setSimUploadLimit"
},
/*
* 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.
* Each item in the array must contain a 'description'
* property, and an 'extensions' property that must be
* in the form "*.ext;*.ext;*.ext;..."
*
* @attribute fileFilters
* @type {Array}
* @default []
* @deprecated
*/
fileFilters : {
value: [],
setter : "setFileFilters"
},
/*
* The Node containing the uploader's 'Browse' button.
*
* @attribute boundingBox
* @type {Node}
* @default null
* @writeOnce
* @deprecated
*/
boundingBox : {
value: null,
writeOnce: 'initOnly'
},
/*
* The URL of the image sprite for skinning the uploader's 'Browse' button.
*
* @attribute buttonSkin
* @type {String}
* @default null
* @writeOnce
* @deprecated
*/
buttonSkin : {
value: null,
writeOnce: 'initOnly'
},
/*
* The flag indicating whether the uploader is rendered
* with a transparent background.
*
* @attribute transparent
* @type {Boolean}
* @default true
* @writeOnce
* @deprecated
*/
transparent : {
value: true,
writeOnce: 'initOnly'
},
/*
* The URL of the uploader's SWF.
*
* @attribute swfURL
* @type {String}
* @default "assets/uploader.swf"
* @writeOnce
* @deprecated
*/
swfURL : {
writeOnce: 'initOnly'
}
}
}
);