API Docs for: 3.8.0
Show:

File: uploader-deprecated/js/uploader-deprecated.js

  1. /**
  2.  * Attention: this is the 3.4.1 `uploader` module has been deprecated in favor of a new 
  3.  * uploader with an HTML5 layer. Please refer to the new Uploader User Guide for migration 
  4.  * information.
  5.  * 
  6.  * This module uses Flash player transport to upload files to the server, with support for 
  7.  * file filtering, multiple file uploads and progress monitoring.
  8.  * @module uploader-deprecated
  9.  * @deprecated
  10.  */
  11.         
  12. var Event = Y.Event,
  13.     Node = Y.Node;

  15. var SWFURL = Y.Env.cdn + "uploader-deprecated/assets/uploader.swf";

  17. /*
  18.  * <p><strong><span style="color:#ff0000;">Attention: this is the 3.4.1 uploader module, which has 
  19.  * been deprecated in favor of a new uploader with an HTML5 layer. Please refer to the new 
  20.  * Uploader User Guide for migration information.</span></strong></p>
  21.  * <p>The Uploader widget is a tool for uploading files to the server.</p>
  22.  * @module uploader-deprecated
  23.  * @title Uploader
  24.  * @requires base, node, event, swf
  25.  */

  27. /*
  28.  * <p><strong><span style="color:#ff0000;">Attention: this is the 3.4.1 uploader module, which has 
  29.  * been deprecated in favor of a new uploader with an HTML5 layer. Please refer to the new 
  30.  * Uploader User Guide for migration information.</span></strong></p>
  31.  * <p>Creates the Uploader instance and keeps the initialization data.</p>
  32.  *
  33.  * @class Uploader
  34.  * @extends Y.Base
  35.  * @constructor
  36.  * @param {Object} config (optional) Configuration parameters for the Uploader. The following parameters are available:
  37.  *        <dl>
  38.  *          <dt>boundingBox : String|Node (required)</dt>
  39.  *          <dd></dd>
  40.  *          <dt>buttonSkin : String (optional)</dt>
  41.  *          <dd></dd>
  42.  *          <dt>transparent : String (optional)</dt>
  43.  *          <dd></dd>
  44.  *          <dt>swfURL : String (optional)</dt>
  45.  *          <dd></dd>
  46.  *        </dl>
  47.  * @deprecated
  48.  */
  49.                                 
  50. function Uploader (config /*Object*/) {
  51.         
  52.         Uploader.superclass.constructor.apply(this, arguments);

  54.         if (config.hasOwnProperty("boundingBox")) {
  55.                 this.set("boundingBox", config.boundingBox);
  56.         };

  58.         if (config.hasOwnProperty("buttonSkin")) {
  59.                 this.set("buttonSkin", config.buttonSkin);
  60.         };
  61.         if (config.hasOwnProperty("transparent")) {
  62.                 this.set("transparent", config.transparent);
  63.         };
  64.         if (config.hasOwnProperty("swfURL")) {
  65.                 this.set("swfURL", config.swfURL);
  66.         };
  67. };


  70. Y.extend(Uploader, Y.Base, {
  71.         
  72.    /*
  73.     * The reference to the instance of Y.SWF that encapsulates the instance of the Flash player with uploader logic.
  74.     *
  75.     * @private
  76.     * @property uploaderswf
  77.     * @type {SWF}
  78.     * @default null
  79.     * @deprecated
  80.     */
  81.         uploaderswf:null,

  83.    /*
  84.     * The id of this instance of uploader.
  85.     *
  86.     * @private
  87.     * @property _id
  88.     * @type {String}
  89.     * @deprecated
  90.     */
  91.         _id:"",

  93.    /*
  94.     * Construction logic executed during Uploader instantiation.
  95.     *
  96.     * @method initializer
  97.     * @protected
  98.     * @deprecated
  99.     */
  100.         initializer : function () {
  101.                 
  102.         this._id = Y.guid("uploader");
  103.     var oElement = Node.one(this.get("boundingBox"));

  105.         var params = {version: "10.0.45",
  106.                           fixedAttributes: {allowScriptAccess:"always", allowNetworking:"all", scale: "noscale"},
  107.                       flashVars: {}};

  109.         if (this.get("buttonSkin") != "") {
  110.                 params.flashVars["buttonSkin"] = this.get("buttonSkin");
  111.         }
  112.         if (this.get("transparent")) {
  113.                 params.fixedAttributes["wmode"] = "transparent";
  114.         }

  116.     this.uploaderswf = new Y.SWF(oElement, this.get("swfURL"), params);

  118.         var upswf = this.uploaderswf;
  119.         var relEvent = Y.bind(this._relayEvent, this);

  121.         /*
  122.         * Announces that the uploader is ready and available for calling methods
  123.         * and setting properties
  124.         *
  125.         * @event uploaderReady
  126.         * @param event {Event} The event object for the uploaderReady.
  127.     * @deprecated
  128.     */
  129.         upswf.on ("swfReady", Y.bind(this._initializeUploader, this));
  130.         
  131.         /*
  132.         * Fired when the mouse button is clicked on the Uploader's 'Browse' button.
  133.         *
  134.         * @event click
  135.         * @param event {Event} The event object for the click.
  136.     * @deprecated
  137.     */
  138.         upswf.on ("click", relEvent);

  140.         /*
  141.         * Fires when the user has finished selecting a set of files to be uploaded.
  142.         *
  143.         * @event fileselect
  144.         * @param event {Event} The event object for the fileSelect.
  145.         *  <dl>
  146.         *      <dt>fileList</dt>
  147.         *          <dd>The file list Object with entries in the following format: 
  148.                        fileList[fileID] = {id: fileID, name: fileName, cDate: fileCDate, mDate: fileMDate, size: fileSize}</dd>
  149.         *  </dl>
  150.     * @deprecated
  151.     */
  152.         upswf.on ("fileselect", relEvent);

  154.         /*
  155.         * Fired when the mouse button is pressed on the Uploader's 'Browse' button.
  156.         *
  157.         * @event mousedown
  158.         * @param event {Event} The event object for the mousedown.
  159.     * @deprecated
  160.     */
  161.         upswf.on ("mousedown", relEvent);

  163.         /*
  164.         * Fired when the mouse button is raised on the Uploader's 'Browse' button.
  165.         *
  166.         * @event mouseup
  167.         * @param event {Event} The event object for the mouseup.
  168.     * @deprecated
  169.     */
  170.         upswf.on ("mouseup", relEvent);

  172.         /*
  173.         * Fired when the mouse leaves the Uploader's 'Browse' button.
  174.         *
  175.         * @event mouseleave
  176.         * @param event {Event} The event object for the mouseleave.
  177.     * @deprecated
  178.     */
  179.         upswf.on ("mouseleave", relEvent);

  181.         /*
  182.         * Fired when the mouse enters the Uploader's 'Browse' button.
  183.         *
  184.         * @event mouseenter
  185.         * @param event {Event} The event object for the mouseenter.
  186.     * @deprecated
  187.     */
  188.         upswf.on ("mouseenter", relEvent);

  190.         /*
  191.         * Announces that the uploader is ready and available for calling methods
  192.         * and setting properties
  193.         *
  194.         * @event uploadcancel
  195.         * @param event {Event} The event object for the uploaderReady.
  196.         *  <dl>
  197.         *      <dt>ddEvent</dt>
  198.         *          <dd><code>drag:start</code> event from the thumb</dd>
  199.         *  </dl>
  200.     * @deprecated
  201.     */
  202.         upswf.on ("uploadcancel", relEvent);

  204.         /*
  205.         * Fires when a specific file's upload is cancelled.
  206.         *
  207.         * @event uploadcomplete
  208.         * @param event {Event} The event object for the uploadcancel.
  209.         *  <dl>
  210.         *      <dt>id</dt>
  211.         *          <dd>The id of the file whose upload has been cancelled.</dd>
  212.         *  </dl>
  213.     * @deprecated
  214.     */
  215.         upswf.on ("uploadcomplete", relEvent);

  217.         /*
  218.         * If the server has sent a response to the file upload, this event is
  219.         * fired and the response is added to its payload.
  220.         *
  221.         * @event uploadcompletedata
  222.         * @param event {Event} The event object for the uploadcompletedata.
  223.         *  <dl>
  224.         *      <dt>id</dt>
  225.         *          <dd>The id of the file for which the response is being provided.</dd>
  226.         *      <dt>data</dt>
  227.         *          <dd>The content of the server response.</dd>
  228.         *  </dl>
  229.     * @deprecated
  230.     */
  231.         upswf.on ("uploadcompletedata", relEvent);

  233.         /*
  234.         * Provides error information if an error has occurred during the upload.
  235.         *
  236.         * @event uploaderror
  237.         * @param event {Event} The event object for the uploadeerror.
  238.         *  <dl>
  239.         *      <dt>id</dt>
  240.         *          <dd>The id of the file for which the upload error has occurred.</dd>
  241.         *      <dt>status</dt>
  242.         *          <dd>Relevant error information.</dd>
  243.         *  </dl>
  244.     * @deprecated
  245.     */
  246.         upswf.on ("uploaderror", relEvent);

  248.         /*
  249.         * Provides progress information on a specific file upload.
  250.         *
  251.         * @event uploadprogress
  252.         * @param event {Event} The event object for the uploadprogress.
  253.         *  <dl>
  254.         *      <dt>id</dt>
  255.         *          <dd>The id of the file for which the progress information is being provided.</dd>
  256.         *      <dt>bytesLoaded</dt>
  257.         *          <dd>The number of bytes of the file that has been uploaded.</dd>
  258.         *      <dt>bytesTotal</dt>
  259.         *          <dd>The total number of bytes in the file that is being uploaded.</dd>
  260.         *  </dl>
  261.     * @deprecated
  262.     */
  263.         upswf.on ("uploadprogress", relEvent);

  265.         /*
  266.         * Announces that the upload has been started for a specific file.
  267.         *
  268.         * @event uploadstart
  269.         * @param event {Event} The event object for the uploadstart.
  270.         *  <dl>
  271.         *      <dt>id</dt>
  272.         *          <dd>The id of the file whose upload has been started.</dd>
  273.         *  </dl>
  274.     * @deprecated
  275.     */ 
  276.         upswf.on ("uploadstart", relEvent);
  277.         },

  279.    /*
  280.     * Removes a specific file from the upload queue.
  281.     *
  282.     * @method removeFile
  283.     * @param fileID {String} The ID of the file to be removed
  284.     * @return {Object} The updated file list, which is an object of the format:
  285.     * fileList[fileID] = {id: fileID, name: fileName, cDate: fileCDate, mDate: fileMDate, size: fileSize}
  286.     * @deprecated
  287.     */
  288.         removeFile : function (fileID /*String*/) {
  289.                 return this.uploaderswf.callSWF("removeFile", [fileID]);
  290.         },
  291.         
  292.    /*
  293.     * Clears the upload queue.
  294.     *
  295.     * @method clearFileList
  296.     * @return {Boolean} This method always returns true.
  297.     * @deprecated
  298.     */
  299.         clearFileList : function () {
  300.                 return this.uploaderswf.callSWF("clearFileList", []);
  301.         },

  303.    /*
  304.     * Starts the upload of a specific file.
  305.     *
  306.     * @method upload
  307.     * @param fileID {String} The ID of the file to be uploaded.
  308.     * @param url {String} The URL to upload the file to.
  309.     * @param method {String} (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)
  310.         * @param postVars {Object} (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.
  311.         * @param postFileVarName {String} (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)
  312.     * @return {Boolean} This method always returns true.
  313.     * @deprecated
  314.     */
  315.         upload : function (fileID /*String*/, url /*String*/, method /*String*/, postVars /*Object*/, postFileVarName /*String*/) {
  316.             if (Y.Lang.isArray(fileID)) {
  317.                         return this.uploaderswf.callSWF("uploadThese", [fileID, url, method, postVars, postFileVarName]);
  318.                 }
  319.                 else if (Y.Lang.isString(fileID)) {
  320.                         return this.uploaderswf.callSWF("upload", [fileID, url, method, postVars, postFileVarName]);
  321.                         
  322.                 }
  323.         },

  325.    /*
  326.     * Starts the upload of a set of files, as specified in the first argument. 
  327.     * The upload queue is managed automatically.
  328.     *
  329.     * @method uploadThese
  330.     * @param fileIDs {Array} The array of IDs of the files to be uploaded.
  331.     * @param url {String} The URL to upload the files to.
  332.     * @param method {String} (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)
  333.         * @param postVars {Object} (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.
  334.         * @param postFileVarName {String} (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)
  335.     * @deprecated
  336.     */
  337.         uploadThese : function (fileIDs /*Array*/, url /*String*/, method /*String*/, postVars /*Object*/, postFileVarName /*String*/) {
  338.                 return this.uploaderswf.callSWF("uploadThese", [fileIDs, url, method, postVars, postFileVarName]);
  339.         },

  341.    /*
  342.     * Starts the upload of the files in the upload queue. 
  343.     * The upload queue is managed automatically.
  344.     *
  345.     * @method uploadAll
  346.     * @param url {String} The URL to upload the files to.
  347.     * @param method {String} (optional) The HTTP method to use for sending additional variables, either 'GET' or 'POST' ('GET' by default)
  348.         * @param postVars {Object} (optional) A set of key-value pairs to send as variables along with the file upload HTTP request.
  349.         * @param postFileVarName {String} (optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default).
  350.     * @deprecated
  351.     */  
  352.         uploadAll : function (url /*String*/, method /*String*/, postVars /*Object*/, postFileVarName /*String*/) {
  353.                 return this.uploaderswf.callSWF("uploadAll", [url, method, postVars,postFileVarName]);
  354.         },

  356.    /*
  357.     * Cancels the upload of a specific file, if currently in progress.
  358.     *
  359.     * @method cancel
  360.     * @param fileID {String} (optional) The ID of the file whose upload should be cancelled. If no ID is specified, all uploads are cancelled.
  361.     * @deprecated
  362.     */  
  363.         cancel : function (fileID /*String*/) {
  364.                 return this.uploaderswf.callSWF("cancel", [fileID]);
  365.         },

  367.         /*
  368.          * @private
  369.          * Setter for the 'log' property.
  370.          * @method setAllowLogging
  371.          * @param value {Boolean} The value for the 'log' property.
  372.      * @deprecated
  373.          */
  374.         setAllowLogging : function (value /*Boolean*/) {
  375.                 this.uploaderswf.callSWF("setAllowLogging", [value]);
  376.         },

  378.         /*
  379.          * @private
  380.          * Setter for the 'multiFiles' property.
  381.          * @method setAllowMultipleFiles
  382.          * @param value {Boolean} The value for the 'multiFiles' property.
  383.      * @deprecated
  384.          */
  385.         setAllowMultipleFiles : function (value /*Boolean*/) {
  386.                 this.uploaderswf.callSWF("setAllowMultipleFiles", [value]);
  387.         },

  389.         /*
  390.          * @private
  391.          * Setter for the 'simLimit' property.
  392.          * @method setSimUploadLimit
  393.          * @param value {Boolean} The value for the 'simLimit' property.
  394.      * @deprecated
  395.          */
  396.         setSimUploadLimit : function (value /*int*/) {
  397.                 this.uploaderswf.callSWF("setSimUploadLimit", [value]);
  398.         },

  400.         /*
  401.          * @private
  402.          * Setter for the 'fileFilters' property.
  403.          * @method setFileFilters
  404.          * @param value {Boolean} The value for the 'fileFilters' property.
  405.      * @deprecated
  406.          */     
  407.         setFileFilters : function (fileFilters /*Array*/) {
  408.                 this.uploaderswf.callSWF("setFileFilters", [fileFilters]);
  409.         },

  411.    /*
  412.     * Enables the uploader user input (mouse clicks on the 'Browse' button). If the button skin 
  413.     * is applied, the sprite is reset from the "disabled" state.
  414.     *
  415.     * @method enable
  416.     * @deprecated
  417.     */  
  418.         enable : function () {
  419.                 this.uploaderswf.callSWF("enable");
  420.         },

  422.    /*
  423.     * Disables the uploader user input (mouse clicks on the 'Browse' button). If the button skin 
  424.     * is applied, the sprite is set to the 'disabled' state.
  425.     *
  426.     * @method enable
  427.     * @deprecated
  428.     */  
  429.         disable : function () {
  430.                 this.uploaderswf.callSWF("disable");
  431.         },

  433.         /*
  434.          * @private
  435.          * Called when the uploader SWF is initialized
  436.          * @method _initializeUploader
  437.          * @param event {Object} The event to be propagated from Flash.
  438.      * @deprecated
  439.          */
  440.         _initializeUploader: function (event) {
  441.                         this.publish("uploaderReady", {fireOnce:true});
  442.                 this.fire("uploaderReady", {});
  443.         },

  445.         /*
  446.          * @private
  447.          * Called when an event is dispatched from Uploader
  448.          * @method _relayEvent
  449.          * @param event {Object} The event to be propagated from Flash.
  450.      * @deprecated
  451.          */     
  452.         _relayEvent: function (event) {
  453.                     Y.log("Firing event...");
  454.                     Y.log(event.type);
  455.                     this.fire(event.type, event);
  456.         },
  457.         
  458.         toString: function()
  459.         {
  460.                 return "Uploader " + this._id;
  461.         }

  463. },
  464. {
  465.         ATTRS: {
  466.         /*
  467.          * The flag that allows Flash player to 
  468.          * output debug messages to its trace stack 
  469.          * (if the Flash debug player is used).
  470.          *
  471.          * @attribute log
  472.          * @type {Boolean}
  473.          * @default false
  474.          * @deprecated
  475.          */
  476.                 log: {
  477.                         value: false,
  478.                         setter : "setAllowLogging"
  479.                 },

  481.         /*
  482.          * The flag that allows the user to select
  483.          * more than one files during the 'Browse'
  484.          * dialog (using 'Shift' or 'Ctrl' keys).
  485.          *
  486.          * @attribute multiFiles
  487.          * @type {Boolean}
  488.          * @default false
  489.          * @deprecated
  490.          */
  491.                 multiFiles : {
  492.                         value: false,
  493.                         setter : "setAllowMultipleFiles"
  494.                 },
  495.         
  496.         /*
  497.          * The number of files that can be uploaded
  498.          * simultaneously if the automatic queue management
  499.          * is used. This value can be in the range between 2
  500.          * and 5.
  501.          *
  502.          * @attribute simLimit
  503.          * @type {Number}
  504.          * @default 2
  505.          * @deprecated
  506.          */
  507.                 simLimit : {
  508.                         value: 2,
  509.                         setter : "setSimUploadLimit"
  510.                 },

  512.         /*
  513.          * The array of filters on file extensions for
  514.          * the 'Browse' dialog. These filters only provide
  515.          * convenience for the user and do not strictly
  516.          * limit the selection to certain file extensions.
  517.          * Each item in the array must contain a 'description'
  518.          * property, and an 'extensions' property that must be
  519.          * in the form "*.ext;*.ext;*.ext;..."
  520.          *
  521.          * @attribute fileFilters
  522.          * @type {Array}
  523.          * @default []
  524.          * @deprecated
  525.          */
  526.                 fileFilters : {
  527.                         value: [],
  528.                         setter : "setFileFilters"
  529.                 },
  530.                 
  531.         /*
  532.          * The Node containing the uploader's 'Browse' button.
  533.          *
  534.          * @attribute boundingBox
  535.          * @type {Node}
  536.          * @default null
  537.          * @writeOnce
  538.          * @deprecated
  539.          */
  540.                 boundingBox : {
  541.                         value: null,
  542.                         writeOnce: 'initOnly'
  543.                 },
  544.                 
  545.         /*
  546.          * The URL of the image sprite for skinning the uploader's 'Browse' button.
  547.          *
  548.          * @attribute buttonSkin
  549.          * @type {String}
  550.          * @default null
  551.          * @writeOnce
  552.          * @deprecated
  553.          */
  554.                 buttonSkin : {
  555.                         value: null,
  556.                         writeOnce: 'initOnly'
  557.                 },
  558.                 
  559.         /*
  560.          * The flag indicating whether the uploader is rendered 
  561.          * with a transparent background.
  562.          *
  563.          * @attribute transparent
  564.          * @type {Boolean}
  565.          * @default true
  566.          * @writeOnce
  567.          * @deprecated
  568.          */
  569.                 transparent : {
  570.                         value: true,
  571.                         writeOnce: 'initOnly'
  572.                 },
  573.                 
  574.         /*
  575.          * The URL of the uploader's SWF.
  576.          *
  577.          * @attribute swfURL
  578.          * @type {String}
  579.          * @default "assets/uploader.swf"
  580.          * @writeOnce
  581.          * @deprecated
  582.          */
  583.                 swfURL : {
  584.                         value : SWFURL,
  585.                         writeOnce: 'initOnly'
  586.                 }
  587.                 
  588.         }
  589. }
  590. );
  591. Y.Uploader = Uploader;
  592.