X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.data.writer.Json.js?ds=inline diff --git a/docs/output/Ext.data.writer.Json.js b/docs/output/Ext.data.writer.Json.js index de7e6d70..4075b9ba 100644 --- a/docs/output/Ext.data.writer.Json.js +++ b/docs/output/Ext.data.writer.Json.js @@ -1,190 +1 @@ -Ext.data.JsonP.Ext_data_writer_Json({ - "tagname": "class", - "name": "Ext.data.writer.Json", - "doc": "
This class is used to write Ext.data.Model data to the server in a JSON format.\nThe allowSingle configuration can be set to false to force the records to always be\nencoded in an array, even if there is only a single record being sent.
\n", - "extends": "Ext.data.writer.Writer", - "mixins": [ - - ], - "alternateClassNames": [ - "Ext.data.JsonWriter" - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "allowSingle", - "member": "Ext.data.writer.Json", - "type": "Boolean", - "doc": "False to ensure that records are always wrapped in an array, even if there is only\none record being sent. When there is more than one record, they will always be encoded into an array.\nDefaults to true. Example:
\n\n// with allowSingle: true\n\"root\": {\n \"first\": \"Mark\",\n \"last\": \"Corrigan\"\n}\n\n// with allowSingle: false\n\"root\": [{\n \"first\": \"Mark\",\n \"last\": \"Corrigan\"\n}]\n
\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Json.js",
- "linenr": 33,
- "html_filename": "Json2.html",
- "href": "Json2.html#Ext-data-writer-Json-cfg-allowSingle",
- "shortDoc": "False to ensure that records are always wrapped in an array, even if there is only\none record being sent. When there ..."
- },
- {
- "tagname": "cfg",
- "name": "encode",
- "member": "Ext.data.writer.Json",
- "type": "Boolean",
- "doc": "True to use Ext.encode() on the data before sending. Defaults to false.\nThe encode option should only be set to true when a root is defined, because the values will be\nsent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter\nsent to the server.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Json.js", - "linenr": 25, - "html_filename": "Json2.html", - "href": "Json2.html#Ext-data-writer-Json-cfg-encode", - "shortDoc": "True to use Ext.encode() on the data before sending. Defaults to false.\nThe encode option should only be set to true ..." - }, - { - "tagname": "cfg", - "name": "nameProperty", - "member": "Ext.data.writer.Writer", - "type": "String", - "doc": "This property is used to read the key for each value that will be sent to the server.\nFor example:
\n\nExt.define('Person', {\n extend: 'Ext.data.Model',\n fields: [{\n name: 'first',\n mapping: 'firstName'\n }, {\n name: 'last',\n mapping: 'lastName'\n }, {\n name: 'age'\n }]\n});\nnew Ext.data.writer.Writer({\n writeAllFields: true,\n nameProperty: 'mapping'\n});\n\n// This will be sent to the server\n{\n firstName: 'first name value',\n lastName: 'last name value',\n age: 1\n}\n\n
\n\n\nDefaults to name. If the value is not present, the field name will always be used.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 32, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-cfg-nameProperty", - "shortDoc": "This property is used to read the key for each value that will be sent to the server.\nFor example:\n\nExt.define('Perso..." - }, - { - "tagname": "cfg", - "name": "root", - "member": "Ext.data.writer.Json", - "type": "String", - "doc": "The key under which the records in this Writer will be placed. Defaults to undefined.\nExample generated request, using root: 'records':
\n\n{'records': [{name: 'my record'}, {name: 'another record'}]}\n
\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Json.js",
- "linenr": 16,
- "html_filename": "Json2.html",
- "href": "Json2.html#Ext-data-writer-Json-cfg-root",
- "shortDoc": "The key under which the records in this Writer will be placed. Defaults to undefined.\nExample generated request, usin..."
- },
- {
- "tagname": "cfg",
- "name": "writeAllFields",
- "member": "Ext.data.writer.Writer",
- "type": "Boolean",
- "doc": "True to write all fields from the record to the server. If set to false it\nwill only send the fields that were modified. Defaults to true. Note that any fields that have\nExt.data.Field.persist set to false will still be ignored.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 25, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields", - "shortDoc": "True to write all fields from the record to the server. If set to false it\nwill only send the fields that were modifi..." - } - ], - "method": [ - { - "tagname": "method", - "name": "Json", - "member": "Ext.data.writer.Writer", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "config", - "doc": "Optional config object
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 1, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "getRecordData", - "member": "Ext.data.writer.Writer", - "doc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data in a way that differs from the default.
\n", - "params": [ - { - "type": "Object", - "name": "record", - "doc": "The record that we are writing to the server.
\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "An object literal of name/value keys to be written to the server.\nBy default this method returns the data property on the record.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 87, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData", - "shortDoc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data..." - }, - { - "tagname": "method", - "name": "write", - "member": "Ext.data.writer.Writer", - "doc": "Prepares a Proxy's Ext.data.Request object
\n", - "params": [ - { - "type": "Ext.data.Request", - "name": "request", - "doc": "The request object
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.Request", - "doc": "The modified request object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 69, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-method-write", - "shortDoc": "Prepares a Proxy's Ext.data.Request object
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Json.js", - "linenr": 1, - "html_filename": "Json2.html", - "href": "Json2.html#Ext-data-writer-Json", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.data.writer.Writer" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_writer_Json({"tagname":"class","html":"Alternate names
Ext.data.JsonWriterHierarchy
Ext.BaseExt.data.writer.WriterExt.data.writer.JsonFiles
This class is used to write Ext.data.Model data to the server in a JSON format.\nThe allowSingle configuration can be set to false to force the records to always be\nencoded in an array, even if there is only a single record being sent.
\nFalse to ensure that records are always wrapped in an array, even if there is only\none record being sent. When there is more than one record, they will always be encoded into an array.\nDefaults to true. Example:
\n\n// with allowSingle: true\n\"root\": {\n \"first\": \"Mark\",\n \"last\": \"Corrigan\"\n}\n\n// with allowSingle: false\n\"root\": [{\n \"first\": \"Mark\",\n \"last\": \"Corrigan\"\n}]\n
\n\nDefaults to: true
True to use Ext.encode() on the data before sending. Defaults to false.\nThe encode option should only be set to true when a root is defined, because the values will be\nsent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter\nsent to the server.
\nDefaults to: false
This property is used to read the key for each value that will be sent to the server. For example:
\n\nExt.define('Person', {\n extend: 'Ext.data.Model',\n fields: [{\n name: 'first',\n mapping: 'firstName'\n }, {\n name: 'last',\n mapping: 'lastName'\n }, {\n name: 'age'\n }]\n});\nnew Ext.data.writer.Writer({\n writeAllFields: true,\n nameProperty: 'mapping'\n});\n\n// This will be sent to the server\n{\n firstName: 'first name value',\n lastName: 'last name value',\n age: 1\n}\n
\n\nIf the value is not present, the field name will always be used.
\nDefaults to: "name"
The key under which the records in this Writer will be placed. Defaults to undefined.\nExample generated request, using root: 'records':
\n\n{'records': [{name: 'my record'}, {name: 'another record'}]}\n
\n\nTrue to write all fields from the record to the server. If set to false it will only send the fields that were\nmodified. Note that any fields that have Ext.data.Field.persist set to false will still be ignored.
\nDefaults to: true
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
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
\nFormats the data for each record before sending it to the server. This method should be overridden to format the\ndata in a way that differs from the default.
\nThe record that we are writing to the server.
\nAn object literal of name/value keys to be written to the server. By default this method returns\nthe data property on the record.
\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
\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
\nPrepares a Proxy's Ext.data.Request object
\nThe request object
\nThe modified request object
\nAdd / override static properties of this class.
\n\nExt.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
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.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() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.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
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.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
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\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
\nthis
\n