X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..refs/heads/master:/docs/source/PollingProvider.html diff --git a/docs/source/PollingProvider.html b/docs/source/PollingProvider.html index a6655582..a70c65f7 100644 --- a/docs/source/PollingProvider.html +++ b/docs/source/PollingProvider.html @@ -1,4 +1,21 @@ -
/**
+
+
+
+
+ The source code
+
+
+
+
+
+
+ /**
* @class Ext.direct.PollingProvider
* @extends Ext.direct.JsonProvider
*
@@ -43,19 +60,18 @@ Ext.define('Ext.direct.PollingProvider', {
/* End Definitions */
- /**
+ /**
* @cfg {Number} interval
- * How often to poll the server-side in milliseconds (defaults to <tt>3000</tt> - every
- * 3 seconds).
+ * How often to poll the server-side in milliseconds. Defaults to every 3 seconds.
*/
interval: 3000,
- /**
- * @cfg {Object} baseParams An object containing properties which are to be sent as parameters
- * on every polling request
+ /**
+ * @cfg {Object} baseParams
+ * An object containing properties which are to be sent as parameters on every polling request
*/
- /**
+ /**
* @cfg {String/Function} url
* The url which the PollingProvider should contact with each request. This can also be
* an imported Ext.Direct method which will accept the baseParams as its only argument.
@@ -65,17 +81,17 @@ Ext.define('Ext.direct.PollingProvider', {
constructor : function(config){
this.callParent(arguments);
this.addEvents(
- /**
+ /**
* @event beforepoll
* Fired immediately before a poll takes place, an event handler can return false
* in order to cancel the poll.
- * @param {Ext.direct.PollingProvider}
+ * @param {Ext.direct.PollingProvider} this
*/
'beforepoll',
- /**
+ /**
* @event poll
* This event has not yet been implemented.
- * @param {Ext.direct.PollingProvider}
+ * @param {Ext.direct.PollingProvider} this
*/
'poll'
);
@@ -86,7 +102,7 @@ Ext.define('Ext.direct.PollingProvider', {
return !!this.pollTask;
},
- /**
+ /**
* Connect to the server-side and begin the polling process. To handle each
* response subscribe to the data event.
*/
@@ -120,7 +136,7 @@ Ext.define('Ext.direct.PollingProvider', {
}
},
- /**
+ /**
* Disconnect from the server-side and stop the polling process. The disconnect
* event will be fired on a successful disconnect.
*/
@@ -155,4 +171,6 @@ Ext.define('Ext.direct.PollingProvider', {
}));
}
}
-});
\ No newline at end of file
+});
+
+