docs/output/Ext.state.Manager.js

   1 Ext.data.JsonP.Ext_state_Manager({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": "Evan Trimboli <evan@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 Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
  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\">Ext.Base.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": "Manager3.html#Ext-state-Manager-method-clear",
 102         "shortDoc": "Clears a value from the state ...",
 103         "static": false,
 104         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Manager.js",
 105         "private": false,
 106         "params": [
 107           {
 108             "type": "String",
 109             "optional": false,
 110             "doc": "<p>The key name</p>\n",
 111             "name": "name"
 112           }
 113         ],
 114         "name": "clear",
 115         "owner": "Ext.state.Manager",
 116         "doc": "<p>Clears a value from the state</p>\n",
 117         "linenr": 55,
 118         "return": {
 119           "type": "void",
 120           "doc": "\n"
 121         },
 122         "html_filename": "Manager3.html"
 123       },
 124       {
 125         "deprecated": null,
 126         "alias": null,
 127         "protected": false,
 128         "tagname": "method",
 129         "href": "Base3.html#Ext-Base-method-create",
 130         "shortDoc": "Create a new instance of this Class. ...",
 131         "static": true,
 132         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 133         "private": false,
 134         "params": [
 135
 136         ],
 137         "name": "create",
 138         "owner": "Ext.Base",
 139         "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",
 140         "linenr": 329,
 141         "return": {
 142           "type": "Object",
 143           "doc": "<p>the created instance.</p>\n"
 144         },
 145         "html_filename": "Base3.html"
 146       },
 147       {
 148         "deprecated": null,
 149         "alias": null,
 150         "protected": false,
 151         "tagname": "method",
 152         "href": "Base3.html#Ext-Base-method-createAlias",
 153         "shortDoc": "Create aliases for existing prototype methods. ...",
 154         "static": true,
 155         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 156         "private": false,
 157         "params": [
 158           {
 159             "type": "String/Object",
 160             "optional": false,
 161             "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",
 162             "name": "alias"
 163           },
 164           {
 165             "type": "String/Object",
 166             "optional": false,
 167             "doc": "<p>The original method name</p>\n",
 168             "name": "origin"
 169           }
 170         ],
 171         "name": "createAlias",
 172         "owner": "Ext.Base",
 173         "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",
 174         "linenr": 648,
 175         "return": {
 176           "type": "void",
 177           "doc": "\n"
 178         },
 179         "html_filename": "Base3.html"
 180       },
 181       {
 182         "deprecated": null,
 183         "alias": null,
 184         "protected": false,
 185         "tagname": "method",
 186         "href": "Manager3.html#Ext-state-Manager-method-get",
 187         "shortDoc": "Returns the current value for a key ...",
 188         "static": false,
 189         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Manager.js",
 190         "private": false,
 191         "params": [
 192           {
 193             "type": "String",
 194             "optional": false,
 195             "doc": "<p>The key name</p>\n",
 196             "name": "name"
 197           },
 198           {
 199             "type": "Mixed",
 200             "optional": false,
 201             "doc": "<p>The default value to return if the key lookup does not match</p>\n",
 202             "name": "defaultValue"
 203           }
 204         ],
 205         "name": "get",
 206         "owner": "Ext.state.Manager",
 207         "doc": "<p>Returns the current value for a key</p>\n",
 208         "linenr": 36,
 209         "return": {
 210           "type": "Mixed",
 211           "doc": "<p>The state data</p>\n"
 212         },
 213         "html_filename": "Manager3.html"
 214       },
 215       {
 216         "deprecated": null,
 217         "alias": null,
 218         "protected": false,
 219         "tagname": "method",
 220         "href": "Base3.html#Ext-Base-method-getName",
 221         "shortDoc": "Get the current class' name in string format. ...",
 222         "static": false,
 223         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 224         "private": false,
 225         "params": [
 226
 227         ],
 228         "name": "getName",
 229         "owner": "Ext.Base",
 230         "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",
 231         "linenr": 631,
 232         "return": {
 233           "type": "String",
 234           "doc": "<p>className</p>\n"
 235         },
 236         "html_filename": "Base3.html"
 237       },
 238       {
 239         "deprecated": null,
 240         "alias": null,
 241         "protected": false,
 242         "tagname": "method",
 243         "href": "Manager3.html#Ext-state-Manager-method-getProvider",
 244         "shortDoc": "Gets the currently configured state provider ...",
 245         "static": false,
 246         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Manager.js",
 247         "private": false,
 248         "params": [
 249
 250         ],
 251         "name": "getProvider",
 252         "owner": "Ext.state.Manager",
 253         "doc": "<p>Gets the currently configured state provider</p>\n",
 254         "linenr": 63,
 255         "return": {
 256           "type": "Provider",
 257           "doc": "<p>The state provider</p>\n"
 258         },
 259         "html_filename": "Manager3.html"
 260       },
 261       {
 262         "deprecated": null,
 263         "alias": null,
 264         "protected": false,
 265         "tagname": "method",
 266         "href": "Base3.html#Ext-Base-method-implement",
 267         "shortDoc": "Add methods / properties to the prototype of this class. ...",
 268         "static": true,
 269         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 270         "private": false,
 271         "params": [
 272           {
 273             "type": "Object",
 274             "optional": false,
 275             "doc": "\n",
 276             "name": "members"
 277           }
 278         ],
 279         "name": "implement",
 280         "owner": "Ext.Base",
 281         "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",
 282         "linenr": 415,
 283         "return": {
 284           "type": "void",
 285           "doc": "\n"
 286         },
 287         "html_filename": "Base3.html"
 288       },
 289       {
 290         "deprecated": null,
 291         "alias": null,
 292         "protected": true,
 293         "tagname": "method",
 294         "href": "Base3.html#Ext-Base-method-initConfig",
 295         "shortDoc": "Initialize configuration for this class. ...",
 296         "static": false,
 297         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 298         "private": false,
 299         "params": [
 300           {
 301             "type": "Object",
 302             "optional": false,
 303             "doc": "\n",
 304             "name": "config"
 305           }
 306         ],
 307         "name": "initConfig",
 308         "owner": "Ext.Base",
 309         "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",
 310         "linenr": 63,
 311         "return": {
 312           "type": "Object",
 313           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
 314         },
 315         "html_filename": "Base3.html"
 316       },
 317       {
 318         "deprecated": null,
 319         "alias": null,
 320         "protected": false,
 321         "tagname": "method",
 322         "href": "Base3.html#Ext-Base-method-override",
 323         "shortDoc": "Override prototype members of this class. ...",
 324         "static": true,
 325         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 326         "private": false,
 327         "params": [
 328           {
 329             "type": "Object",
 330             "optional": false,
 331             "doc": "\n",
 332             "name": "members"
 333           }
 334         ],
 335         "name": "override",
 336         "owner": "Ext.Base",
 337         "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\">Ext.Base.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",
 338         "linenr": 518,
 339         "return": {
 340           "type": "Ext.Base",
 341           "doc": "<p>this</p>\n"
 342         },
 343         "html_filename": "Base3.html"
 344       },
 345       {
 346         "deprecated": null,
 347         "alias": null,
 348         "protected": false,
 349         "tagname": "method",
 350         "href": "Manager3.html#Ext-state-Manager-method-set",
 351         "shortDoc": "Sets the value for a key ...",
 352         "static": false,
 353         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Manager.js",
 354         "private": false,
 355         "params": [
 356           {
 357             "type": "String",
 358             "optional": false,
 359             "doc": "<p>The key name</p>\n",
 360             "name": "name"
 361           },
 362           {
 363             "type": "Mixed",
 364             "optional": false,
 365             "doc": "<p>The state data</p>\n",
 366             "name": "value"
 367           }
 368         ],
 369         "name": "set",
 370         "owner": "Ext.state.Manager",
 371         "doc": "<p>Sets the value for a key</p>\n",
 372         "linenr": 46,
 373         "return": {
 374           "type": "void",
 375           "doc": "\n"
 376         },
 377         "html_filename": "Manager3.html"
 378       },
 379       {
 380         "deprecated": null,
 381         "alias": null,
 382         "protected": false,
 383         "tagname": "method",
 384         "href": "Manager3.html#Ext-state-Manager-method-setProvider",
 385         "shortDoc": "Configures the default state provider for your application ...",
 386         "static": false,
 387         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Manager.js",
 388         "private": false,
 389         "params": [
 390           {
 391             "type": "Provider",
 392             "optional": false,
 393             "doc": "<p>The state provider to set</p>\n",
 394             "name": "stateProvider"
 395           }
 396         ],
 397         "name": "setProvider",
 398         "owner": "Ext.state.Manager",
 399         "doc": "<p>Configures the default state provider for your application</p>\n",
 400         "linenr": 28,
 401         "return": {
 402           "type": "void",
 403           "doc": "\n"
 404         },
 405         "html_filename": "Manager3.html"
 406       },
 407       {
 408         "deprecated": null,
 409         "alias": null,
 410         "protected": true,
 411         "tagname": "method",
 412         "href": "Base3.html#Ext-Base-method-statics",
 413         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
 414         "static": false,
 415         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 416         "private": false,
 417         "params": [
 418
 419         ],
 420         "name": "statics",
 421         "owner": "Ext.Base",
 422         "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\">Ext.Base.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",
 423         "linenr": 199,
 424         "return": {
 425           "type": "Class",
 426           "doc": "\n"
 427         },
 428         "html_filename": "Base3.html"
 429       }
 430     ],
 431     "property": [
 432       {
 433         "type": "Class",
 434         "deprecated": null,
 435         "alias": null,
 436         "protected": true,
 437         "tagname": "property",
 438         "href": "Base3.html#Ext-Base-property-self",
 439         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
 440         "static": false,
 441         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 442         "private": false,
 443         "name": "self",
 444         "owner": "Ext.Base",
 445         "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\">Ext.Base.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\">Ext.Base.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",
 446         "linenr": 18,
 447         "html_filename": "Base3.html"
 448       }
 449     ],
 450     "cssVar": [
 451
 452     ],
 453     "cssMixin": [
 454
 455     ],
 456     "event": [
 457
 458     ]
 459   },
 460   "singleton": true,
 461   "alias": null,
 462   "superclasses": [
 463     "Ext.Base"
 464   ],
 465   "protected": false,
 466   "tagname": "class",
 467   "mixins": [
 468
 469   ],
 470   "href": "Manager3.html#Ext-state-Manager",
 471   "subclasses": [
 472
 473   ],
 474   "static": false,
 475   "author": null,
 476   "component": false,
 477   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Manager.js",
 478   "private": false,
 479   "alternateClassNames": [
 480
 481   ],
 482   "name": "Ext.state.Manager",
 483   "doc": "<p>This is the global state manager. By default all components that are \"state aware\" check this class\nfor state information if you don't pass them a custom state provider. In order for this class\nto be useful, it must be initialized with a provider when your application initializes. Example usage:</p>\n\n<pre><code>// in your initialization function\ninit : function(){\n   Ext.state.Manager.setProvider(new Ext.state.CookieProvider());\n   var win = new Window(...);\n   win.restoreState();\n}\n </code></pre>\n\n\n<p>This class passes on calls from components to the underlying <a href=\"#/api/Ext.state.Provider\" rel=\"Ext.state.Provider\" class=\"docClass\">Ext.state.Provider</a> so that\nthere is a common interface that can be used without needing to refer to a specific provider instance\nin every component.</p>\n",
 484   "mixedInto": [
 485
 486   ],
 487   "linenr": 1,
 488   "xtypes": [
 489
 490   ],
 491   "html_filename": "Manager3.html",
 492   "extends": "Ext.Base"
 493 });