Provides the ability to execute one or more arbitrary tasks in a multithreaded\nmanner. Generally, you can use the singleton Ext.TaskManager 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:
\n\n// 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\nSee the start method for details about how to configure a task object.
\n\n\nAlso see Ext.util.DelayedTask.
\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ + "allMixins": [ ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ + "members": { + "cfg": [ - ], - "method": [ - { - "tagname": "method", - "name": "TaskRunner", - "member": "Ext.util.TaskRunner", - "doc": "\n", - "params": [ - { - "type": "Number", - "name": "interval", - "doc": "(optional) The minimum precision in milliseconds supported by this TaskRunner instance\n(defaults to 10)
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "TaskManager.html#Ext-util-TaskRunner-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": " ...", + "static": false, + "params": [ + { + "type": "Number", + "optional": true, + "doc": "(optional) The minimum precision in milliseconds supported by this TaskRunner instance\n(defaults to 10)
\n", + "name": "interval" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js", + "doc": "\n", + "owner": "Ext.util.TaskRunner", + "name": "TaskRunner", + "html_filename": "TaskManager.html", + "return": { + "type": "Object", + "doc": "\n" + }, + "linenr": 1 }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js", - "linenr": 1, - "html_filename": "TaskManager.html", - "href": "TaskManager.html#Ext-util-TaskRunner-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "start", - "member": "Ext.util.TaskRunner", - "doc": "Starts a new task.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TaskManager.html#Ext-util-TaskRunner-method-start", + "shortDoc": "Starts a new task. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "A config object that supports the following properties:
run : FunctionThe function to execute each time the task is invoked. The\nfunction will be called at each interval and passed the args argument if specified, and the\ncurrent invocation count if not.
If a particular scope (this reference) is required, be sure to specify it using the scope argument.
Return false from this function to terminate the task.
interval : Numberargs : Arrayrun. If not specified, the current invocation count is passed.scope : Objectrun function. Defaults to the task config object.duration : Numberrepeat : NumberBefore each invocation, Ext injects the property taskRunCount into the task object so\nthat calculations based on the repeat count can be performed.
Starts a new task.
\n", + "linenr": 104, + "return": { "type": "Object", - "name": "task", - "doc": "A config object that supports the following properties:
run : FunctionThe function to execute each time the task is invoked. The\nfunction will be called at each interval and passed the args argument if specified, and the\ncurrent invocation count if not.
If a particular scope (this reference) is required, be sure to specify it using the scope argument.
Return false from this function to terminate the task.
interval : Numberargs : Arrayrun. If not specified, the current invocation count is passed.scope : Objectrun function. Defaults to the task config object.duration : Numberrepeat : NumberBefore each invocation, Ext injects the property taskRunCount into the task object so\nthat calculations based on the repeat count can be performed.
The task
\n" + "doc": "The task
\n" + }, + "html_filename": "TaskManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js", - "linenr": 104, - "html_filename": "TaskManager.html", - "href": "TaskManager.html#Ext-util-TaskRunner-method-start", - "shortDoc": "Starts a new task.
\n" - }, - { - "tagname": "method", - "name": "stop", - "member": "Ext.util.TaskRunner", - "doc": "Stops an existing running task.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TaskManager.html#Ext-util-TaskRunner-method-stop", + "shortDoc": "Stops an existing running task. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The task to stop
\n", + "name": "task" + } + ], + "name": "stop", + "owner": "Ext.util.TaskRunner", + "doc": "Stops an existing running task.
\n", + "linenr": 137, + "return": { "type": "Object", - "name": "task", - "doc": "The task to stop
\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "The task
\n" + "doc": "The task
\n" + }, + "html_filename": "TaskManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js", - "linenr": 137, - "html_filename": "TaskManager.html", - "href": "TaskManager.html#Ext-util-TaskRunner-method-stop", - "shortDoc": "Stops an existing running task.
\n" - }, - { - "tagname": "method", - "name": "stopAll", - "member": "Ext.util.TaskRunner", - "doc": "Stops all tasks that are currently running.
\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TaskManager.html#Ext-util-TaskRunner-method-stopAll", + "shortDoc": "Stops all tasks that are currently running. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js", - "linenr": 148, - "html_filename": "TaskManager.html", - "href": "TaskManager.html#Ext-util-TaskRunner-method-stopAll", - "shortDoc": "Stops all tasks that are currently running.
\n" - } - ], - "property": [ + ], + "name": "stopAll", + "owner": "Ext.util.TaskRunner", + "doc": "Stops all tasks that are currently running.
\n", + "linenr": 148, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "TaskManager.html" + } + ], + "property": [ - ], - "event": [ + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js", - "linenr": 1, - "html_filename": "TaskManager.html", - "href": "TaskManager.html#Ext-util-TaskRunner", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "TaskManager.html#Ext-util-TaskRunner", "subclasses": [ "Ext.TaskManager" ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/util/TaskManager.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.util.TaskRunner", + "doc": "Provides the ability to execute one or more arbitrary tasks in a multithreaded\nmanner. Generally, you can use the singleton Ext.TaskManager 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:
\n\n// 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\nSee the start method for details about how to configure a task object.
\n\n\nAlso see Ext.util.DelayedTask.
\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "TaskManager.html", + "extends": null }); \ No newline at end of file