docs/output/Ext.util.TaskRunner.js

   1 Ext.data.JsonP.Ext_util_TaskRunner({
   2   "tagname": "class",
   3   "name": "Ext.util.TaskRunner",
   4   "doc": "<p>Provides the ability to execute one or more arbitrary tasks in a multithreaded\nmanner.  Generally, you can use the singleton <a href=\"#/api/Ext.TaskManager\" rel=\"Ext.TaskManager\" class=\"docClass\">Ext.TaskManager</a> instead, but\nif needed, you can create separate instances of TaskRunner.  Any number of\nseparate tasks can be started at any time and will run independently of each\nother. Example usage:</p>\n\n<pre><code>// Start a simple clock task that updates a div once per second\nvar updateClock = function(){\n    Ext.fly('clock').update(new Date().format('g:i:s A'));\n} \nvar task = {\n    run: updateClock,\n    interval: 1000 //1 second\n}\nvar runner = new Ext.util.TaskRunner();\nrunner.start(task);\n\n// equivalent using TaskManager\nExt.TaskManager.start({\n    run: updateClock,\n    interval: 1000\n});\n\n</code></pre>\n\n\n<p>See the <a href=\"#/api/Ext.util.TaskRunner-method-start\" rel=\"Ext.util.TaskRunner-method-start\" class=\"docClass\">start</a> method for details about how to configure a task object.</p>\n\n\n<p>Also see <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a>.</p>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "TaskRunner",
  24       "member": "Ext.util.TaskRunner",
  25       "doc": "\n",
  26       "params": [
  27         {
  28           "type": "Number",
  29           "name": "interval",
  30           "doc": "<p>(optional) The minimum precision in milliseconds supported by this TaskRunner instance\n(defaults to 10)</p>\n",
  31           "optional": true
  32         }
  33       ],
  34       "return": {
  35         "type": "void",
  36         "doc": "\n"
  37       },
  38       "private": false,
  39       "static": false,
  40       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js",
  41       "linenr": 1,
  42       "html_filename": "TaskManager.html",
  43       "href": "TaskManager.html#Ext-util-TaskRunner-method-constructor",
  44       "shortDoc": "\n"
  45     },
  46     {
  47       "tagname": "method",
  48       "name": "start",
  49       "member": "Ext.util.TaskRunner",
  50       "doc": "<p>Starts a new task.</p>\n",
  51       "params": [
  52         {
  53           "type": "Object",
  54           "name": "task",
  55           "doc": "<p>A config object that supports the following properties:<ul>\n<li><code>run</code> : Function<div class=\"sub-desc\"><p>The function to execute each time the task is invoked. The\nfunction will be called at each interval and passed the <code>args</code> argument if specified, and the\ncurrent invocation count if not.</p>\n<p>If a particular scope (<code>this</code> reference) is required, be sure to specify it using the <code>scope</code> argument.</p>\n<p>Return <code>false</code> from this function to terminate the task.</p></div></li>\n<li><code>interval</code> : Number<div class=\"sub-desc\">The frequency in milliseconds with which the task\nshould be invoked.</div></li>\n<li><code>args</code> : Array<div class=\"sub-desc\">(optional) An array of arguments to be passed to the function\nspecified by <code>run</code>. If not specified, the current invocation count is passed.</div></li>\n<li><code>scope</code> : Object<div class=\"sub-desc\">(optional) The scope (<tt>this</tt> reference) in which to execute the\n<code>run</code> function. Defaults to the task config object.</div></li>\n<li><code>duration</code> : Number<div class=\"sub-desc\">(optional) The length of time in milliseconds to invoke\nthe task before stopping automatically (defaults to indefinite).</div></li>\n<li><code>repeat</code> : Number<div class=\"sub-desc\">(optional) The number of times to invoke the task before\nstopping automatically (defaults to indefinite).</div></li>\n</ul></p>\n\n\n<p>Before each invocation, <a href=\"#/api/Ext\" rel=\"Ext\" class=\"docClass\">Ext</a> injects the property <code>taskRunCount</code> into the task object so\nthat calculations based on the repeat count can be performed.</p>\n\n",
  56           "optional": true
  57         }
  58       ],
  59       "return": {
  60         "type": "Object",
  61         "doc": "<p>The task</p>\n"
  62       },
  63       "private": false,
  64       "static": false,
  65       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js",
  66       "linenr": 104,
  67       "html_filename": "TaskManager.html",
  68       "href": "TaskManager.html#Ext-util-TaskRunner-method-start",
  69       "shortDoc": "<p>Starts a new task.</p>\n"
  70     },
  71     {
  72       "tagname": "method",
  73       "name": "stop",
  74       "member": "Ext.util.TaskRunner",
  75       "doc": "<p>Stops an existing running task.</p>\n",
  76       "params": [
  77         {
  78           "type": "Object",
  79           "name": "task",
  80           "doc": "<p>The task to stop</p>\n",
  81           "optional": false
  82         }
  83       ],
  84       "return": {
  85         "type": "Object",
  86         "doc": "<p>The task</p>\n"
  87       },
  88       "private": false,
  89       "static": false,
  90       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js",
  91       "linenr": 137,
  92       "html_filename": "TaskManager.html",
  93       "href": "TaskManager.html#Ext-util-TaskRunner-method-stop",
  94       "shortDoc": "<p>Stops an existing running task.</p>\n"
  95     },
  96     {
  97       "tagname": "method",
  98       "name": "stopAll",
  99       "member": "Ext.util.TaskRunner",
 100       "doc": "<p>Stops all tasks that are currently running.</p>\n",
 101       "params": [
 102
 103       ],
 104       "return": {
 105         "type": "void",
 106         "doc": "\n"
 107       },
 108       "private": false,
 109       "static": false,
 110       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js",
 111       "linenr": 148,
 112       "html_filename": "TaskManager.html",
 113       "href": "TaskManager.html#Ext-util-TaskRunner-method-stopAll",
 114       "shortDoc": "<p>Stops all tasks that are currently running.</p>\n"
 115     }
 116   ],
 117   "property": [
 118
 119   ],
 120   "event": [
 121
 122   ],
 123   "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js",
 124   "linenr": 1,
 125   "html_filename": "TaskManager.html",
 126   "href": "TaskManager.html#Ext-util-TaskRunner",
 127   "cssVar": [
 128
 129   ],
 130   "cssMixin": [
 131
 132   ],
 133   "component": false,
 134   "superclasses": [
 135
 136   ],
 137   "subclasses": [
 138     "Ext.TaskManager"
 139   ],
 140   "mixedInto": [
 141
 142   ],
 143   "allMixins": [
 144
 145   ]
 146 });