X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.Class.js diff --git a/docs/output/Ext.Class.js b/docs/output/Ext.Class.js index 00b523f0..a5e58316 100644 --- a/docs/output/Ext.Class.js +++ b/docs/output/Ext.Class.js @@ -1,421 +1 @@ -Ext.data.JsonP.Ext_Class({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": "Jacky Nguyen ", - "members": { - "cfg": [ - { - "type": "[String]", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ClassManager.html#Ext-Class-cfg-alias", - "shortDoc": "List of short aliases for class names. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/ClassManager.js", - "private": false, - "name": "alias", - "owner": "Ext.Class", - "doc": "

List of short aliases for class names. Most useful for defining xtypes for widgets:

\n\n
Ext.define('MyApp.CoolPanel', {\n    extend: 'Ext.panel.Panel',\n    alias: ['widget.coolpanel'],\n    title: 'Yeah!'\n});\n\n// Using Ext.create\nExt.widget('widget.coolpanel');\n// Using the shorthand for widgets and in xtypes\nExt.widget('panel', {\n    items: [\n        {xtype: 'coolpanel', html: 'Foo'},\n        {xtype: 'coolpanel', html: 'Bar'}\n    ]\n});\n
\n", - "linenr": 850, - "html_filename": "ClassManager.html" - }, - { - "type": "String/[String]", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ClassManager.html#Ext-Class-cfg-alternateClassName", - "shortDoc": "Defines alternate names for this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/ClassManager.js", - "private": false, - "name": "alternateClassName", - "owner": "Ext.Class", - "doc": "

Defines alternate names for this class. For example:

\n\n
Ext.define('Developer', {\n    alternateClassName: ['Coder', 'Hacker'],\n    code: function(msg) {\n        alert('Typing... ' + msg);\n    }\n});\n\nvar joe = Ext.create('Developer');\njoe.code('stackoverflow');\n\nvar rms = Ext.create('Hacker');\nrms.code('hack hack');\n
\n", - "linenr": 927, - "html_filename": "ClassManager.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Class.html#Ext-Class-cfg-config", - "shortDoc": "List of configuration options with their default values, for which automatically\naccessor methods are generated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "name": "config", - "owner": "Ext.Class", - "doc": "

List of configuration options with their default values, for which automatically\naccessor methods are generated. For example:

\n\n
Ext.define('SmartPhone', {\n     config: {\n         hasTouchScreen: false,\n         operatingSystem: 'Other',\n         price: 500\n     },\n     constructor: function(cfg) {\n         this.initConfig(cfg);\n     }\n});\n\nvar iPhone = new SmartPhone({\n     hasTouchScreen: true,\n     operatingSystem: 'iOS'\n});\n\niPhone.getPrice(); // 500;\niPhone.getOperatingSystem(); // 'iOS'\niPhone.getHasTouchScreen(); // true;\niPhone.hasTouchScreen(); // true\n
\n", - "linenr": 580, - "html_filename": "Class.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Class.html#Ext-Class-cfg-extend", - "shortDoc": "The parent class that this class extends. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "name": "extend", - "owner": "Ext.Class", - "doc": "

The parent class that this class extends. For example:

\n\n
Ext.define('Person', {\n    say: function(text) { alert(text); }\n});\n\nExt.define('Developer', {\n    extend: 'Person',\n    say: function(text) { this.callParent([\"print \"+text]); }\n});\n
\n", - "linenr": 420, - "html_filename": "Class.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Class.html#Ext-Class-cfg-inheritableStatics", - "shortDoc": "List of inheritable static methods for this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "name": "inheritableStatics", - "owner": "Ext.Class", - "doc": "

List of inheritable static methods for this class.\nOtherwise just like statics but subclasses inherit these methods.

\n", - "linenr": 529, - "html_filename": "Class.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Class.html#Ext-Class-cfg-mixins", - "shortDoc": "List of classes to mix into this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "name": "mixins", - "owner": "Ext.Class", - "doc": "

List of classes to mix into this class. For example:

\n\n
Ext.define('CanSing', {\n     sing: function() {\n         alert(\"I'm on the highway to hell...\")\n     }\n});\n\nExt.define('Musician', {\n     extend: 'Person',\n\n     mixins: {\n         canSing: 'CanSing'\n     }\n})\n
\n", - "linenr": 556, - "html_filename": "Class.html" - }, - { - "type": "[String]", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Loader.html#Ext-Class-cfg-requires", - "shortDoc": "List of classes that have to be loaded before instanciating this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Loader.js", - "private": false, - "name": "requires", - "owner": "Ext.Class", - "doc": "

List of classes that have to be loaded before instanciating this class.\nFor example:

\n\n
Ext.define('Mother', {\n    requires: ['Child'],\n    giveBirth: function() {\n        // we can be sure that child class is available.\n        return new Child();\n    }\n});\n
\n", - "linenr": 971, - "html_filename": "Loader.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ClassManager.html#Ext-Class-cfg-singleton", - "shortDoc": "When set to true, the class will be instanciated as singleton. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/ClassManager.js", - "private": false, - "name": "singleton", - "owner": "Ext.Class", - "doc": "

When set to true, the class will be instanciated as singleton. For example:

\n\n
Ext.define('Logger', {\n    singleton: true,\n    log: function(msg) {\n        console.log(msg);\n    }\n});\n\nLogger.log('Hello');\n
\n", - "linenr": 908, - "html_filename": "ClassManager.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Class.html#Ext-Class-cfg-statics", - "shortDoc": "List of static methods for this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "name": "statics", - "owner": "Ext.Class", - "doc": "

List of static methods for this class. For example:

\n\n
Ext.define('Computer', {\n     statics: {\n         factory: function(brand) {\n             // 'this' in static methods refer to the class itself\n             return new this(brand);\n         }\n     },\n\n     constructor: function() { ... }\n});\n\nvar dellComputer = Computer.factory('Dell');\n
\n", - "linenr": 499, - "html_filename": "Class.html" - }, - { - "type": "[String]", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Loader.html#Ext-Class-cfg-uses", - "shortDoc": "List of classes to load together with this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Loader.js", - "private": false, - "name": "uses", - "owner": "Ext.Class", - "doc": "

List of classes to load together with this class. These aren't neccessarily loaded before\nthis class is instanciated. For example:

\n\n
Ext.define('Mother', {\n    uses: ['Child'],\n    giveBirth: function() {\n        // This code might, or might not work:\n        // return new Child();\n\n        // Instead use Ext.create() to load the class at the spot if not loaded already:\n        return Ext.create('Child');\n    }\n});\n
\n", - "linenr": 1132, - "html_filename": "Loader.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "Class.html#Ext-Class-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates new class. ...", - "static": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

An object represent the properties of this class

\n", - "name": "classData" - }, - { - "type": "Function", - "optional": false, - "doc": "

Optional, the callback function to be executed when this class is fully created.\nNote that the creation process can be asynchronous depending on the pre-processors used.

\n", - "name": "createdFn" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "doc": "

Creates new class.

\n", - "owner": "Ext.Class", - "name": "Class", - "html_filename": "Class.html", - "return": { - "type": "Ext.Base", - "doc": "

The newly created class

\n" - }, - "linenr": 207 - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Class.html#Ext-Class-method-getDefaultPreprocessors", - "shortDoc": "Retrieve the array stack of default pre-processors ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "params": [ - - ], - "name": "getDefaultPreprocessors", - "owner": "Ext.Class", - "doc": "

Retrieve the array stack of default pre-processors

\n", - "linenr": 350, - "return": { - "type": "Function", - "doc": "

defaultPreprocessors

\n" - }, - "html_filename": "Class.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Class.html#Ext-Class-method-getPreprocessor", - "shortDoc": "Retrieve a pre-processor callback function by its name, which has been registered before ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "\n", - "name": "name" - } - ], - "name": "getPreprocessor", - "owner": "Ext.Class", - "doc": "

Retrieve a pre-processor callback function by its name, which has been registered before

\n", - "linenr": 336, - "return": { - "type": "Function", - "doc": "

preprocessor

\n" - }, - "html_filename": "Class.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Class.html#Ext-Class-method-registerPreprocessor", - "shortDoc": "Register a new pre-processor to be used during the class creation process registerPreprocessor ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The pre-processor's name

\n", - "name": "name" - }, - { - "type": "Function", - "optional": false, - "doc": "

The callback function to be executed. Typical format:

\n\n
function(cls, data, fn) {\n    // Your code here\n\n    // Execute this when the processing is finished.\n    // Asynchronous processing is perfectly ok\n    if (fn) {\n        fn.call(this, cls, data);\n    }\n});\n
\n\n

Passed arguments for this function are:

\n\n\n\n", - "name": "fn" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "always" - } - ], - "name": "registerPreprocessor", - "owner": "Ext.Class", - "doc": "

Register a new pre-processor to be used during the class creation process registerPreprocessor

\n", - "linenr": 299, - "return": { - "type": "Ext.Class", - "doc": "

this

\n" - }, - "html_filename": "Class.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Class.html#Ext-Class-method-setDefaultPreprocessorPosition", - "shortDoc": "Insert this pre-processor at a specific position in the stack, optionally relative to\nany existing pre-processor. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The pre-processor name. Note that it needs to be registered with\nregisterPreprocessor before this

\n", - "name": "name" - }, - { - "type": "String", - "optional": false, - "doc": "

The insertion position. Four possible values are:\n'first', 'last', or: 'before', 'after' (relative to the name provided in the third argument)

\n", - "name": "offset" - }, - { - "type": "String", - "optional": false, - "doc": "\n", - "name": "relativeName" - } - ], - "name": "setDefaultPreprocessorPosition", - "owner": "Ext.Class", - "doc": "

Insert this pre-processor at a specific position in the stack, optionally relative to\nany existing pre-processor. For example:

\n\n
Ext.Class.registerPreprocessor('debug', function(cls, data, fn) {\n    // Your code here\n\n    if (fn) {\n        fn.call(this, cls, data);\n    }\n}).insertDefaultPreprocessor('debug', 'last');\n
\n", - "linenr": 371, - "return": { - "type": "Ext.Class", - "doc": "

this

\n" - }, - "html_filename": "Class.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Class.html#Ext-Class-method-setDefaultPreprocessors", - "shortDoc": "Set the default array stack of default pre-processors ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "params": [ - { - "type": "Array", - "optional": false, - "doc": "\n", - "name": "preprocessors" - } - ], - "name": "setDefaultPreprocessors", - "owner": "Ext.Class", - "doc": "

Set the default array stack of default pre-processors

\n", - "linenr": 359, - "return": { - "type": "Ext.Class", - "doc": "

this

\n" - }, - "html_filename": "Class.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Class.html#Ext-Class", - "subclasses": [ - - ], - "static": false, - "author": "Jacky Nguyen ", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Class.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.Class", - "doc": "

Handles class creation throughout the whole framework. Note that most of the time Ext.define should\nbe used instead, since it's a higher level wrapper that aliases to Ext.ClassManager.create\nto enable namespacing and dynamic dependency resolution.

\n\n

Basic syntax:

\n\n
Ext.define(className, properties);\n
\n\n

in which properties is an object represent a collection of properties that apply to the class. See\nExt.ClassManager.create for more detailed instructions.

\n\n
Ext.define('Person', {\n     name: 'Unknown',\n\n     constructor: function(name) {\n         if (name) {\n             this.name = name;\n         }\n\n         return this;\n     },\n\n     eat: function(foodType) {\n         alert(\"I'm eating: \" + foodType);\n\n         return this;\n     }\n});\n\nvar aaron = new Person(\"Aaron\");\naaron.eat(\"Sandwich\"); // alert(\"I'm eating: Sandwich\");\n
\n\n

Ext.Class has a powerful set of extensible pre-processors which takes care of\neverything related to class creation, including but not limited to inheritance, mixins, configuration, statics, etc.

\n\n

Inheritance:

\n\n
Ext.define('Developer', {\n     extend: 'Person',\n\n     constructor: function(name, isGeek) {\n         this.isGeek = isGeek;\n\n         // Apply a method from the parent class' prototype\n         this.callParent([name]);\n\n         return this;\n\n     },\n\n     code: function(language) {\n         alert(\"I'm coding in: \" + language);\n\n         this.eat(\"Bugs\");\n\n         return this;\n     }\n});\n\nvar jacky = new Developer(\"Jacky\", true);\njacky.code(\"JavaScript\"); // alert(\"I'm coding in: JavaScript\");\n                          // alert(\"I'm eating: Bugs\");\n
\n\n

See Ext.Base.callParent for more details on calling superclass' methods

\n\n

Mixins:

\n\n
Ext.define('CanPlayGuitar', {\n     playGuitar: function() {\n        alert(\"F#...G...D...A\");\n     }\n});\n\nExt.define('CanComposeSongs', {\n     composeSongs: function() { ... }\n});\n\nExt.define('CanSing', {\n     sing: function() {\n         alert(\"I'm on the highway to hell...\")\n     }\n});\n\nExt.define('Musician', {\n     extend: 'Person',\n\n     mixins: {\n         canPlayGuitar: 'CanPlayGuitar',\n         canComposeSongs: 'CanComposeSongs',\n         canSing: 'CanSing'\n     }\n})\n\nExt.define('CoolPerson', {\n     extend: 'Person',\n\n     mixins: {\n         canPlayGuitar: 'CanPlayGuitar',\n         canSing: 'CanSing'\n     },\n\n     sing: function() {\n         alert(\"Ahem....\");\n\n         this.mixins.canSing.sing.call(this);\n\n         alert(\"[Playing guitar at the same time...]\");\n\n         this.playGuitar();\n     }\n});\n\nvar me = new CoolPerson(\"Jacky\");\n\nme.sing(); // alert(\"Ahem...\");\n           // alert(\"I'm on the highway to hell...\");\n           // alert(\"[Playing guitar at the same time...]\");\n           // alert(\"F#...G...D...A\");\n
\n\n

Config:

\n\n
Ext.define('SmartPhone', {\n     config: {\n         hasTouchScreen: false,\n         operatingSystem: 'Other',\n         price: 500\n     },\n\n     isExpensive: false,\n\n     constructor: function(config) {\n         this.initConfig(config);\n\n         return this;\n     },\n\n     applyPrice: function(price) {\n         this.isExpensive = (price > 500);\n\n         return price;\n     },\n\n     applyOperatingSystem: function(operatingSystem) {\n         if (!(/^(iOS|Android|BlackBerry)$/i).test(operatingSystem)) {\n             return 'Other';\n         }\n\n         return operatingSystem;\n     }\n});\n\nvar iPhone = new SmartPhone({\n     hasTouchScreen: true,\n     operatingSystem: 'iOS'\n});\n\niPhone.getPrice(); // 500;\niPhone.getOperatingSystem(); // 'iOS'\niPhone.getHasTouchScreen(); // true;\niPhone.hasTouchScreen(); // true\n\niPhone.isExpensive; // false;\niPhone.setPrice(600);\niPhone.getPrice(); // 600\niPhone.isExpensive; // true;\n\niPhone.setOperatingSystem('AlienOS');\niPhone.getOperatingSystem(); // 'Other'\n
\n\n

Statics:

\n\n
Ext.define('Computer', {\n     statics: {\n         factory: function(brand) {\n            // 'this' in static methods refer to the class itself\n             return new this(brand);\n         }\n     },\n\n     constructor: function() { ... }\n});\n\nvar dellComputer = Computer.factory('Dell');\n
\n\n

Also see Ext.Base.statics and Ext.Base.self for more details on accessing\nstatic properties within class methods

\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Class.html", - "extends": null -}); \ No newline at end of file +Ext.data.JsonP.Ext_Class({"tagname":"class","html":"
Files
Class.js

Handles class creation throughout the framework. This is a low level factory that is used by Ext.ClassManager and generally\nshould not be used directly. If you choose to use Ext.Class you will lose out on the namespace, aliasing and depency loading\nfeatures made available by Ext.ClassManager. The only time you would use Ext.Class directly is to create an anonymous class.

\n\n

If you wish to create a class you should use Ext.define which aliases\nExt.ClassManager.create to enable namespacing and dynamic dependency resolution.

\n\n

Ext.Class is the factory and not the superclass of everything. For the base class that all Ext classes inherit\nfrom, see Ext.Base.

\n
Defined By

Config options

Ext.Class
view source
: String[]
List of short aliases for class names. ...

List of short aliases for class names. Most useful for defining xtypes for widgets:

\n\n
Ext.define('MyApp.CoolPanel', {\n    extend: 'Ext.panel.Panel',\n    alias: ['widget.coolpanel'],\n    title: 'Yeah!'\n});\n\n// Using Ext.create\nExt.widget('widget.coolpanel');\n// Using the shorthand for widgets and in xtypes\nExt.widget('panel', {\n    items: [\n        {xtype: 'coolpanel', html: 'Foo'},\n        {xtype: 'coolpanel', html: 'Bar'}\n    ]\n});\n
\n
Ext.Class
view source
: String/String[]
Defines alternate names for this class. ...

Defines alternate names for this class. For example:

\n\n
Ext.define('Developer', {\n    alternateClassName: ['Coder', 'Hacker'],\n    code: function(msg) {\n        alert('Typing... ' + msg);\n    }\n});\n\nvar joe = Ext.create('Developer');\njoe.code('stackoverflow');\n\nvar rms = Ext.create('Hacker');\nrms.code('hack hack');\n
\n
Ext.Class
view source
: Object
List of configuration options with their default values, for which automatically\naccessor methods are generated. ...

List of configuration options with their default values, for which automatically\naccessor methods are generated. For example:

\n\n
Ext.define('SmartPhone', {\n     config: {\n         hasTouchScreen: false,\n         operatingSystem: 'Other',\n         price: 500\n     },\n     constructor: function(cfg) {\n         this.initConfig(cfg);\n     }\n});\n\nvar iPhone = new SmartPhone({\n     hasTouchScreen: true,\n     operatingSystem: 'iOS'\n});\n\niPhone.getPrice(); // 500;\niPhone.getOperatingSystem(); // 'iOS'\niPhone.getHasTouchScreen(); // true;\niPhone.hasTouchScreen(); // true\n
\n
Ext.Class
view source
: String
The parent class that this class extends. ...

The parent class that this class extends. For example:

\n\n
Ext.define('Person', {\n    say: function(text) { alert(text); }\n});\n\nExt.define('Developer', {\n    extend: 'Person',\n    say: function(text) { this.callParent([\"print \"+text]); }\n});\n
\n
Ext.Class
view source
: Object
List of inheritable static methods for this class. ...

List of inheritable static methods for this class.\nOtherwise just like statics but subclasses inherit these methods.

\n
Ext.Class
view source
: Object
List of classes to mix into this class. ...

List of classes to mix into this class. For example:

\n\n
Ext.define('CanSing', {\n     sing: function() {\n         alert(\"I'm on the highway to hell...\")\n     }\n});\n\nExt.define('Musician', {\n     extend: 'Person',\n\n     mixins: {\n         canSing: 'CanSing'\n     }\n})\n
\n
Ext.Class
view source
: String
Defines an override applied to a class. ...

Defines an override applied to a class. Note that overrides can only be created using\nExt.define. Ext.ClassManager.create only creates classes.

\n\n

To define an override, include the override property. The content of an override is\naggregated with the specified class in order to extend or modify that class. This can be\nas simple as setting default property values or it can extend and/or replace methods.\nThis can also extend the statics of the class.

\n\n

One use for an override is to break a large class into manageable pieces.

\n\n
 // File: /src/app/Panel.js\n\n Ext.define('My.app.Panel', {\n     extend: 'Ext.panel.Panel',\n     requires: [\n         'My.app.PanelPart2',\n         'My.app.PanelPart3'\n     ]\n\n     constructor: function (config) {\n         this.callSuper(arguments); // calls Ext.panel.Panel's constructor\n         //...\n     },\n\n     statics: {\n         method: function () {\n             return 'abc';\n         }\n     }\n });\n\n // File: /src/app/PanelPart2.js\n Ext.define('My.app.PanelPart2', {\n     override: 'My.app.Panel',\n\n     constructor: function (config) {\n         this.callSuper(arguments); // calls My.app.Panel's constructor\n         //...\n     }\n });\n
\n\n

Another use of overrides is to provide optional parts of classes that can be\nindependently required. In this case, the class may even be unaware of the\noverride altogether.

\n\n
 Ext.define('My.ux.CoolTip', {\n     override: 'Ext.tip.ToolTip',\n\n     constructor: function (config) {\n         this.callSuper(arguments); // calls Ext.tip.ToolTip's constructor\n         //...\n     }\n });\n
\n\n

The above override can now be required as normal.

\n\n
 Ext.define('My.app.App', {\n     requires: [\n         'My.ux.CoolTip'\n     ]\n });\n
\n\n

Overrides can also contain statics:

\n\n
 Ext.define('My.app.BarMod', {\n     override: 'Ext.foo.Bar',\n\n     statics: {\n         method: function (x) {\n             return this.callSuper([x * 2]); // call Ext.foo.Bar.method\n         }\n     }\n });\n
\n\n

IMPORTANT: An override is only included in a build if the class it overrides is\nrequired. Otherwise, the override, like the target class, is not included.

\n
Ext.Class
view source
: String[]
List of classes that have to be loaded before instantiating this class. ...

List of classes that have to be loaded before instantiating this class.\nFor example:

\n\n
Ext.define('Mother', {\n    requires: ['Child'],\n    giveBirth: function() {\n        // we can be sure that child class is available.\n        return new Child();\n    }\n});\n
\n
Ext.Class
view source
: Boolean
When set to true, the class will be instantiated as singleton. ...

When set to true, the class will be instantiated as singleton. For example:

\n\n
Ext.define('Logger', {\n    singleton: true,\n    log: function(msg) {\n        console.log(msg);\n    }\n});\n\nLogger.log('Hello');\n
\n
Ext.Class
view source
: Object
List of static methods for this class. ...

List of static methods for this class. For example:

\n\n
Ext.define('Computer', {\n     statics: {\n         factory: function(brand) {\n             // 'this' in static methods refer to the class itself\n             return new this(brand);\n         }\n     },\n\n     constructor: function() { ... }\n});\n\nvar dellComputer = Computer.factory('Dell');\n
\n
Ext.Class
view source
: String[]
List of classes to load together with this class. ...

List of classes to load together with this class. These aren't neccessarily loaded before\nthis class is instantiated. For example:

\n\n
Ext.define('Mother', {\n    uses: ['Child'],\n    giveBirth: function() {\n        // This code might, or might not work:\n        // return new Child();\n\n        // Instead use Ext.create() to load the class at the spot if not loaded already:\n        return Ext.create('Child');\n    }\n});\n
\n

Methods

Defined By

Instance Methods

Ext.Class
view source
new( Object classData, [Function createdFn] ) : Ext.Base
Creates new class. ...

Creates new class.

\n

Parameters

  • classData : Object

    An object represent the properties of this class

    \n
  • createdFn : Function (optional)

    The callback function to be executed when this class is fully created.\nNote that the creation process can be asynchronous depending on the pre-processors used.

    \n

Returns

Defined By

Static Methods

Ext.Class
view source
( ) : Function[]static
Retrieve the array stack of default pre-processors ...

Retrieve the array stack of default pre-processors

\n

Returns

Ext.Class
view source
( String name ) : Functionstatic
Retrieve a pre-processor callback function by its name, which has been registered before ...

Retrieve a pre-processor callback function by its name, which has been registered before

\n

Parameters

Returns

Ext.Class
view source
( String name, Function fn ) : Ext.Classstatic
Register a new pre-processor to be used during the class creation process ...

Register a new pre-processor to be used during the class creation process

\n

Parameters

  • name : String

    The pre-processor's name

    \n
  • fn : Function

    The callback function to be executed. Typical format:

    \n\n
    function(cls, data, fn) {\n    // Your code here\n\n    // Execute this when the processing is finished.\n    // Asynchronous processing is perfectly ok\n    if (fn) {\n        fn.call(this, cls, data);\n    }\n});\n
    \n

    Parameters

    • cls : Function

      The created class

      \n
    • data : Object

      The set of properties passed in Ext.Class constructor

      \n
    • fn : Function

      The callback function that must to be executed when this pre-processor finishes,\nregardless of whether the processing is synchronous or aynchronous

      \n

Returns

Ext.Class
view source
( String name, String offset, String relativeName ) : Ext.Classstatic
Inserts this pre-processor at a specific position in the stack, optionally relative to\nany existing pre-processor. ...

Inserts this pre-processor at a specific position in the stack, optionally relative to\nany existing pre-processor. For example:

\n\n
Ext.Class.registerPreprocessor('debug', function(cls, data, fn) {\n    // Your code here\n\n    if (fn) {\n        fn.call(this, cls, data);\n    }\n}).setDefaultPreprocessorPosition('debug', 'last');\n
\n

Parameters

  • name : String

    The pre-processor name. Note that it needs to be registered with\nregisterPreprocessor before this

    \n
  • offset : String

    The insertion position. Four possible values are:\n'first', 'last', or: 'before', 'after' (relative to the name provided in the third argument)

    \n
  • relativeName : String
    \n

Returns

Ext.Class
view source
( Function/Function[] preprocessors ) : Ext.Classstatic
Set the default array stack of default pre-processors ...

Set the default array stack of default pre-processors

\n

Parameters

Returns

","allMixins":[],"meta":{"author":["Jacky Nguyen "],"docauthor":["Jacky Nguyen "]},"requires":[],"deprecated":null,"extends":null,"inheritable":false,"static":false,"superclasses":[],"singleton":false,"code_type":"nop","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Class","template":false,"required":null,"protected":false,"name":"getDefaultPreprocessors","id":"static-method-getDefaultPreprocessors"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Class","template":false,"required":null,"protected":false,"name":"getPreprocessor","id":"static-method-getPreprocessor"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Class","template":false,"required":null,"protected":false,"name":"registerPreprocessor","id":"static-method-registerPreprocessor"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Class","template":false,"required":null,"protected":false,"name":"setDefaultPreprocessorPosition","id":"static-method-setDefaultPreprocessorPosition"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Class","template":false,"required":null,"protected":false,"name":"setDefaultPreprocessors","id":"static-method-setDefaultPreprocessors"}],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"alias","id":"cfg-alias"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"alternateClassName","id":"cfg-alternateClassName"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"config","id":"cfg-config"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"extend","id":"cfg-extend"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"inheritableStatics","id":"cfg-inheritableStatics"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"mixins","id":"cfg-mixins"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"override","id":"cfg-override"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"requires","id":"cfg-requires"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"singleton","id":"cfg-singleton"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"statics","id":"cfg-statics"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.Class","template":null,"required":false,"protected":false,"name":"uses","id":"cfg-uses"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Class","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"}],"event":[]},"private":false,"component":false,"name":"Ext.Class","alternateClassNames":[],"id":"class-Ext.Class","mixedInto":[],"xtypes":{},"files":[{"href":"Class.html#Ext-Class","filename":"Class.js"}]}); \ No newline at end of file