Ext.data.JsonP.Ext_util_TaskRunner({"mixins":[],"code_type":"ext_define","inheritable":false,"component":false,"meta":{},"mixedInto":[],"uses":[],"aliases":{},"parentMixins":[],"superclasses":["Ext.Base"],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"$className","id":"property-S-className"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"configMap","id":"property-configMap"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigList","id":"property-initConfigList"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigMap","id":"property-initConfigMap"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"isInstance","id":"property-isInstance"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"property","name":"self","id":"property-self"},{"meta":{"private":true},"owner":"Ext.util.TaskRunner","tagname":"property","name":"timerId","id":"property-timerId"}],"css_var":[],"method":[{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"method","name":"constructor","id":"method-constructor"},{"meta":{"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."},"protected":true},"owner":"Ext.Base","tagname":"method","name":"callOverridden","id":"method-callOverridden"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"callParent","id":"method-callParent"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"configClass","id":"method-configClass"},{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"method","name":"destroy","id":"method-destroy"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"getConfig","id":"method-getConfig"},{"meta":{},"owner":"Ext.Base","tagname":"method","name":"getInitialConfig","id":"method-getInitialConfig"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"hasConfig","id":"method-hasConfig"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"initConfig","id":"method-initConfig"},{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"method","name":"newTask","id":"method-newTask"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"onConfigUpdate","id":"method-onConfigUpdate"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"setConfig","id":"method-setConfig"},{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"method","name":"start","id":"method-start"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"statics","id":"method-statics"},{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"method","name":"stop","id":"method-stop"},{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"method","name":"stopAll","id":"method-stopAll"}],"css_mixin":[],"cfg":[{"meta":{},"owner":"Ext.util.TaskRunner","tagname":"cfg","name":"interval","id":"cfg-interval"}]},"tagname":"class","extends":"Ext.Base","html":"
Hierarchy
Ext.Base
Ext.util.TaskRunner
Subclasses
Ext.TaskManager
Files
TaskManager.js

Provides the ability to execute one or more arbitrary tasks in a asynchronous manner.\nGenerally, you can use the singleton Ext.TaskManager instead, but if needed,\nyou can create separate instances of TaskRunner. Any number of separate tasks can be\nstarted at any time and will run independently of each other.

\n\n

Example usage:

\n\n
 // Start a simple clock task that updates a div once per second\n var updateClock = function () {\n     Ext.fly('clock').update(new Date().format('g:i:s A'));\n }\n\n var runner = new Ext.util.TaskRunner();\n var task = runner.start({\n     run: updateClock,\n     interval: 1000\n }\n
\n\n

The equivalent using TaskManager:

\n\n
 var task = Ext.TaskManager.start({\n     run: updateClock,\n     interval: 1000\n });\n
\n\n

To end a running task:

\n\n
 Ext.TaskManager.stop(task);\n
\n\n

If a task needs to be started and stopped repeated over time, you can create a\nTask instance.

