git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Batch.html
diff --git a/docs/source/Batch.html b/docs/source/Batch.html
index 4931c0d..ac4399f 100644 (file)
--- a/docs/source/Batch.html
+++ b/docs/source/Batch.html
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
@@ -18,75 +18,68 @@
   <pre class="prettyprint lang-js"><span id='Ext-data-Batch'>/**
 </span> * @author Ed Spencer
  * @class Ext.data.Batch
   <pre class="prettyprint lang-js"><span id='Ext-data-Batch'>/**
 </span> * @author Ed Spencer
  * @class Ext.data.Batch
- * 
+ *
  * &lt;p&gt;Provides a mechanism to run one or more {@link Ext.data.Operation operations} in a given order. Fires the 'operationcomplete' event
  * after the completion of each Operation, and the 'complete' event when all Operations have been successfully executed. Fires an 'exception'
  * event if any of the Operations encounter an exception.&lt;/p&gt;
  * &lt;p&gt;Provides a mechanism to run one or more {@link Ext.data.Operation operations} in a given order. Fires the 'operationcomplete' event
  * after the completion of each Operation, and the 'complete' event when all Operations have been successfully executed. Fires an 'exception'
  * event if any of the Operations encounter an exception.&lt;/p&gt;
- * 
+ *
  * &lt;p&gt;Usually these are only used internally by {@link Ext.data.proxy.Proxy} classes&lt;/p&gt;
  * &lt;p&gt;Usually these are only used internally by {@link Ext.data.proxy.Proxy} classes&lt;/p&gt;
- * 
+ *
  */
 Ext.define('Ext.data.Batch', {
     mixins: {
         observable: 'Ext.util.Observable'
     },
  */
 Ext.define('Ext.data.Batch', {
     mixins: {
         observable: 'Ext.util.Observable'
     },
-    
+
 <span id='Ext-data-Batch-property-autoStart'>    /**
 <span id='Ext-data-Batch-property-autoStart'>    /**
-</span>     * True to immediately start processing the batch as soon as it is constructed (defaults to false)
-     * @property autoStart
-     * @type Boolean
+</span>     * @property {Boolean} autoStart
+     * True to immediately start processing the batch as soon as it is constructed.
      */
     autoStart: false,
      */
     autoStart: false,
-    
+
 <span id='Ext-data-Batch-property-current'>    /**
 <span id='Ext-data-Batch-property-current'>    /**
-</span>     * The index of the current operation being executed
-     * @property current
-     * @type Number
+</span>     * @property {Number} current
+     * The index of the current operation being executed
      */
     current: -1,
      */
     current: -1,
-    
+
 <span id='Ext-data-Batch-property-total'>    /**
 <span id='Ext-data-Batch-property-total'>    /**
-</span>     * The total number of operations in this batch. Read only
-     * @property total
-     * @type Number
+</span>     * @property {Number} total
+     * The total number of operations in this batch. Read only
      */
     total: 0,
      */
     total: 0,
-    
+
 <span id='Ext-data-Batch-property-isRunning'>    /**
 <span id='Ext-data-Batch-property-isRunning'>    /**
-</span>     * True if the batch is currently running
-     * @property isRunning
-     * @type Boolean
+</span>     * @property {Boolean} isRunning
+     * True if the batch is currently running
      */
     isRunning: false,
      */
     isRunning: false,
-    
+
 <span id='Ext-data-Batch-property-isComplete'>    /**
 <span id='Ext-data-Batch-property-isComplete'>    /**
-</span>     * True if this batch has been executed completely
-     * @property isComplete
-     * @type Boolean
+</span>     * @property {Boolean} isComplete
+     * True if this batch has been executed completely
      */
     isComplete: false,
      */
     isComplete: false,
-    
+
 <span id='Ext-data-Batch-property-hasException'>    /**
 <span id='Ext-data-Batch-property-hasException'>    /**
-</span>     * True if this batch has encountered an exception. This is cleared at the start of each operation
-     * @property hasException
-     * @type Boolean
+</span>     * @property {Boolean} hasException
+     * True if this batch has encountered an exception. This is cleared at the start of each operation
      */
     hasException: false,
      */
     hasException: false,
-    
+
 <span id='Ext-data-Batch-property-pauseOnException'>    /**
 <span id='Ext-data-Batch-property-pauseOnException'>    /**
-</span>     * True to automatically pause the execution of the batch if any operation encounters an exception (defaults to true)
-     * @property pauseOnException
-     * @type Boolean
+</span>     * @property {Boolean} pauseOnException
+     * True to automatically pause the execution of the batch if any operation encounters an exception
      */
     pauseOnException: true,
      */
     pauseOnException: true,
-    
+
 <span id='Ext-data-Batch-method-constructor'>    /**
 </span>     * Creates new Batch object.
 <span id='Ext-data-Batch-method-constructor'>    /**
 </span>     * Creates new Batch object.
-     * @param {Object} config (optional) Config object
+     * @param {Object} [config] Config object
      */
      */
-    constructor: function(config) {   
+    constructor: function(config) {
         var me = this;
         var me = this;
-                     
+
         me.addEvents(
 <span id='Ext-data-Batch-event-complete'>          /**
 </span>           * @event complete
         me.addEvents(
 <span id='Ext-data-Batch-event-complete'>          /**
 </span>           * @event complete
@@ -95,7 +88,7 @@ Ext.define('Ext.data.Batch', {
            * @param {Object} operation The last operation that was executed
            */
           'complete',
            * @param {Object} operation The last operation that was executed
            */
           'complete',
-          
+
 <span id='Ext-data-Batch-event-exception'>          /**
 </span>           * @event exception
            * Fired when a operation encountered an exception
 <span id='Ext-data-Batch-event-exception'>          /**
 </span>           * @event exception
            * Fired when a operation encountered an exception
@@ -103,7 +96,7 @@ Ext.define('Ext.data.Batch', {
            * @param {Object} operation The operation that encountered the exception
            */
           'exception',
            * @param {Object} operation The operation that encountered the exception
            */
           'exception',
-          
+
 <span id='Ext-data-Batch-event-operationcomplete'>          /**
 </span>           * @event operationcomplete
            * Fired when each operation of the batch completes
 <span id='Ext-data-Batch-event-operationcomplete'>          /**
 </span>           * @event operationcomplete
            * Fired when each operation of the batch completes
@@ -112,29 +105,28 @@ Ext.define('Ext.data.Batch', {
            */
           'operationcomplete'
         );
            */
           'operationcomplete'
         );
-        
+
         me.mixins.observable.constructor.call(me, config);
         me.mixins.observable.constructor.call(me, config);
-        
+
 <span id='Ext-data-Batch-property-operations'>        /**
 </span>         * Ordered array of operations that will be executed by this batch
 <span id='Ext-data-Batch-property-operations'>        /**
 </span>         * Ordered array of operations that will be executed by this batch
-         * @property operations
-         * @type Array
+         * @property {Ext.data.Operation[]} operations
          */
         me.operations = [];
     },
          */
         me.operations = [];
     },
-    
+
 <span id='Ext-data-Batch-method-add'>    /**
 </span>     * Adds a new operation to this batch
      * @param {Object} operation The {@link Ext.data.Operation Operation} object
      */
     add: function(operation) {
         this.total++;
 <span id='Ext-data-Batch-method-add'>    /**
 </span>     * Adds a new operation to this batch
      * @param {Object} operation The {@link Ext.data.Operation Operation} object
      */
     add: function(operation) {
         this.total++;
-        
+
         operation.setBatch(this);
         operation.setBatch(this);
-        
+
         this.operations.push(operation);
     },
         this.operations.push(operation);
     },
-    
+
 <span id='Ext-data-Batch-method-start'>    /**
 </span>     * Kicks off the execution of the batch, continuing from the next operation if the previous
      * operation encountered an exception, or if execution was paused
 <span id='Ext-data-Batch-method-start'>    /**
 </span>     * Kicks off the execution of the batch, continuing from the next operation if the previous
      * operation encountered an exception, or if execution was paused
@@ -142,10 +134,10 @@ Ext.define('Ext.data.Batch', {
     start: function() {
         this.hasException = false;
         this.isRunning = true;
     start: function() {
         this.hasException = false;
         this.isRunning = true;
-        
+
         this.runNextOperation();
     },
         this.runNextOperation();
     },
-    
+
 <span id='Ext-data-Batch-method-runNextOperation'>    /**
 </span>     * @private
      * Runs the next operation, relative to this.current.
 <span id='Ext-data-Batch-method-runNextOperation'>    /**
 </span>     * @private
      * Runs the next operation, relative to this.current.
@@ -153,14 +145,14 @@ Ext.define('Ext.data.Batch', {
     runNextOperation: function() {
         this.runOperation(this.current + 1);
     },
     runNextOperation: function() {
         this.runOperation(this.current + 1);
     },
-    
+
 <span id='Ext-data-Batch-method-pause'>    /**
 </span>     * Pauses execution of the batch, but does not cancel the current operation
      */
     pause: function() {
         this.isRunning = false;
     },
 <span id='Ext-data-Batch-method-pause'>    /**
 </span>     * Pauses execution of the batch, but does not cancel the current operation
      */
     pause: function() {
         this.isRunning = false;
     },
-    
+
 <span id='Ext-data-Batch-method-runOperation'>    /**
 </span>     * Executes a operation by its numeric index
      * @param {Number} index The operation index to run
 <span id='Ext-data-Batch-method-runOperation'>    /**
 </span>     * Executes a operation by its numeric index
      * @param {Number} index The operation index to run
@@ -170,17 +162,17 @@ Ext.define('Ext.data.Batch', {
             operations = me.operations,
             operation  = operations[index],
             onProxyReturn;
             operations = me.operations,
             operation  = operations[index],
             onProxyReturn;
-        
+
         if (operation === undefined) {
             me.isRunning  = false;
             me.isComplete = true;
             me.fireEvent('complete', me, operations[operations.length - 1]);
         } else {
             me.current = index;
         if (operation === undefined) {
             me.isRunning  = false;
             me.isComplete = true;
             me.fireEvent('complete', me, operations[operations.length - 1]);
         } else {
             me.current = index;
-            
+
             onProxyReturn = function(operation) {
                 var hasException = operation.hasException();
             onProxyReturn = function(operation) {
                 var hasException = operation.hasException();
-                
+
                 if (hasException) {
                     me.hasException = true;
                     me.fireEvent('exception', me, operation);
                 if (hasException) {
                     me.hasException = true;
                     me.fireEvent('exception', me, operation);
@@ -195,9 +187,9 @@ Ext.define('Ext.data.Batch', {
                     me.runNextOperation();
                 }
             };
                     me.runNextOperation();
                 }
             };
-            
+
             operation.setStarted();
             operation.setStarted();
-            
+
             me.proxy[operation.action](operation, onProxyReturn, me);
         }
     }
             me.proxy[operation.action](operation, onProxyReturn, me);
         }
     }
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.