X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.TaskManager.js?ds=sidebyside diff --git a/docs/output/Ext.TaskManager.js b/docs/output/Ext.TaskManager.js index ef4521ef..4062c52a 100644 --- a/docs/output/Ext.TaskManager.js +++ b/docs/output/Ext.TaskManager.js @@ -1,146 +1 @@ -Ext.data.JsonP.Ext_TaskManager({ - "tagname": "class", - "name": "Ext.TaskManager", - "doc": "

A static Ext.util.TaskRunner instance that can be used to start and stop arbitrary tasks. See\nExt.util.TaskRunner for supported methods and task config properties.

\n\n
// 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
\n\n\n

See the start method for details about how to configure a task object.

\n\n", - "extends": "Ext.util.TaskRunner", - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": true, - "private": false, - "cfg": [ - - ], - "method": [ - { - "tagname": "method", - "name": "TaskManager", - "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" - }, - "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": [ - { - "type": "Object", - "name": "task", - "doc": "

A config object that supports the following properties:

\n\n\n

Before each invocation, Ext injects the property taskRunCount into the task object so\nthat calculations based on the repeat count can be performed.

\n\n", - "optional": true - } - ], - "return": { - "type": "Object", - "doc": "

The task

\n" - }, - "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": [ - { - "type": "Object", - "name": "task", - "doc": "

The task to stop

\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "

The task

\n" - }, - "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": [ - - ], - "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": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/TaskManager.js", - "linenr": 164, - "html_filename": "TaskManager.html", - "href": "TaskManager.html#Ext-TaskManager", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.util.TaskRunner" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_TaskManager({"tagname":"class","html":"

Hierarchy

Ext.util.TaskRunner
Ext.TaskManager

Files

A static Ext.util.TaskRunner instance that can be used to start and stop arbitrary tasks. See\nExt.util.TaskRunner for supported methods and task config properties.

\n\n
// 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
\n\n\n

See the start method for details about how to configure a task object.

\n\n
Defined By

Methods

...
\n

Parameters

  • interval : Number (optional)

    The minimum precision in milliseconds supported by this TaskRunner instance

    \n

    Defaults to: 10

Returns

Starts a new task. ...

Starts a new task.

\n

Parameters

  • task : Object

    A config object that supports the following properties:

      \n
    • run : Function

      The 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.

      \n

      If a particular scope (this reference) is required, be sure to specify it using the scope argument.

      \n

      Return false from this function to terminate the task.

    • \n
    • interval : Number
      The frequency in milliseconds with which the task\nshould be invoked.
    • \n
    • args : Array
      (optional) An array of arguments to be passed to the function\nspecified by run. If not specified, the current invocation count is passed.
    • \n
    • scope : Object
      (optional) The scope (this reference) in which to execute the\nrun function. Defaults to the task config object.
    • \n
    • duration : Number
      (optional) The length of time in milliseconds to invoke\nthe task before stopping automatically (defaults to indefinite).
    • \n
    • repeat : Number
      (optional) The number of times to invoke the task before\nstopping automatically (defaults to indefinite).
    • \n

    \n\n\n

    Before each invocation, Ext injects the property taskRunCount into the task object so\nthat calculations based on the repeat count can be performed.

    \n\n

Returns

Stops an existing running task. ...

Stops an existing running task.

\n

Parameters

  • task : Object

    The task to stop

    \n

Returns

Stops all tasks that are currently running. ...

Stops all tasks that are currently running.

\n
","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.util.TaskRunner","inheritable":false,"static":false,"superclasses":["Ext.util.TaskRunner","Ext.TaskManager"],"singleton":true,"code_type":"assignment","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.TaskRunner","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.TaskRunner","template":false,"required":null,"protected":false,"name":"start","id":"method-start"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.TaskRunner","template":false,"required":null,"protected":false,"name":"stop","id":"method-stop"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.TaskRunner","template":false,"required":null,"protected":false,"name":"stopAll","id":"method-stopAll"}],"event":[]},"private":false,"component":false,"name":"Ext.TaskManager","alternateClassNames":[],"id":"class-Ext.TaskManager","mixedInto":[],"xtypes":{},"files":[{"href":"TaskManager.html#Ext-TaskManager","filename":"TaskManager.js"}]}); \ No newline at end of file