This class is used to write Ext.data.Model data to the server in an XML format.\nThe documentRoot property is used to specify the root element in the XML document.\nThe record option is used to specify the element name for each record that will make\nup the XML document.
\n", - "extends": "Ext.data.writer.Writer", - "mixins": [ + "allMixins": [ ], - "alternateClassNames": [ - "Ext.data.XmlWriter" - ], - "xtype": null, - "author": "Ed Spencer", + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "defaultDocumentRoot", - "member": "Ext.data.writer.Xml", - "type": "String", - "doc": "The root to be used if documentRoot is empty and a root is required\nto form a valid XML document.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js", - "linenr": 31, - "html_filename": "Xml2.html", - "href": "Xml2.html#Ext-data-writer-Xml-cfg-defaultDocumentRoot" - }, - { - "tagname": "cfg", - "name": "documentRoot", - "member": "Ext.data.writer.Xml", - "type": "String", - "doc": "The name of the root element of the document. Defaults to 'xmlData'.\nIf there is more than 1 record and the root is not specified, the default document root will still be used\nto ensure a valid XML document is created.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js", - "linenr": 24, - "html_filename": "Xml2.html", - "href": "Xml2.html#Ext-data-writer-Xml-cfg-documentRoot", - "shortDoc": "The name of the root element of the document. Defaults to 'xmlData'.\nIf there is more than 1 record and the root is n..." - }, - { - "tagname": "cfg", - "name": "header", - "member": "Ext.data.writer.Xml", - "type": "String", - "doc": "A header to use in the XML document (such as setting the encoding or version).\nDefaults to ''.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js", - "linenr": 37, - "html_filename": "Xml2.html", - "href": "Xml2.html#Ext-data-writer-Xml-cfg-header" - }, - { - "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\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": "record", - "member": "Ext.data.writer.Xml", - "type": "String", - "doc": "The name of the node to use for each record. Defaults to 'record'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js", - "linenr": 43, - "html_filename": "Xml2.html", - "href": "Xml2.html#Ext-data-writer-Xml-cfg-record" - }, - { - "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": "Xml", - "member": "Ext.data.writer.Writer", - "doc": "\n", - "params": [ - { + "members": { + "cfg": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Xml2.html#Ext-data-writer-Xml-cfg-defaultDocumentRoot", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js", + "private": false, + "name": "defaultDocumentRoot", + "owner": "Ext.data.writer.Xml", + "doc": "The root to be used if documentRoot is empty and a root is required\nto form a valid XML document.
\n", + "linenr": 31, + "html_filename": "Xml2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Xml2.html#Ext-data-writer-Xml-cfg-documentRoot", + "shortDoc": "The name of the root element of the document. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js", + "private": false, + "name": "documentRoot", + "owner": "Ext.data.writer.Xml", + "doc": "The name of the root element of the document. Defaults to 'xmlData'.\nIf there is more than 1 record and the root is not specified, the default document root will still be used\nto ensure a valid XML document is created.
\n", + "linenr": 24, + "html_filename": "Xml2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Xml2.html#Ext-data-writer-Xml-cfg-header", + "shortDoc": "A header to use in the XML document (such as setting the encoding or version). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js", + "private": false, + "name": "header", + "owner": "Ext.data.writer.Xml", + "doc": "A header to use in the XML document (such as setting the encoding or version).\nDefaults to ''.
\n", + "linenr": 37, + "html_filename": "Xml2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "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. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "name": "nameProperty", + "owner": "Ext.data.writer.Writer", + "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\nDefaults to name. If the value is not present, the field name will always be used.
\n", + "linenr": 29, + "html_filename": "Writer.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Xml2.html#Ext-data-writer-Xml-cfg-record", + "shortDoc": "The name of the node to use for each record. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js", + "private": false, + "name": "record", + "owner": "Ext.data.writer.Xml", + "doc": "The name of the node to use for each record. Defaults to 'record'.
\n", + "linenr": 43, + "html_filename": "Xml2.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields", + "shortDoc": "True to write all fields from the record to the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "name": "writeAllFields", + "owner": "Ext.data.writer.Writer", + "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", + "linenr": 22, + "html_filename": "Writer.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Writer.html#Ext-data-writer-Writer-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new Writer. ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "(optional) Config object.
\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "doc": "Creates new Writer.
\n", + "owner": "Ext.data.writer.Writer", + "name": "Xml", + "html_filename": "Writer.html", + "return": { "type": "Object", - "name": "config", - "doc": "Optional config object
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "\n" + }, + "linenr": 62 }, - "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": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData", + "shortDoc": "Formats the data for each record before sending it to the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The record that we are writing to the server.
\n", + "name": "record" + } + ], + "name": "getRecordData", + "owner": "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", + "linenr": 88, + "return": { "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" + "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" + }, + "html_filename": "Writer.html" }, - "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": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Writer.html#Ext-data-writer-Writer-method-write", + "shortDoc": "Prepares a Proxy's Ext.data.Request object ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "params": [ + { + "type": "Ext.data.Request", + "optional": false, + "doc": "The request object
\n", + "name": "request" + } + ], + "name": "write", + "owner": "Ext.data.writer.Writer", + "doc": "Prepares a Proxy's Ext.data.Request object
\n", + "linenr": 70, + "return": { "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": [ + "doc": "The modified request object
\n" + }, + "html_filename": "Writer.html" + } + ], + "property": [ - ], - "event": [ + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js", - "linenr": 1, - "html_filename": "Xml2.html", - "href": "Xml2.html#Ext-data-writer-Xml", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ "Ext.data.writer.Writer" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Xml2.html#Ext-data-writer-Xml", "subclasses": [ ], + "static": false, + "author": "Ed Spencer", + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js", + "private": false, + "alternateClassNames": [ + "Ext.data.XmlWriter" + ], + "name": "Ext.data.writer.Xml", + "doc": "This class is used to write Ext.data.Model data to the server in an XML format.\nThe documentRoot property is used to specify the root element in the XML document.\nThe record option is used to specify the element name for each record that will make\nup the XML document.
\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "Xml2.html", + "extends": "Ext.data.writer.Writer" }); \ No newline at end of file