docs/output/Ext.state.Manager.js

   1 Ext.data.JsonP.Ext_state_Manager({
   2   "tagname": "class",
   3   "name": "Ext.state.Manager",
   4   "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",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": "Evan Trimboli <evan@sencha.com>",
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "clear",
  24       "member": "Ext.state.Manager",
  25       "doc": "<p>Clears a value from the state</p>\n",
  26       "params": [
  27         {
  28           "type": "String",
  29           "name": "name",
  30           "doc": "<p>The key name</p>\n",
  31           "optional": false
  32         }
  33       ],
  34       "return": {
  35         "type": "void",
  36         "doc": "\n"
  37       },
  38       "private": false,
  39       "static": false,
  40       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js",
  41       "linenr": 55,
  42       "html_filename": "Manager4.html",
  43       "href": "Manager4.html#Ext-state-Manager-method-clear",
  44       "shortDoc": "<p>Clears a value from the state</p>\n"
  45     },
  46     {
  47       "tagname": "method",
  48       "name": "get",
  49       "member": "Ext.state.Manager",
  50       "doc": "<p>Returns the current value for a key</p>\n",
  51       "params": [
  52         {
  53           "type": "String",
  54           "name": "name",
  55           "doc": "<p>The key name</p>\n",
  56           "optional": false
  57         },
  58         {
  59           "type": "Mixed",
  60           "name": "defaultValue",
  61           "doc": "<p>The default value to return if the key lookup does not match</p>\n",
  62           "optional": false
  63         }
  64       ],
  65       "return": {
  66         "type": "Mixed",
  67         "doc": "<p>The state data</p>\n"
  68       },
  69       "private": false,
  70       "static": false,
  71       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js",
  72       "linenr": 36,
  73       "html_filename": "Manager4.html",
  74       "href": "Manager4.html#Ext-state-Manager-method-get",
  75       "shortDoc": "<p>Returns the current value for a key</p>\n"
  76     },
  77     {
  78       "tagname": "method",
  79       "name": "getProvider",
  80       "member": "Ext.state.Manager",
  81       "doc": "<p>Gets the currently configured state provider</p>\n",
  82       "params": [
  83
  84       ],
  85       "return": {
  86         "type": "Provider",
  87         "doc": "<p>The state provider</p>\n"
  88       },
  89       "private": false,
  90       "static": false,
  91       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js",
  92       "linenr": 63,
  93       "html_filename": "Manager4.html",
  94       "href": "Manager4.html#Ext-state-Manager-method-getProvider",
  95       "shortDoc": "<p>Gets the currently configured state provider</p>\n"
  96     },
  97     {
  98       "tagname": "method",
  99       "name": "set",
 100       "member": "Ext.state.Manager",
 101       "doc": "<p>Sets the value for a key</p>\n",
 102       "params": [
 103         {
 104           "type": "String",
 105           "name": "name",
 106           "doc": "<p>The key name</p>\n",
 107           "optional": false
 108         },
 109         {
 110           "type": "Mixed",
 111           "name": "value",
 112           "doc": "<p>The state data</p>\n",
 113           "optional": false
 114         }
 115       ],
 116       "return": {
 117         "type": "void",
 118         "doc": "\n"
 119       },
 120       "private": false,
 121       "static": false,
 122       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js",
 123       "linenr": 46,
 124       "html_filename": "Manager4.html",
 125       "href": "Manager4.html#Ext-state-Manager-method-set",
 126       "shortDoc": "<p>Sets the value for a key</p>\n"
 127     },
 128     {
 129       "tagname": "method",
 130       "name": "setProvider",
 131       "member": "Ext.state.Manager",
 132       "doc": "<p>Configures the default state provider for your application</p>\n",
 133       "params": [
 134         {
 135           "type": "Provider",
 136           "name": "stateProvider",
 137           "doc": "<p>The state provider to set</p>\n",
 138           "optional": false
 139         }
 140       ],
 141       "return": {
 142         "type": "void",
 143         "doc": "\n"
 144       },
 145       "private": false,
 146       "static": false,
 147       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js",
 148       "linenr": 28,
 149       "html_filename": "Manager4.html",
 150       "href": "Manager4.html#Ext-state-Manager-method-setProvider",
 151       "shortDoc": "<p>Configures the default state provider for your application</p>\n"
 152     }
 153   ],
 154   "property": [
 155
 156   ],
 157   "event": [
 158
 159   ],
 160   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js",
 161   "linenr": 1,
 162   "html_filename": "Manager4.html",
 163   "href": "Manager4.html#Ext-state-Manager",
 164   "cssVar": [
 165
 166   ],
 167   "cssMixin": [
 168
 169   ],
 170   "component": false,
 171   "superclasses": [
 172
 173   ],
 174   "subclasses": [
 175
 176   ],
 177   "mixedInto": [
 178
 179   ],
 180   "allMixins": [
 181
 182   ]
 183 });