X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.util.DelayedTask.html?ds=inline diff --git a/docs/output/Ext.util.DelayedTask.html b/docs/output/Ext.util.DelayedTask.html index f6a31392..5364a999 100644 --- a/docs/output/Ext.util.DelayedTask.html +++ b/docs/output/Ext.util.DelayedTask.html @@ -1,97 +1,26 @@ -
Package: | Ext.util |
Defined In: | DelayedTask.js |
Class: | DelayedTask |
Extends: | Object |
Package: | Ext.util |
Defined In: | DelayedTask.js |
Class: | DelayedTask |
Extends: | Object |
The DelayedTask class provides a convenient way to "buffer" the execution of a method, +performing setTimeout where a new timeout cancels the old timeout. When called, the +task will wait the specified time period before executing. If durng that time period, +the task is called again, the original call will be cancelled. This continues so that +the function is only called a single time for each iteration.
+This method is especially useful for things like detecting whether a user has finished +typing in a text field. An example would be performing validation on a keypress. You can +use this class to buffer the keypress events for a certain number of milliseconds, and +perform only if they stop for that amount of time. Usage:
var task = new Ext.util.DelayedTask(function(){
+ alert(Ext.getDom('myInputField').value.length);
+});
+// Wait 500ms before calling our function. If the user presses another key
+// during that 500ms, it will be cancelled and we'll wait another 500ms.
+Ext.get('myInputField').on('keypress', function(){
+ task.delay(500);
+});
+Note that we are using a DelayedTask here to illustrate a point. The configuration +option buffer for addListener/on will +also setup a delayed task for you to buffer events.
Method | Defined By | |
---|---|---|
DelayedTask( [Function fn ], Object scope , [Array args ] )
+ The parameters to this constructor serve as defaults and are not required. The parameters to this constructor serve as defaults and are not required. Parameters:
| DelayedTask | |
cancel()
+ :
+ void Cancel the last queued timeout Cancel the last queued timeout Parameters:
| DelayedTask | |
delay( Number delay , [Function newFn ], [Object newScope ], [Array newArgs ] )
+ :
+ voidCancels any pending timeout and queues a new one Cancels any pending timeout and queues a new one Parameters:
| DelayedTask |