docs/output/Ext.TaskManager.js

   1 Ext.data.JsonP.Ext_TaskManager({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9
  10     ],
  11     "method": [
  12       {
  13         "deprecated": null,
  14         "alias": null,
  15         "href": "TaskManager.html#Ext-util-TaskRunner-method-constructor",
  16         "tagname": "method",
  17         "protected": false,
  18         "shortDoc": " ...",
  19         "static": false,
  20         "params": [
  21           {
  22             "type": "Number",
  23             "optional": true,
  24             "doc": "<p>(optional) The minimum precision in milliseconds supported by this TaskRunner instance\n(defaults to 10)</p>\n",
  25             "name": "interval"
  26           }
  27         ],
  28         "private": false,
  29         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js",
  30         "doc": "\n",
  31         "owner": "Ext.util.TaskRunner",
  32         "name": "TaskManager",
  33         "html_filename": "TaskManager.html",
  34         "return": {
  35           "type": "Object",
  36           "doc": "\n"
  37         },
  38         "linenr": 1
  39       },
  40       {
  41         "deprecated": null,
  42         "alias": null,
  43         "protected": false,
  44         "tagname": "method",
  45         "href": "TaskManager.html#Ext-util-TaskRunner-method-start",
  46         "shortDoc": "Starts a new task. ...",
  47         "static": false,
  48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js",
  49         "private": false,
  50         "params": [
  51           {
  52             "type": "Object",
  53             "optional": true,
  54             "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",
  55             "name": "task"
  56           }
  57         ],
  58         "name": "start",
  59         "owner": "Ext.util.TaskRunner",
  60         "doc": "<p>Starts a new task.</p>\n",
  61         "linenr": 104,
  62         "return": {
  63           "type": "Object",
  64           "doc": "<p>The task</p>\n"
  65         },
  66         "html_filename": "TaskManager.html"
  67       },
  68       {
  69         "deprecated": null,
  70         "alias": null,
  71         "protected": false,
  72         "tagname": "method",
  73         "href": "TaskManager.html#Ext-util-TaskRunner-method-stop",
  74         "shortDoc": "Stops an existing running task. ...",
  75         "static": false,
  76         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js",
  77         "private": false,
  78         "params": [
  79           {
  80             "type": "Object",
  81             "optional": false,
  82             "doc": "<p>The task to stop</p>\n",
  83             "name": "task"
  84           }
  85         ],
  86         "name": "stop",
  87         "owner": "Ext.util.TaskRunner",
  88         "doc": "<p>Stops an existing running task.</p>\n",
  89         "linenr": 137,
  90         "return": {
  91           "type": "Object",
  92           "doc": "<p>The task</p>\n"
  93         },
  94         "html_filename": "TaskManager.html"
  95       },
  96       {
  97         "deprecated": null,
  98         "alias": null,
  99         "protected": false,
 100         "tagname": "method",
 101         "href": "TaskManager.html#Ext-util-TaskRunner-method-stopAll",
 102         "shortDoc": "Stops all tasks that are currently running. ...",
 103         "static": false,
 104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js",
 105         "private": false,
 106         "params": [
 107
 108         ],
 109         "name": "stopAll",
 110         "owner": "Ext.util.TaskRunner",
 111         "doc": "<p>Stops all tasks that are currently running.</p>\n",
 112         "linenr": 148,
 113         "return": {
 114           "type": "void",
 115           "doc": "\n"
 116         },
 117         "html_filename": "TaskManager.html"
 118       }
 119     ],
 120     "property": [
 121
 122     ],
 123     "cssVar": [
 124
 125     ],
 126     "cssMixin": [
 127
 128     ],
 129     "event": [
 130
 131     ]
 132   },
 133   "singleton": true,
 134   "alias": null,
 135   "superclasses": [
 136     "Ext.util.TaskRunner"
 137   ],
 138   "protected": false,
 139   "tagname": "class",
 140   "mixins": [
 141
 142   ],
 143   "href": "TaskManager.html#Ext-TaskManager",
 144   "subclasses": [
 145
 146   ],
 147   "static": false,
 148   "author": null,
 149   "component": false,
 150   "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js",
 151   "private": false,
 152   "alternateClassNames": [
 153
 154   ],
 155   "name": "Ext.TaskManager",
 156   "doc": "<p>A static <a href=\"#/api/Ext.util.TaskRunner\" rel=\"Ext.util.TaskRunner\" class=\"docClass\">Ext.util.TaskRunner</a> instance that can be used to start and stop arbitrary tasks.  See\n<a href=\"#/api/Ext.util.TaskRunner\" rel=\"Ext.util.TaskRunner\" class=\"docClass\">Ext.util.TaskRunner</a> for supported methods and task config properties.</p>\n\n<pre><code>// Start a simple clock task that updates a div once per second\nvar task = {\n    run: function(){\n        Ext.fly('clock').update(new Date().format('g:i:s A'));\n    },\n    interval: 1000 //1 second\n}\nExt.TaskManager.start(task);\n</code></pre>\n\n\n<p>See the <a href=\"#/api/Ext.TaskManager-method-start\" rel=\"Ext.TaskManager-method-start\" class=\"docClass\">start</a> method for details about how to configure a task object.</p>\n\n",
 157   "mixedInto": [
 158
 159   ],
 160   "linenr": 164,
 161   "xtypes": [
 162
 163   ],
 164   "html_filename": "TaskManager.html",
 165   "extends": "Ext.util.TaskRunner"
 166 });