\n\n
 var task = runner.newTask({\n     run: function () {\n         // useful code\n     },\n     interval: 1000\n });\n\n task.start();\n\n // ...\n\n task.stop();\n\n // ...\n\n task.start();\n
\n\n

A re-usable, one-shot task can be managed similar to the above:

\n\n
 var task = runner.newTask({\n     run: function () {\n         // useful code to run once\n     },\n     repeat: 1\n });\n\n task.start();\n\n // ...\n\n task.start();\n
\n\n

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

\n\n

Also see Ext.util.DelayedTask.

\n
Defined By

Config options

Ext.util.TaskRunner
view source
: Number
The timer resolution. ...

The timer resolution.

\n

Defaults to: 10

Properties

Defined By

Instance Properties

Ext.Base
view source
: Stringprivate
...
\n

Defaults to: "Ext.Base"

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.Base
view source
: Arrayprivate
...
\n

Defaults to: []

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.Base
view source
: Booleanprivate
...
\n

Defaults to: true

Ext.Base
view source
: Ext.Classprotected
Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n
Ext.util.TaskRunner
view source
: Objectprivate
The id of the current timer. ...

The id of the current timer.

\n

Defaults to: null

Defined By

Static Properties

Ext.Base
view source
: Arrayprivatestatic
...
\n

Defaults to: []

Methods

Defined By

Instance Methods

Ext.util.TaskRunner
view source
new( [Number/Object interval] ) : Object
...
\n

Parameters

  • interval : Number/Object (optional)

    The minimum precision in milliseconds supported by this\nTaskRunner instance. Alternatively, a config object to apply to the new instance.

    \n

    Defaults to: 10

Returns

Ext.Base
view source
( Array/Arguments args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)

    \n

Returns

  • Object

    Returns the result of calling the overridden method

    \n
Ext.Base
view source
( Array/Arguments args ) : Objectprotected
Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n
 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n
\n\n

This can be used with an override as follows:

\n\n
 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n
\n\n

This also works with static methods.

\n\n
 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n
\n\n

Lastly, it also works with overridden static methods.

\n\n
 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

    \n

Returns

  • Object

    Returns the result of calling the parent method

    \n
Ext.Base
view source
( )private
...
\n
Ext.util.TaskRunner
view source
( )
Destroys this instance, stopping all tasks that are currently running. ...

Destroys this instance, stopping all tasks that are currently running.

\n

Overrides: Ext.Base.destroy

Ext.Base
view source
( Object name )private
...
\n

Parameters

Ext.Base
view source
( [String name] ) : Object/Mixed
Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

\n

Parameters

  • name : String (optional)

    Name of the config option to return.

    \n

Returns

  • Object/Mixed

    The full config object or a single config value\nwhen name parameter specified.

    \n
Ext.Base
view source
( Object config )private
...
\n

Parameters

Ext.Base
view source
( Object config ) : Ext.Baseprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

Ext.util.TaskRunner
view source
( Object config )
Creates a new Task instance. ...

Creates a new Task instance. These instances can\nbe easily started and stopped.

\n

Parameters

  • config : Object

    The config object. For details on the supported properties,\nsee start.

    \n
Ext.Base
view source
( Object names, Object callback, Object scope )private
...
\n

Parameters

Ext.Base
view source
( Object config, Object applyIfNotSet )private
...
\n

Parameters

Ext.util.TaskRunner
view source
( Object task ) : Object
Starts a new task. ...

Starts a new task.

\n\n

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

\n\n

The returned task will contain a destroy method that can be used to destroy the\ntask and cancel further calls. This is equivalent to the stop method.

\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,\nand the current invocation count if not.

      \n\n

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

      \n

      Parameters

        Returns

        • Boolean

          false from this function to terminate the task.

          \n
      • onError : Function

        The function to execute in case of unhandled\nerror on task.run.

        \n
      • interval : Number

        The frequency in milliseconds with which the task\nshould be invoked.

        \n
      • args : Object[]

        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

        The scope (this reference) in which to execute the\nrun function. Defaults to the task config object.

        \n
      • duration : Number

        The length of time in milliseconds to invoke the task\nbefore stopping automatically (defaults to indefinite).

        \n
      • repeat : Number

        The number of times to invoke the task before stopping\nautomatically (defaults to indefinite).

        \n

    Returns

    Ext.Base
    view source
    ( ) : Ext.Classprotected
    Get the reference to the class from which this object was instantiated. ...

    Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

    \n\n
    Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
    \n

    Returns

    Ext.util.TaskRunner
    view source
    ( Object task ) : Object
    Stops an existing running task. ...

    Stops an existing running task.

    \n

    Parameters

    • task : Object

      The task to stop

      \n

    Returns

    Ext.util.TaskRunner
    view source
    ( )
    Stops all tasks that are currently running. ...

    Stops all tasks that are currently running.

    \n
    Defined By

    Static Methods

    Ext.Base
    view source
    ( Object config )privatestatic
    ...
    \n

    Parameters

    Ext.Base
    view source
    ( Object members )privatestatic
    ...
    \n

    Parameters

    Ext.Base
    view source
    ( Object name, Object member )privatestatic
    ...
    \n

    Parameters

    Ext.Base
    view source
    ( Object members )static
    Add methods / properties to the prototype of this class. ...

    Add methods / properties to the prototype of this class.

    \n\n
    Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
    \n

    Parameters

    Ext.Base
    view source
    ( Object members ) : Ext.Basestatic
    Add / override static properties of this class. ...

    Add / override static properties of this class.

    \n\n
    Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n
    \n

    Parameters

    Returns

    Ext.Base
    view source
    ( Object xtype )privatestatic
    ...
    \n

    Parameters

    Ext.Base
    view source
    ( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic
    Borrow another class' members to the prototype of this class. ...

    Borrow another class' members to the prototype of this class.

    \n\n
    Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
    \n

    Parameters

    • fromClass : Ext.Base

      The class to borrow members from

      \n
    • members : Array/String

      The names of the members to borrow

      \n

    Returns

    Ext.Base
    view source
    ( ) : Objectstatic
    Create a new instance of this Class. ...

    Create a new instance of this Class.

    \n\n
    Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
    \n\n

    All parameters are passed to the constructor of the class.

    \n

    Returns

    Ext.Base
    view source
    ( String/Object alias, String/Object origin )static
    Create aliases for existing prototype methods. ...

    Create aliases for existing prototype methods. Example:

    \n\n
    Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
    \n

    Parameters

    Ext.Base
    view source
    ( Object config )privatestatic
    ...
    \n

    Parameters

    Ext.Base
    view source
    ( ) : Stringstatic
    Get the current class' name in string format. ...

    Get the current class' name in string format.

    \n\n
    Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
    \n

    Returns

    Ext.Base
    view source
    ( )deprecatedstatic
    Adds members to class. ...

    Adds members to class.

    \n
    \n

    This method has been deprecated since 4.1

    \n

    Use addMembers instead.

    \n\n
    \n
    Ext.Base
    view source
    ( Object name, Object mixinClass )privatestatic
    Used internally by the mixins pre-processor ...

    Used internally by the mixins pre-processor

    \n

    Parameters

    Ext.Base
    view source
    ( Object fn, Object scope )privatestatic
    ...
    \n

    Parameters

    Ext.Base
    view source
    ( Object members ) : Ext.Basedeprecatedstatic
    Override members of this class. ...

    Override members of this class. Overridden methods can be invoked via\ncallParent.

    \n\n
    Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
    \n\n

    As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

    \n\n
    Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n
    \n\n

    The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

    \n
    \n

    This method has been deprecated since 4.1.0

    \n

    Use Ext.define instead

    \n\n
    \n

    Parameters

    • members : Object

      The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.

      \n

    Returns

    Ext.Base
    view source
    ( )privatestatic
    ...
    \n
    ","subclasses":["Ext.TaskManager"],"name":"Ext.util.TaskRunner","alternateClassNames":[],"inheritdoc":null,"files":[{"href":"TaskManager.html#Ext-util-TaskRunner","filename":"TaskManager.js"}],"html_meta":{},"singleton":false,"id":"class-Ext.util.TaskRunner","statics":{"property":[{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"property","name":"$onExtended","id":"static-property-S-onExtended"}],"event":[],"css_var":[],"method":[{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addConfig","id":"static-method-addConfig"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addMember","id":"static-method-addMember"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"addMembers","id":"static-method-addMembers"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"addStatics","id":"static-method-addStatics"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addXtype","id":"static-method-addXtype"},{"meta":{"private":true,"static":true},"owner":"Ext.Base","tagname":"method","name":"borrow","id":"static-method-borrow"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"create","id":"static-method-create"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"createAlias","id":"static-method-createAlias"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"extend","id":"static-method-extend"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"getName","id":"static-method-getName"},{"meta":{"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"},"static":true},"owner":"Ext.Base","tagname":"method","name":"implement","id":"static-method-implement"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"mixin","id":"static-method-mixin"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"onExtended","id":"static-method-onExtended"},{"meta":{"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"},"markdown":true,"static":true},"owner":"Ext.Base","tagname":"method","name":"override","id":"static-method-override"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"triggerExtended","id":"static-method-triggerExtended"}],"css_mixin":[],"cfg":[]},"requires":[]});