docs/output/Ext.data.writer.Xml.js

   1 Ext.data.JsonP.Ext_data_writer_Xml({
   2   "tagname": "class",
   3   "name": "Ext.data.writer.Xml",
   4   "doc": "<p>This class is used to write <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> data to the server in an XML format.\nThe <a href=\"#/api/Ext.data.writer.Xml-cfg-documentRoot\" rel=\"Ext.data.writer.Xml-cfg-documentRoot\" class=\"docClass\">documentRoot</a> property is used to specify the root element in the XML document.\nThe <a href=\"#/api/Ext.data.writer.Xml-cfg-record\" rel=\"Ext.data.writer.Xml-cfg-record\" class=\"docClass\">record</a> option is used to specify the element name for each record that will make\nup the XML document.</p>\n",
   5   "extends": "Ext.data.writer.Writer",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.data.XmlWriter"
  11   ],
  12   "xtype": null,
  13   "author": "Ed Spencer",
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "defaultDocumentRoot",
  21       "member": "Ext.data.writer.Xml",
  22       "type": "String",
  23       "doc": "<p>The root to be used if <a href=\"#/api/Ext.data.writer.Xml-cfg-documentRoot\" rel=\"Ext.data.writer.Xml-cfg-documentRoot\" class=\"docClass\">documentRoot</a> is empty and a root is required\nto form a valid XML document.</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js",
  26       "linenr": 31,
  27       "html_filename": "Xml2.html",
  28       "href": "Xml2.html#Ext-data-writer-Xml-cfg-defaultDocumentRoot"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "documentRoot",
  33       "member": "Ext.data.writer.Xml",
  34       "type": "String",
  35       "doc": "<p>The name of the root element of the document. Defaults to <tt>'xmlData'</tt>.\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.</p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js",
  38       "linenr": 24,
  39       "html_filename": "Xml2.html",
  40       "href": "Xml2.html#Ext-data-writer-Xml-cfg-documentRoot",
  41       "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..."
  42     },
  43     {
  44       "tagname": "cfg",
  45       "name": "header",
  46       "member": "Ext.data.writer.Xml",
  47       "type": "String",
  48       "doc": "<p>A header to use in the XML document (such as setting the encoding or version).\nDefaults to <tt>''</tt>.</p>\n",
  49       "private": false,
  50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js",
  51       "linenr": 37,
  52       "html_filename": "Xml2.html",
  53       "href": "Xml2.html#Ext-data-writer-Xml-cfg-header"
  54     },
  55     {
  56       "tagname": "cfg",
  57       "name": "nameProperty",
  58       "member": "Ext.data.writer.Writer",
  59       "type": "String",
  60       "doc": "<p>This property is used to read the key for each value that will be sent to the server.\nFor example:</p>\n\n<pre><code>Ext.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</code></pre>\n\n\n<p>Defaults to <tt>name</tt>. If the value is not present, the field name will always be used.</p>\n",
  61       "private": false,
  62       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js",
  63       "linenr": 32,
  64       "html_filename": "Writer.html",
  65       "href": "Writer.html#Ext-data-writer-Writer-cfg-nameProperty",
  66       "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..."
  67     },
  68     {
  69       "tagname": "cfg",
  70       "name": "record",
  71       "member": "Ext.data.writer.Xml",
  72       "type": "String",
  73       "doc": "<p>The name of the node to use for each record. Defaults to <tt>'record'</tt>.</p>\n",
  74       "private": false,
  75       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js",
  76       "linenr": 43,
  77       "html_filename": "Xml2.html",
  78       "href": "Xml2.html#Ext-data-writer-Xml-cfg-record"
  79     },
  80     {
  81       "tagname": "cfg",
  82       "name": "writeAllFields",
  83       "member": "Ext.data.writer.Writer",
  84       "type": "Boolean",
  85       "doc": "<p>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 <tt>true</tt>. Note that any fields that have\n<a href=\"#/api/Ext.data.Field-cfg-persist\" rel=\"Ext.data.Field-cfg-persist\" class=\"docClass\">Ext.data.Field.persist</a> set to false will still be ignored.</p>\n",
  86       "private": false,
  87       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js",
  88       "linenr": 25,
  89       "html_filename": "Writer.html",
  90       "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields",
  91       "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..."
  92     }
  93   ],
  94   "method": [
  95     {
  96       "tagname": "method",
  97       "name": "Xml",
  98       "member": "Ext.data.writer.Writer",
  99       "doc": "\n",
 100       "params": [
 101         {
 102           "type": "Object",
 103           "name": "config",
 104           "doc": "<p>Optional config object</p>\n",
 105           "optional": false
 106         }
 107       ],
 108       "return": {
 109         "type": "void",
 110         "doc": "\n"
 111       },
 112       "private": false,
 113       "static": false,
 114       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js",
 115       "linenr": 1,
 116       "html_filename": "Writer.html",
 117       "href": "Writer.html#Ext-data-writer-Writer-method-constructor",
 118       "shortDoc": "\n"
 119     },
 120     {
 121       "tagname": "method",
 122       "name": "getRecordData",
 123       "member": "Ext.data.writer.Writer",
 124       "doc": "<p>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.</p>\n",
 125       "params": [
 126         {
 127           "type": "Object",
 128           "name": "record",
 129           "doc": "<p>The record that we are writing to the server.</p>\n",
 130           "optional": false
 131         }
 132       ],
 133       "return": {
 134         "type": "Object",
 135         "doc": "<p>An object literal of name/value keys to be written to the server.\nBy default this method returns the data property on the record.</p>\n"
 136       },
 137       "private": false,
 138       "static": false,
 139       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js",
 140       "linenr": 87,
 141       "html_filename": "Writer.html",
 142       "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData",
 143       "shortDoc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data..."
 144     },
 145     {
 146       "tagname": "method",
 147       "name": "write",
 148       "member": "Ext.data.writer.Writer",
 149       "doc": "<p>Prepares a Proxy's <a href=\"#/api/Ext.data.Request\" rel=\"Ext.data.Request\" class=\"docClass\">Ext.data.Request</a> object</p>\n",
 150       "params": [
 151         {
 152           "type": "Ext.data.Request",
 153           "name": "request",
 154           "doc": "<p>The request object</p>\n",
 155           "optional": false
 156         }
 157       ],
 158       "return": {
 159         "type": "Ext.data.Request",
 160         "doc": "<p>The modified request object</p>\n"
 161       },
 162       "private": false,
 163       "static": false,
 164       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js",
 165       "linenr": 69,
 166       "html_filename": "Writer.html",
 167       "href": "Writer.html#Ext-data-writer-Writer-method-write",
 168       "shortDoc": "<p>Prepares a Proxy's <a href=\"#/api/Ext.data.Request\" rel=\"Ext.data.Request\" class=\"docClass\">Ext.data.Request</a> object</p>\n"
 169     }
 170   ],
 171   "property": [
 172
 173   ],
 174   "event": [
 175
 176   ],
 177   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Xml.js",
 178   "linenr": 1,
 179   "html_filename": "Xml2.html",
 180   "href": "Xml2.html#Ext-data-writer-Xml",
 181   "cssVar": [
 182
 183   ],
 184   "cssMixin": [
 185
 186   ],
 187   "component": false,
 188   "superclasses": [
 189     "Ext.data.writer.Writer"
 190   ],
 191   "subclasses": [
 192
 193   ],
 194   "mixedInto": [
 195
 196   ],
 197   "allMixins": [
 198
 199   ]
 200 });