UpdateManager.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:22k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.0.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.Updater
  9.  * @extends Ext.util.Observable
  10.  * Provides AJAX-style update capabilities for Element objects.  Updater can be used to {@link #update}
  11.  * an {@link Ext.Element} once, or you can use {@link #startAutoRefresh} to set up an auto-updating
  12.  * {@link Ext.Element Element} on a specific interval.<br><br>
  13.  * Usage:<br>
  14.  * <pre><code>
  15.  * var el = Ext.get("foo"); // Get Ext.Element object
  16.  * var mgr = el.getUpdater();
  17.  * mgr.update({
  18.         url: "http://myserver.com/index.php",
  19.         params: {
  20.             param1: "foo",
  21.             param2: "bar"
  22.         }
  23.  * });
  24.  * ...
  25.  * mgr.formUpdate("myFormId", "http://myserver.com/index.php");
  26.  * <br>
  27.  * // or directly (returns the same Updater instance)
  28.  * var mgr = new Ext.Updater("myElementId");
  29.  * mgr.startAutoRefresh(60, "http://myserver.com/index.php");
  30.  * mgr.on("update", myFcnNeedsToKnow);
  31.  * <br>
  32.  * // short handed call directly from the element object
  33.  * Ext.get("foo").load({
  34.         url: "bar.php",
  35.         scripts: true,
  36.         params: "param1=foo&amp;param2=bar",
  37.         text: "Loading Foo..."
  38.  * });
  39.  * </code></pre>
  40.  * @constructor
  41.  * Create new Updater directly.
  42.  * @param {Mixed} el The element to update
  43.  * @param {Boolean} forceNew (optional) By default the constructor checks to see if the passed element already
  44.  * has an Updater and if it does it returns the same instance. This will skip that check (useful for extending this class).
  45.  */
  46. Ext.UpdateManager = Ext.Updater = Ext.extend(Ext.util.Observable, 
  47. function() {
  48. var BEFOREUPDATE = "beforeupdate",
  49. UPDATE = "update",
  50. FAILURE = "failure";
  51. // private
  52.     function processSuccess(response){     
  53.     var me = this;
  54.         me.transaction = null;
  55.         if (response.argument.form && response.argument.reset) {
  56.             try { // put in try/catch since some older FF releases had problems with this
  57.                 response.argument.form.reset();
  58.             } catch(e){}
  59.         }
  60.         if (me.loadScripts) {
  61.             me.renderer.render(me.el, response, me,
  62.                updateComplete.createDelegate(me, [response]));
  63.         } else {
  64.             me.renderer.render(me.el, response, me);
  65.             updateComplete.call(me, response);
  66.         }
  67.     }
  68.     
  69.     // private
  70.     function updateComplete(response, type, success){
  71.         this.fireEvent(type || UPDATE, this.el, response);
  72.         if(Ext.isFunction(response.argument.callback)){
  73.             response.argument.callback.call(response.argument.scope, this.el, Ext.isEmpty(success) ? true : false, response, response.argument.options);
  74.         }
  75.     }
  76.     // private
  77.     function processFailure(response){             
  78.         updateComplete.call(this, response, FAILURE, !!(this.transaction = null));
  79.     }
  80.     
  81. return {
  82.     constructor: function(el, forceNew){
  83.     var me = this;
  84.         el = Ext.get(el);
  85.         if(!forceNew && el.updateManager){
  86.             return el.updateManager;
  87.         }
  88.         /**
  89.          * The Element object
  90.          * @type Ext.Element
  91.          */
  92.         me.el = el;
  93.         /**
  94.          * Cached url to use for refreshes. Overwritten every time update() is called unless "discardUrl" param is set to true.
  95.          * @type String
  96.          */
  97.         me.defaultUrl = null;
  98.         me.addEvents(
  99.             /**
  100.              * @event beforeupdate
  101.              * Fired before an update is made, return false from your handler and the update is cancelled.
  102.              * @param {Ext.Element} el
  103.              * @param {String/Object/Function} url
  104.              * @param {String/Object} params
  105.              */
  106.             BEFOREUPDATE,
  107.             /**
  108.              * @event update
  109.              * Fired after successful update is made.
  110.              * @param {Ext.Element} el
  111.              * @param {Object} oResponseObject The response Object
  112.              */
  113.             UPDATE,
  114.             /**
  115.              * @event failure
  116.              * Fired on update failure.
  117.              * @param {Ext.Element} el
  118.              * @param {Object} oResponseObject The response Object
  119.              */
  120.             FAILURE
  121.         );
  122.         Ext.apply(me, Ext.Updater.defaults);
  123.         /**
  124.          * Blank page URL to use with SSL file uploads (defaults to {@link Ext.Updater.defaults#sslBlankUrl}).
  125.          * @property sslBlankUrl
  126.          * @type String
  127.          */
  128.         /**
  129.          * Whether to append unique parameter on get request to disable caching (defaults to {@link Ext.Updater.defaults#disableCaching}).
  130.          * @property disableCaching
  131.          * @type Boolean
  132.          */
  133.         /**
  134.          * Text for loading indicator (defaults to {@link Ext.Updater.defaults#indicatorText}).
  135.          * @property indicatorText
  136.          * @type String
  137.          */
  138.         /**
  139.          * Whether to show indicatorText when loading (defaults to {@link Ext.Updater.defaults#showLoadIndicator}).
  140.          * @property showLoadIndicator
  141.          * @type String
  142.          */
  143.         /**
  144.          * Timeout for requests or form posts in seconds (defaults to {@link Ext.Updater.defaults#timeout}).
  145.          * @property timeout
  146.          * @type Number
  147.          */
  148.         /**
  149.          * True to process scripts in the output (defaults to {@link Ext.Updater.defaults#loadScripts}).
  150.          * @property loadScripts
  151.          * @type Boolean
  152.          */
  153.         /**
  154.          * Transaction object of the current executing transaction, or null if there is no active transaction.
  155.          */
  156.         me.transaction = null;
  157.         /**
  158.          * Delegate for refresh() prebound to "this", use myUpdater.refreshDelegate.createCallback(arg1, arg2) to bind arguments
  159.          * @type Function
  160.          */
  161.         me.refreshDelegate = me.refresh.createDelegate(me);
  162.         /**
  163.          * Delegate for update() prebound to "this", use myUpdater.updateDelegate.createCallback(arg1, arg2) to bind arguments
  164.          * @type Function
  165.          */
  166.         me.updateDelegate = me.update.createDelegate(me);
  167.         /**
  168.          * Delegate for formUpdate() prebound to "this", use myUpdater.formUpdateDelegate.createCallback(arg1, arg2) to bind arguments
  169.          * @type Function
  170.          */
  171.         me.formUpdateDelegate = (me.formUpdate || function(){}).createDelegate(me);
  172.         
  173. /**
  174.  * The renderer for this Updater (defaults to {@link Ext.Updater.BasicRenderer}).
  175.  */
  176.         me.renderer = me.renderer || me.getDefaultRenderer();
  177.         
  178.         Ext.Updater.superclass.constructor.call(me);
  179.     },
  180.         
  181. /**
  182.      * Sets the content renderer for this Updater. See {@link Ext.Updater.BasicRenderer#render} for more details.
  183.      * @param {Object} renderer The object implementing the render() method
  184.      */
  185.     setRenderer : function(renderer){
  186.         this.renderer = renderer;
  187.     },
  188.         
  189.     /**
  190.      * Returns the current content renderer for this Updater. See {@link Ext.Updater.BasicRenderer#render} for more details.
  191.      * @return {Object}
  192.      */
  193.     getRenderer : function(){
  194.        return this.renderer;
  195.     },
  196.     /**
  197.      * This is an overrideable method which returns a reference to a default
  198.      * renderer class if none is specified when creating the Ext.Updater.
  199.      * Defaults to {@link Ext.Updater.BasicRenderer}
  200.      */
  201.     getDefaultRenderer: function() {
  202.         return new Ext.Updater.BasicRenderer();
  203.     },
  204.                 
  205.     /**
  206.      * Sets the default URL used for updates.
  207.      * @param {String/Function} defaultUrl The url or a function to call to get the url
  208.      */
  209.     setDefaultUrl : function(defaultUrl){
  210.         this.defaultUrl = defaultUrl;
  211.     },
  212.         
  213.     /**
  214.      * Get the Element this Updater is bound to
  215.      * @return {Ext.Element} The element
  216.      */
  217.     getEl : function(){
  218.         return this.el;
  219.     },
  220. /**
  221.      * Performs an <b>asynchronous</b> request, updating this element with the response.
  222.      * If params are specified it uses POST, otherwise it uses GET.<br><br>
  223.      * <b>Note:</b> Due to the asynchronous nature of remote server requests, the Element
  224.      * will not have been fully updated when the function returns. To post-process the returned
  225.      * data, use the callback option, or an <b><tt>update</tt></b> event handler.
  226.      * @param {Object} options A config object containing any of the following options:<ul>
  227.      * <li>url : <b>String/Function</b><p class="sub-desc">The URL to request or a function which
  228.      * <i>returns</i> the URL (defaults to the value of {@link Ext.Ajax#url} if not specified).</p></li>
  229.      * <li>method : <b>String</b><p class="sub-desc">The HTTP method to
  230.      * use. Defaults to POST if the <tt>params</tt> argument is present, otherwise GET.</p></li>
  231.      * <li>params : <b>String/Object/Function</b><p class="sub-desc">The
  232.      * parameters to pass to the server (defaults to none). These may be specified as a url-encoded
  233.      * string, or as an object containing properties which represent parameters,
  234.      * or as a function, which returns such an object.</p></li>
  235.      * <li>scripts : <b>Boolean</b><p class="sub-desc">If <tt>true</tt>
  236.      * any &lt;script&gt; tags embedded in the response text will be extracted
  237.      * and executed (defaults to {@link Ext.Updater.defaults#loadScripts}). If this option is specified,
  238.      * the callback will be called <i>after</i> the execution of the scripts.</p></li>
  239.      * <li>callback : <b>Function</b><p class="sub-desc">A function to
  240.      * be called when the response from the server arrives. The following
  241.      * parameters are passed:<ul>
  242.      * <li><b>el</b> : Ext.Element<p class="sub-desc">The Element being updated.</p></li>
  243.      * <li><b>success</b> : Boolean<p class="sub-desc">True for success, false for failure.</p></li>
  244.      * <li><b>response</b> : XMLHttpRequest<p class="sub-desc">The XMLHttpRequest which processed the update.</p></li>
  245.      * <li><b>options</b> : Object<p class="sub-desc">The config object passed to the update call.</p></li></ul>
  246.      * </p></li>
  247.      * <li>scope : <b>Object</b><p class="sub-desc">The scope in which
  248.      * to execute the callback (The callback's <tt>this</tt> reference.) If the
  249.      * <tt>params</tt> argument is a function, this scope is used for that function also.</p></li>
  250.      * <li>discardUrl : <b>Boolean</b><p class="sub-desc">By default, the URL of this request becomes
  251.      * the default URL for this Updater object, and will be subsequently used in {@link #refresh}
  252.      * calls.  To bypass this behavior, pass <tt>discardUrl:true</tt> (defaults to false).</p></li>
  253.      * <li>timeout : <b>Number</b><p class="sub-desc">The number of seconds to wait for a response before
  254.      * timing out (defaults to {@link Ext.Updater.defaults#timeout}).</p></li>
  255.      * <li>text : <b>String</b><p class="sub-desc">The text to use as the innerHTML of the
  256.      * {@link Ext.Updater.defaults#indicatorText} div (defaults to 'Loading...').  To replace the entire div, not
  257.      * just the text, override {@link Ext.Updater.defaults#indicatorText} directly.</p></li>
  258.      * <li>nocache : <b>Boolean</b><p class="sub-desc">Only needed for GET
  259.      * requests, this option causes an extra, auto-generated parameter to be appended to the request
  260.      * to defeat caching (defaults to {@link Ext.Updater.defaults#disableCaching}).</p></li></ul>
  261.      * <p>
  262.      * For example:
  263. <pre><code>
  264. um.update({
  265.     url: "your-url.php",
  266.     params: {param1: "foo", param2: "bar"}, // or a URL encoded string
  267.     callback: yourFunction,
  268.     scope: yourObject, //(optional scope)
  269.     discardUrl: true,
  270.     nocache: true,
  271.     text: "Loading...",
  272.     timeout: 60,
  273.     scripts: false // Save time by avoiding RegExp execution.
  274. });
  275. </code></pre>
  276.      */
  277.     update : function(url, params, callback, discardUrl){
  278.     var me = this,
  279.      cfg, 
  280.      callerScope;
  281.     
  282.         if(me.fireEvent(BEFOREUPDATE, me.el, url, params) !== false){             
  283.             if(Ext.isObject(url)){ // must be config object
  284.                 cfg = url;
  285.                 url = cfg.url;
  286.                 params = params || cfg.params;
  287.                 callback = callback || cfg.callback;
  288.                 discardUrl = discardUrl || cfg.discardUrl;
  289.                 callerScope = cfg.scope;                 
  290.                 if(!Ext.isEmpty(cfg.nocache)){me.disableCaching = cfg.nocache;};
  291.                 if(!Ext.isEmpty(cfg.text)){me.indicatorText = '<div class="loading-indicator">'+cfg.text+"</div>";};
  292.                 if(!Ext.isEmpty(cfg.scripts)){me.loadScripts = cfg.scripts;};
  293.                 if(!Ext.isEmpty(cfg.timeout)){me.timeout = cfg.timeout;};
  294.             }
  295.             me.showLoading();
  296.             if(!discardUrl){
  297.                 me.defaultUrl = url;
  298.             }
  299.             if(Ext.isFunction(url)){
  300.                 url = url.call(me);
  301.             }
  302.             var o = Ext.apply({}, {
  303.                 url : url,
  304.                 params: (Ext.isFunction(params) && callerScope) ? params.createDelegate(callerScope) : params,
  305.                 success: processSuccess,
  306.                 failure: processFailure,
  307.                 scope: me,
  308.                 callback: undefined,
  309.                 timeout: (me.timeout*1000),
  310.                 disableCaching: me.disableCaching,
  311.                 argument: {
  312.                     "options": cfg,
  313.                     "url": url,
  314.                     "form": null,
  315.                     "callback": callback,
  316.                     "scope": callerScope || window,
  317.                     "params": params
  318.                 }
  319.             }, cfg);
  320.             me.transaction = Ext.Ajax.request(o);
  321.         }
  322.     },     
  323. /**
  324.      * <p>Performs an async form post, updating this element with the response. If the form has the attribute
  325.      * enctype="<a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form-data</a>", it assumes it's a file upload.
  326.      * Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning.</p>
  327.      * <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>
  328.      * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
  329.      * DOM <tt>&lt;form></tt> element temporarily modified to have its
  330.      * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
  331.      * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
  332.      * but removed after the return data has been gathered.</p>
  333.      * <p>Be aware that file upload packets, sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form-data</a>
  334.      * and some server technologies (notably JEE) may require some custom processing in order to
  335.      * retrieve parameter names and parameter values from the packet content.</p>
  336.      * @param {String/HTMLElement} form The form Id or form element
  337.      * @param {String} url (optional) The url to pass the form to. If omitted the action attribute on the form will be used.
  338.      * @param {Boolean} reset (optional) Whether to try to reset the form after the update
  339.      * @param {Function} callback (optional) Callback when transaction is complete. The following
  340.      * parameters are passed:<ul>
  341.      * <li><b>el</b> : Ext.Element<p class="sub-desc">The Element being updated.</p></li>
  342.      * <li><b>success</b> : Boolean<p class="sub-desc">True for success, false for failure.</p></li>
  343.      * <li><b>response</b> : XMLHttpRequest<p class="sub-desc">The XMLHttpRequest which processed the update.</p></li></ul>
  344.      */
  345.     formUpdate : function(form, url, reset, callback){
  346.     var me = this;
  347.         if(me.fireEvent(BEFOREUPDATE, me.el, form, url) !== false){
  348.             if(Ext.isFunction(url)){
  349.                 url = url.call(me);
  350.             }
  351.             form = Ext.getDom(form)
  352.             me.transaction = Ext.Ajax.request({
  353.                 form: form,
  354.                 url:url,
  355.                 success: processSuccess,
  356.                 failure: processFailure,
  357.                 scope: me,
  358.                 timeout: (me.timeout*1000),
  359.                 argument: {
  360.                     "url": url,
  361.                     "form": form,
  362.                     "callback": callback,
  363.                     "reset": reset
  364.                 }
  365.             });
  366.             me.showLoading.defer(1, me);
  367.         }
  368.     },
  369.                 
  370.     /**
  371.      * Set this element to auto refresh.  Can be canceled by calling {@link #stopAutoRefresh}.
  372.      * @param {Number} interval How often to update (in seconds).
  373.      * @param {String/Object/Function} url (optional) The url for this request, a config object in the same format
  374.      * supported by {@link #load}, or a function to call to get the url (defaults to the last used url).  Note that while
  375.      * the url used in a load call can be reused by this method, other load config options will not be reused and must be
  376.      * sepcified as part of a config object passed as this paramter if needed.
  377.      * @param {String/Object} params (optional) The parameters to pass as either a url encoded string
  378.      * "&param1=1&param2=2" or as an object {param1: 1, param2: 2}
  379.      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
  380.      * @param {Boolean} refreshNow (optional) Whether to execute the refresh now, or wait the interval
  381.      */
  382.     startAutoRefresh : function(interval, url, params, callback, refreshNow){
  383.     var me = this;
  384.         if(refreshNow){
  385.             me.update(url || me.defaultUrl, params, callback, true);
  386.         }
  387.         if(me.autoRefreshProcId){
  388.             clearInterval(me.autoRefreshProcId);
  389.         }
  390.         me.autoRefreshProcId = setInterval(me.update.createDelegate(me, [url || me.defaultUrl, params, callback, true]), interval * 1000);
  391.     },
  392.     /**
  393.      * Stop auto refresh on this element.
  394.      */
  395.     stopAutoRefresh : function(){
  396.         if(this.autoRefreshProcId){
  397.             clearInterval(this.autoRefreshProcId);
  398.             delete this.autoRefreshProcId;
  399.         }
  400.     },
  401.     /**
  402.      * Returns true if the Updater is currently set to auto refresh its content (see {@link #startAutoRefresh}), otherwise false.
  403.      */
  404.     isAutoRefreshing : function(){
  405.        return !!this.autoRefreshProcId;
  406.     },
  407.     /**
  408.      * Display the element's "loading" state. By default, the element is updated with {@link #indicatorText}. This
  409.      * method may be overridden to perform a custom action while this Updater is actively updating its contents.
  410.      */
  411.     showLoading : function(){
  412.         if(this.showLoadIndicator){
  413.              this.el.dom.innerHTML = this.indicatorText;
  414.         }
  415.     },
  416.     /**
  417.      * Aborts the currently executing transaction, if any.
  418.      */
  419.     abort : function(){
  420.         if(this.transaction){
  421.             Ext.Ajax.abort(this.transaction);
  422.         }
  423.     },
  424.     /**
  425.      * Returns true if an update is in progress, otherwise false.
  426.      * @return {Boolean}
  427.      */
  428.     isUpdating : function(){        
  429.      return this.transaction ? Ext.Ajax.isLoading(this.transaction) : false;        
  430.     },
  431.     
  432.     /**
  433.      * Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
  434.      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
  435.      */
  436.     refresh : function(callback){
  437.         if(this.defaultUrl){
  438.          this.update(this.defaultUrl, null, callback, true);
  439.      }
  440.     }
  441.     }
  442. }());
  443. /**
  444.  * @class Ext.Updater.defaults
  445.  * The defaults collection enables customizing the default properties of Updater
  446.  */
  447. Ext.Updater.defaults = {
  448.    /**
  449.      * Timeout for requests or form posts in seconds (defaults to 30 seconds).
  450.      * @type Number
  451.      */
  452.     timeout : 30,    
  453.     /**
  454.      * True to append a unique parameter to GET requests to disable caching (defaults to false).
  455.      * @type Boolean
  456.      */
  457.     disableCaching : false,
  458.     /**
  459.      * Whether or not to show {@link #indicatorText} during loading (defaults to true).
  460.      * @type Boolean
  461.      */
  462.     showLoadIndicator : true,
  463.     /**
  464.      * Text for loading indicator (defaults to '&lt;div class="loading-indicator"&gt;Loading...&lt;/div&gt;').
  465.      * @type String
  466.      */
  467.     indicatorText : '<div class="loading-indicator">Loading...</div>',
  468.      /**
  469.      * True to process scripts by default (defaults to false).
  470.      * @type Boolean
  471.      */
  472.     loadScripts : false,
  473.     /**
  474.     * Blank page URL to use with SSL file uploads (defaults to {@link Ext#SSL_SECURE_URL} if set, or "javascript:false").
  475.     * @type String
  476.     */
  477.     sslBlankUrl : (Ext.SSL_SECURE_URL || "javascript:false")      
  478. };
  479. /**
  480.  * Static convenience method. <b>This method is deprecated in favor of el.load({url:'foo.php', ...})</b>.
  481.  * Usage:
  482.  * <pre><code>Ext.Updater.updateElement("my-div", "stuff.php");</code></pre>
  483.  * @param {Mixed} el The element to update
  484.  * @param {String} url The url
  485.  * @param {String/Object} params (optional) Url encoded param string or an object of name/value pairs
  486.  * @param {Object} options (optional) A config object with any of the Updater properties you want to set - for
  487.  * example: {disableCaching:true, indicatorText: "Loading data..."}
  488.  * @static
  489.  * @deprecated
  490.  * @member Ext.Updater
  491.  */
  492. Ext.Updater.updateElement = function(el, url, params, options){
  493.     var um = Ext.get(el).getUpdater();
  494.     Ext.apply(um, options);
  495.     um.update(url, params, options ? options.callback : null);
  496. };
  497. /**
  498.  * @class Ext.Updater.BasicRenderer
  499.  * Default Content renderer. Updates the elements innerHTML with the responseText.
  500.  */
  501. Ext.Updater.BasicRenderer = function(){};
  502. Ext.Updater.BasicRenderer.prototype = {
  503.     /**
  504.      * This is called when the transaction is completed and it's time to update the element - The BasicRenderer
  505.      * updates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),
  506.      * create an object with a "render(el, response)" method and pass it to setRenderer on the Updater.
  507.      * @param {Ext.Element} el The element being rendered
  508.      * @param {Object} response The XMLHttpRequest object
  509.      * @param {Updater} updateManager The calling update manager
  510.      * @param {Function} callback A callback that will need to be called if loadScripts is true on the Updater
  511.      */
  512.      render : function(el, response, updateManager, callback){      
  513.         el.update(response.responseText, updateManager.loadScripts, callback);
  514.     }
  515. };