docs/output/Ext.Base.js

   1 Ext.data.JsonP.Ext_Base({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": "Jacky Nguyen <jacky@sencha.com>",
   7   "members": {
   8     "cfg": [
   9
  10     ],
  11     "method": [
  12       {
  13         "deprecated": null,
  14         "alias": null,
  15         "protected": false,
  16         "tagname": "method",
  17         "href": "Base3.html#Ext-Base-method-addStatics",
  18         "shortDoc": "Add / override static properties of this class. ...",
  19         "static": true,
  20         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
  21         "private": false,
  22         "params": [
  23           {
  24             "type": "Object",
  25             "optional": false,
  26             "doc": "\n",
  27             "name": "members"
  28           }
  29         ],
  30         "name": "addStatics",
  31         "owner": "Ext.Base",
  32         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>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</code></pre>\n",
  33         "linenr": 388,
  34         "return": {
  35           "type": "Ext.Base",
  36           "doc": "<p>this</p>\n"
  37         },
  38         "html_filename": "Base3.html"
  39       },
  40       {
  41         "deprecated": null,
  42         "alias": null,
  43         "protected": false,
  44         "tagname": "method",
  45         "href": "Base3.html#Ext-Base-method-callOverridden",
  46         "shortDoc": "Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n    constructor: functi...",
  47         "static": false,
  48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
  49         "private": false,
  50         "params": [
  51           {
  52             "type": "Array/Arguments",
  53             "optional": false,
  54             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
  55             "name": "args"
  56           }
  57         ],
  58         "name": "callOverridden",
  59         "owner": "Ext.Base",
  60         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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</code></pre>\n",
  61         "linenr": 269,
  62         "return": {
  63           "type": "Mixed",
  64           "doc": "<p>Returns the result after calling the overridden method</p>\n"
  65         },
  66         "html_filename": "Base3.html"
  67       },
  68       {
  69         "deprecated": null,
  70         "alias": null,
  71         "protected": true,
  72         "tagname": "method",
  73         "href": "Base3.html#Ext-Base-method-callParent",
  74         "shortDoc": "Call the parent's overridden method. ...",
  75         "static": false,
  76         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
  77         "private": false,
  78         "params": [
  79           {
  80             "type": "Array/Arguments",
  81             "optional": false,
  82             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
  83             "name": "args"
  84           }
  85         ],
  86         "name": "callParent",
  87         "owner": "Ext.Base",
  88         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
  89         "linenr": 124,
  90         "return": {
  91           "type": "Mixed",
  92           "doc": "<p>Returns the result from the superclass' method</p>\n"
  93         },
  94         "html_filename": "Base3.html"
  95       },
  96       {
  97         "deprecated": null,
  98         "alias": null,
  99         "protected": false,
 100         "tagname": "method",
 101         "href": "Base3.html#Ext-Base-method-create",
 102         "shortDoc": "Create a new instance of this Class. ...",
 103         "static": true,
 104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 105         "private": false,
 106         "params": [
 107
 108         ],
 109         "name": "create",
 110         "owner": "Ext.Base",
 111         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
 112         "linenr": 329,
 113         "return": {
 114           "type": "Object",
 115           "doc": "<p>the created instance.</p>\n"
 116         },
 117         "html_filename": "Base3.html"
 118       },
 119       {
 120         "deprecated": null,
 121         "alias": null,
 122         "protected": false,
 123         "tagname": "method",
 124         "href": "Base3.html#Ext-Base-method-createAlias",
 125         "shortDoc": "Create aliases for existing prototype methods. ...",
 126         "static": true,
 127         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 128         "private": false,
 129         "params": [
 130           {
 131             "type": "String/Object",
 132             "optional": false,
 133             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
 134             "name": "alias"
 135           },
 136           {
 137             "type": "String/Object",
 138             "optional": false,
 139             "doc": "<p>The original method name</p>\n",
 140             "name": "origin"
 141           }
 142         ],
 143         "name": "createAlias",
 144         "owner": "Ext.Base",
 145         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>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() -&gt; test.method1()\n</code></pre>\n",
 146         "linenr": 648,
 147         "return": {
 148           "type": "void",
 149           "doc": "\n"
 150         },
 151         "html_filename": "Base3.html"
 152       },
 153       {
 154         "deprecated": null,
 155         "alias": null,
 156         "protected": false,
 157         "tagname": "method",
 158         "href": "Base3.html#Ext-Base-method-getName",
 159         "shortDoc": "Get the current class' name in string format. ...",
 160         "static": false,
 161         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 162         "private": false,
 163         "params": [
 164
 165         ],
 166         "name": "getName",
 167         "owner": "Ext.Base",
 168         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>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</code></pre>\n",
 169         "linenr": 631,
 170         "return": {
 171           "type": "String",
 172           "doc": "<p>className</p>\n"
 173         },
 174         "html_filename": "Base3.html"
 175       },
 176       {
 177         "deprecated": null,
 178         "alias": null,
 179         "protected": false,
 180         "tagname": "method",
 181         "href": "Base3.html#Ext-Base-method-implement",
 182         "shortDoc": "Add methods / properties to the prototype of this class. ...",
 183         "static": true,
 184         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 185         "private": false,
 186         "params": [
 187           {
 188             "type": "Object",
 189             "optional": false,
 190             "doc": "\n",
 191             "name": "members"
 192           }
 193         ],
 194         "name": "implement",
 195         "owner": "Ext.Base",
 196         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
 197         "linenr": 415,
 198         "return": {
 199           "type": "void",
 200           "doc": "\n"
 201         },
 202         "html_filename": "Base3.html"
 203       },
 204       {
 205         "deprecated": null,
 206         "alias": null,
 207         "protected": true,
 208         "tagname": "method",
 209         "href": "Base3.html#Ext-Base-method-initConfig",
 210         "shortDoc": "Initialize configuration for this class. ...",
 211         "static": false,
 212         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 213         "private": false,
 214         "params": [
 215           {
 216             "type": "Object",
 217             "optional": false,
 218             "doc": "\n",
 219             "name": "config"
 220           }
 221         ],
 222         "name": "initConfig",
 223         "owner": "Ext.Base",
 224         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>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        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
 225         "linenr": 63,
 226         "return": {
 227           "type": "Object",
 228           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
 229         },
 230         "html_filename": "Base3.html"
 231       },
 232       {
 233         "deprecated": null,
 234         "alias": null,
 235         "protected": false,
 236         "tagname": "method",
 237         "href": "Base3.html#Ext-Base-method-override",
 238         "shortDoc": "Override prototype members of this class. ...",
 239         "static": true,
 240         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 241         "private": false,
 242         "params": [
 243           {
 244             "type": "Object",
 245             "optional": false,
 246             "doc": "\n",
 247             "name": "members"
 248           }
 249         ],
 250         "name": "override",
 251         "owner": "Ext.Base",
 252         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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</code></pre>\n",
 253         "linenr": 518,
 254         "return": {
 255           "type": "Ext.Base",
 256           "doc": "<p>this</p>\n"
 257         },
 258         "html_filename": "Base3.html"
 259       },
 260       {
 261         "deprecated": null,
 262         "alias": null,
 263         "protected": true,
 264         "tagname": "method",
 265         "href": "Base3.html#Ext-Base-method-statics",
 266         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
 267         "static": false,
 268         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 269         "private": false,
 270         "params": [
 271
 272         ],
 273         "name": "statics",
 274         "owner": "Ext.Base",
 275         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>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        return this;\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</code></pre>\n",
 276         "linenr": 199,
 277         "return": {
 278           "type": "Class",
 279           "doc": "\n"
 280         },
 281         "html_filename": "Base3.html"
 282       }
 283     ],
 284     "property": [
 285       {
 286         "type": "Class",
 287         "deprecated": null,
 288         "alias": null,
 289         "protected": true,
 290         "tagname": "property",
 291         "href": "Base3.html#Ext-Base-property-self",
 292         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
 293         "static": false,
 294         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 295         "private": false,
 296         "name": "self",
 297         "owner": "Ext.Base",
 298         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">statics</a>\nfor a detailed comparison</p>\n\n<pre><code>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        return 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</code></pre>\n",
 299         "linenr": 18,
 300         "html_filename": "Base3.html"
 301       }
 302     ],
 303     "cssVar": [
 304
 305     ],
 306     "cssMixin": [
 307
 308     ],
 309     "event": [
 310
 311     ]
 312   },
 313   "singleton": false,
 314   "alias": null,
 315   "superclasses": [
 316
 317   ],
 318   "protected": false,
 319   "tagname": "class",
 320   "mixins": [
 321
 322   ],
 323   "href": "Base3.html#Ext-Base",
 324   "subclasses": [
 325     "Ext.dd.StatusProxy",
 326     "Ext.dd.ScrollManager",
 327     "Ext.dd.DragTracker",
 328     "Ext.dd.DragDropManager",
 329     "Ext.dd.Registry",
 330     "Ext.dd.DragDrop",
 331     "Ext.util.Animate",
 332     "Ext.util.History",
 333     "Ext.util.KeyMap",
 334     "Ext.util.CSS",
 335     "Ext.util.Floating",
 336     "Ext.util.TextMetrics",
 337     "Ext.util.KeyNav",
 338     "Ext.util.Cookies",
 339     "Ext.form.FieldAncestor",
 340     "Ext.form.action.Action",
 341     "Ext.form.Labelable",
 342     "Ext.form.field.Field",
 343     "Ext.form.field.VTypes",
 344     "Ext.ZIndexManager",
 345     "Ext.Action",
 346     "Ext.FocusManager",
 347     "Ext.view.TableChunker",
 348     "Ext.menu.Manager",
 349     "Ext.resizer.Resizer",
 350     "Ext.grid.plugin.Editing",
 351     "Ext.Shadow",
 352     "Ext.tip.QuickTipManager",
 353     "Ext.chart.theme.Theme",
 354     "Ext.chart.Tip",
 355     "Ext.chart.Legend",
 356     "Ext.chart.Callout",
 357     "Ext.chart.series.Series",
 358     "Ext.chart.Navigation",
 359     "Ext.chart.Mask",
 360     "Ext.chart.axis.Abstract",
 361     "Ext.chart.Highlight",
 362     "Ext.chart.Label",
 363     "Ext.LoadMask",
 364     "Ext.util.HashMap",
 365     "Ext.util.Sortable",
 366     "Ext.util.Observable",
 367     "Ext.util.Memento",
 368     "Ext.util.AbstractMixedCollection",
 369     "Ext.app.Controller",
 370     "Ext.AbstractComponent",
 371     "Ext.data.JsonP",
 372     "Ext.data.Types",
 373     "Ext.data.AbstractStore",
 374     "Ext.data.Model",
 375     "Ext.data.proxy.Proxy",
 376     "Ext.data.Batch",
 377     "Ext.data.Connection",
 378     "Ext.data.NodeInterface",
 379     "Ext.data.Tree",
 380     "Ext.data.SortTypes",
 381     "Ext.fx.target.Target",
 382     "Ext.fx.Animator",
 383     "Ext.fx.Anim",
 384     "Ext.ElementLoader",
 385     "Ext.draw.Color",
 386     "Ext.draw.Surface",
 387     "Ext.state.Provider",
 388     "Ext.state.Stateful",
 389     "Ext.state.Manager",
 390     "Ext.Template",
 391     "Ext.direct.Provider",
 392     "Ext.direct.Manager",
 393     "Ext.direct.Event",
 394     "Ext.env.FeatureDetector",
 395     "Ext.env.Browser",
 396     "Ext.env.OS",
 397     "Ext.EventObject"
 398   ],
 399   "static": false,
 400   "author": "Jacky Nguyen <jacky@sencha.com>",
 401   "component": false,
 402   "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 403   "private": false,
 404   "alternateClassNames": [
 405
 406   ],
 407   "name": "Ext.Base",
 408   "doc": "<p>The root of all classes created with <a href=\"#/api/Ext-method-define\" rel=\"Ext-method-define\" class=\"docClass\">Ext.define</a>\nAll prototype and static members of this class are inherited by any other class</p>\n",
 409   "mixedInto": [
 410
 411   ],
 412   "linenr": 1,
 413   "xtypes": [
 414
 415   ],
 416   "html_filename": "Base3.html",
 417   "extends": null
 418 });