X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.util.Cookies.js diff --git a/docs/output/Ext.util.Cookies.js b/docs/output/Ext.util.Cookies.js index 6265de18..1077c8a4 100644 --- a/docs/output/Ext.util.Cookies.js +++ b/docs/output/Ext.util.Cookies.js @@ -1,162 +1 @@ -Ext.data.JsonP.Ext_util_Cookies({ - "tagname": "class", - "name": "Ext.util.Cookies", - "doc": "
Utility class for setting/reading values from browser cookies.\nValues can be written using the set method.\nValues can be read using the get method.\nA cookie can be invalidated on the client machine using the clear method.
\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": true, - "private": false, - "cfg": [ - - ], - "method": [ - { - "tagname": "method", - "name": "clear", - "member": "Ext.util.Cookies", - "doc": "Removes a cookie with the provided name from the browser\nif found by setting its expiration date to sometime in the past.
\n", - "params": [ - { - "type": "String", - "name": "name", - "doc": "The name of the cookie to remove
\n", - "optional": false - }, - { - "type": "String", - "name": "path", - "doc": "(optional) The path for the cookie. This must be included if you included a path while setting the cookie.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", - "linenr": 80, - "html_filename": "Cookies.html", - "href": "Cookies.html#Ext-util-Cookies-method-clear", - "shortDoc": "Removes a cookie with the provided name from the browser\nif found by setting its expiration date to sometime in the p..." - }, - { - "tagname": "method", - "name": "get", - "member": "Ext.util.Cookies", - "doc": "Retrieves cookies that are accessible by the current page. If a cookie\ndoes not exist, get()
returns null. The following\nexample retrieves the cookie called \"valid\" and stores the String value\nin the variable validStatus.
var validStatus = Ext.util.Cookies.get(\"valid\");\n
\n\n",
- "params": [
- {
- "type": "String",
- "name": "name",
- "doc": "The name of the cookie to get
\n", - "optional": false - } - ], - "return": { - "type": "Mixed", - "doc": "Returns the cookie value for the specified name;\nnull if the cookie name does not exist.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", - "linenr": 48, - "html_filename": "Cookies.html", - "href": "Cookies.html#Ext-util-Cookies-method-get", - "shortDoc": "Retrieves cookies that are accessible by the current page. If a cookie\ndoes not exist, get() returns null. The follo..." - }, - { - "tagname": "method", - "name": "set", - "member": "Ext.util.Cookies", - "doc": "Create a cookie with the specified name and value. Additional settings\nfor the cookie may be optionally specified (for example: expiration,\naccess restriction, SSL).
\n", - "params": [ - { - "type": "String", - "name": "name", - "doc": "The name of the cookie to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "value", - "doc": "The value to set for the cookie.
\n", - "optional": false - }, - { - "type": "Object", - "name": "expires", - "doc": "(Optional) Specify an expiration date the\ncookie is to persist until. Note that the specified Date object will\nbe converted to Greenwich Mean Time (GMT).
\n", - "optional": false - }, - { - "type": "String", - "name": "path", - "doc": "(Optional) Setting a path on the cookie restricts\naccess to pages that match that path. Defaults to all pages ('/').
\n", - "optional": false - }, - { - "type": "String", - "name": "domain", - "doc": "(Optional) Setting a domain restricts access to\npages on a given domain (typically used to allow cookie access across\nsubdomains). For example, \"sencha.com\" will create a cookie that can be\naccessed from any subdomain of sencha.com, including www.sencha.com,\nsupport.sencha.com, etc.
\n", - "optional": false - }, - { - "type": "Boolean", - "name": "secure", - "doc": "(Optional) Specify true to indicate that the cookie\nshould only be accessible via SSL on a page using the HTTPS protocol.\nDefaults to false. Note that this will only work if the page\ncalling this code uses the HTTPS protocol, otherwise the cookie will be\ncreated with default options.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", - "linenr": 15, - "html_filename": "Cookies.html", - "href": "Cookies.html#Ext-util-Cookies-method-set", - "shortDoc": "Create a cookie with the specified name and value. Additional settings\nfor the cookie may be optionally specified (fo..." - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Cookies.js", - "linenr": 1, - "html_filename": "Cookies.html", - "href": "Cookies.html#Ext-util-Cookies", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_util_Cookies({"tagname":"class","html":"Hierarchy
Ext.BaseExt.util.CookiesFiles
Utility class for setting/reading values from browser cookies.\nValues can be written using the set method.\nValues can be read using the get method.\nA cookie can be invalidated on the client machine using the clear method.
\nGet 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
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
\nCall the original method that was previously overridden with override
\n\nExt.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
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.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
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves a cookie with the provided name from the browser\nif found by setting its expiration date to sometime in the past.
\nRetrieves cookies that are accessible by the current page. If a cookie\ndoes not exist, get()
returns null. The following\nexample retrieves the cookie called \"valid\" and stores the String value\nin the variable validStatus.
var validStatus = Ext.util.Cookies.get(\"valid\");\n
\n\nThe name of the cookie to get
\nReturns the cookie value for the specified name;\nnull if the cookie name does not exist.
\nInitialize configuration for this class. a typical example:
\n\nExt.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
\nmixins The mixin prototypes as key - value pairs
\nCreate a cookie with the specified name and value. Additional settings\nfor the cookie may be optionally specified (for example: expiration,\naccess restriction, SSL).
\nThe name of the cookie to set.
\nThe value to set for the cookie.
\nSpecify an expiration date the\ncookie is to persist until. Note that the specified Date object will\nbe converted to Greenwich Mean Time (GMT).
\nSetting a path on the cookie restricts\naccess to pages that match that path. Defaults to all pages ('/').
\nSetting a domain restricts access to\npages on a given domain (typically used to allow cookie access across\nsubdomains). For example, \"sencha.com\" will create a cookie that can be\naccessed from any subdomain of sencha.com, including www.sencha.com,\nsupport.sencha.com, etc.
\nSpecify true to indicate that the cookie\nshould only be accessible via SSL on a page using the HTTPS protocol.\nDefaults to false. Note that this will only work if the page\ncalling this code uses the HTTPS protocol, otherwise the cookie will be\ncreated with default options.
\nGet 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
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