X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.state.Manager.js diff --git a/docs/output/Ext.state.Manager.js b/docs/output/Ext.state.Manager.js index 7389e40d..09a55ab1 100644 --- a/docs/output/Ext.state.Manager.js +++ b/docs/output/Ext.state.Manager.js @@ -1,183 +1 @@ -Ext.data.JsonP.Ext_state_Manager({ - "tagname": "class", - "name": "Ext.state.Manager", - "doc": "

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:

\n\n
// 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 
\n\n\n

This class passes on calls from components to the underlying Ext.state.Provider so that\nthere is a common interface that can be used without needing to refer to a specific provider instance\nin every component.

\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": "Evan Trimboli ", - "singleton": true, - "private": false, - "cfg": [ - - ], - "method": [ - { - "tagname": "method", - "name": "clear", - "member": "Ext.state.Manager", - "doc": "

Clears a value from the state

\n", - "params": [ - { - "type": "String", - "name": "name", - "doc": "

The key name

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js", - "linenr": 55, - "html_filename": "Manager4.html", - "href": "Manager4.html#Ext-state-Manager-method-clear", - "shortDoc": "

Clears a value from the state

\n" - }, - { - "tagname": "method", - "name": "get", - "member": "Ext.state.Manager", - "doc": "

Returns the current value for a key

\n", - "params": [ - { - "type": "String", - "name": "name", - "doc": "

The key name

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

The default value to return if the key lookup does not match

\n", - "optional": false - } - ], - "return": { - "type": "Mixed", - "doc": "

The state data

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js", - "linenr": 36, - "html_filename": "Manager4.html", - "href": "Manager4.html#Ext-state-Manager-method-get", - "shortDoc": "

Returns the current value for a key

\n" - }, - { - "tagname": "method", - "name": "getProvider", - "member": "Ext.state.Manager", - "doc": "

Gets the currently configured state provider

\n", - "params": [ - - ], - "return": { - "type": "Provider", - "doc": "

The state provider

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js", - "linenr": 63, - "html_filename": "Manager4.html", - "href": "Manager4.html#Ext-state-Manager-method-getProvider", - "shortDoc": "

Gets the currently configured state provider

\n" - }, - { - "tagname": "method", - "name": "set", - "member": "Ext.state.Manager", - "doc": "

Sets the value for a key

\n", - "params": [ - { - "type": "String", - "name": "name", - "doc": "

The key name

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

The state data

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js", - "linenr": 46, - "html_filename": "Manager4.html", - "href": "Manager4.html#Ext-state-Manager-method-set", - "shortDoc": "

Sets the value for a key

\n" - }, - { - "tagname": "method", - "name": "setProvider", - "member": "Ext.state.Manager", - "doc": "

Configures the default state provider for your application

\n", - "params": [ - { - "type": "Provider", - "name": "stateProvider", - "doc": "

The state provider to set

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js", - "linenr": 28, - "html_filename": "Manager4.html", - "href": "Manager4.html#Ext-state-Manager-method-setProvider", - "shortDoc": "

Configures the default state provider for your application

\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Manager.js", - "linenr": 1, - "html_filename": "Manager4.html", - "href": "Manager4.html#Ext-state-Manager", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_state_Manager({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.state.Manager

Requires

Files

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:

\n\n
// 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 
\n\n\n

This class passes on calls from components to the underlying Ext.state.Provider so that\nthere is a common interface that can be used without needing to refer to a specific provider instance\nin every component.

\n
Defined By

Properties

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        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
\n
Defined By

Methods

( Array/Arguments args ) : Objectprotected
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        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
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
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
\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 from the superclass' method

    \n
Clears a value from the state ...

Clears a value from the state

\n

Parameters

Returns the current value for a key ...

Returns the current value for a key

\n

Parameters

  • name : String

    The key name

    \n
  • defaultValue : Object

    The default value to return if the key lookup does not match

    \n

Returns

Gets the currently configured state provider ...

Gets the currently configured state provider

\n

Returns

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        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
Sets the value for a key ...

Sets the value for a key

\n

Parameters

Configures the default state provider for your application ...

Configures the default state provider for your application

\n

Parameters

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        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
\n

Returns

","allMixins":[],"meta":{"docauthor":["Evan Trimboli "]},"requires":["Ext.state.Provider"],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.state.Manager"],"singleton":true,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"}],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.state.Manager","template":false,"required":null,"protected":false,"name":"clear","id":"method-clear"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.state.Manager","template":false,"required":null,"protected":false,"name":"get","id":"method-get"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.state.Manager","template":false,"required":null,"protected":false,"name":"getProvider","id":"method-getProvider"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.state.Manager","template":false,"required":null,"protected":false,"name":"set","id":"method-set"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.state.Manager","template":false,"required":null,"protected":false,"name":"setProvider","id":"method-setProvider"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"}],"event":[]},"private":false,"component":false,"name":"Ext.state.Manager","alternateClassNames":[],"id":"class-Ext.state.Manager","mixedInto":[],"xtypes":{},"files":[{"href":"Manager4.html#Ext-state-Manager","filename":"Manager.js"}]}); \ No newline at end of file