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

   1 Ext.data.JsonP.Ext_data_writer_Xml({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9       {
  10         "type": "String",
  11         "deprecated": null,
  12         "alias": null,
  13         "protected": false,
  14         "tagname": "cfg",
  15         "href": "Xml2.html#Ext-data-writer-Xml-cfg-defaultDocumentRoot",
  16         "static": false,
  17         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js",
  18         "private": false,
  19         "name": "defaultDocumentRoot",
  20         "owner": "Ext.data.writer.Xml",
  21         "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",
  22         "linenr": 31,
  23         "html_filename": "Xml2.html"
  24       },
  25       {
  26         "type": "String",
  27         "deprecated": null,
  28         "alias": null,
  29         "protected": false,
  30         "tagname": "cfg",
  31         "href": "Xml2.html#Ext-data-writer-Xml-cfg-documentRoot",
  32         "shortDoc": "The name of the root element of the document. ...",
  33         "static": false,
  34         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js",
  35         "private": false,
  36         "name": "documentRoot",
  37         "owner": "Ext.data.writer.Xml",
  38         "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",
  39         "linenr": 24,
  40         "html_filename": "Xml2.html"
  41       },
  42       {
  43         "type": "String",
  44         "deprecated": null,
  45         "alias": null,
  46         "protected": false,
  47         "tagname": "cfg",
  48         "href": "Xml2.html#Ext-data-writer-Xml-cfg-header",
  49         "shortDoc": "A header to use in the XML document (such as setting the encoding or version). ...",
  50         "static": false,
  51         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js",
  52         "private": false,
  53         "name": "header",
  54         "owner": "Ext.data.writer.Xml",
  55         "doc": "<p>A header to use in the XML document (such as setting the encoding or version).\nDefaults to <tt>''</tt>.</p>\n",
  56         "linenr": 37,
  57         "html_filename": "Xml2.html"
  58       },
  59       {
  60         "type": "String",
  61         "deprecated": null,
  62         "alias": null,
  63         "protected": false,
  64         "tagname": "cfg",
  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. ...",
  67         "static": false,
  68         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js",
  69         "private": false,
  70         "name": "nameProperty",
  71         "owner": "Ext.data.writer.Writer",
  72         "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",
  73         "linenr": 29,
  74         "html_filename": "Writer.html"
  75       },
  76       {
  77         "type": "String",
  78         "deprecated": null,
  79         "alias": null,
  80         "protected": false,
  81         "tagname": "cfg",
  82         "href": "Xml2.html#Ext-data-writer-Xml-cfg-record",
  83         "shortDoc": "The name of the node to use for each record. ...",
  84         "static": false,
  85         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js",
  86         "private": false,
  87         "name": "record",
  88         "owner": "Ext.data.writer.Xml",
  89         "doc": "<p>The name of the node to use for each record. Defaults to <tt>'record'</tt>.</p>\n",
  90         "linenr": 43,
  91         "html_filename": "Xml2.html"
  92       },
  93       {
  94         "type": "Boolean",
  95         "deprecated": null,
  96         "alias": null,
  97         "protected": false,
  98         "tagname": "cfg",
  99         "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields",
 100         "shortDoc": "True to write all fields from the record to the server. ...",
 101         "static": false,
 102         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js",
 103         "private": false,
 104         "name": "writeAllFields",
 105         "owner": "Ext.data.writer.Writer",
 106         "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",
 107         "linenr": 22,
 108         "html_filename": "Writer.html"
 109       }
 110     ],
 111     "method": [
 112       {
 113         "deprecated": null,
 114         "alias": null,
 115         "href": "Writer.html#Ext-data-writer-Writer-method-constructor",
 116         "tagname": "method",
 117         "protected": false,
 118         "shortDoc": "Creates new Writer. ...",
 119         "static": false,
 120         "params": [
 121           {
 122             "type": "Object",
 123             "optional": true,
 124             "doc": "<p>(optional) Config object.</p>\n",
 125             "name": "config"
 126           }
 127         ],
 128         "private": false,
 129         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js",
 130         "doc": "<p>Creates new Writer.</p>\n",
 131         "owner": "Ext.data.writer.Writer",
 132         "name": "Xml",
 133         "html_filename": "Writer.html",
 134         "return": {
 135           "type": "Object",
 136           "doc": "\n"
 137         },
 138         "linenr": 62
 139       },
 140       {
 141         "deprecated": null,
 142         "alias": null,
 143         "protected": false,
 144         "tagname": "method",
 145         "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData",
 146         "shortDoc": "Formats the data for each record before sending it to the server. ...",
 147         "static": false,
 148         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js",
 149         "private": false,
 150         "params": [
 151           {
 152             "type": "Object",
 153             "optional": false,
 154             "doc": "<p>The record that we are writing to the server.</p>\n",
 155             "name": "record"
 156           }
 157         ],
 158         "name": "getRecordData",
 159         "owner": "Ext.data.writer.Writer",
 160         "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",
 161         "linenr": 88,
 162         "return": {
 163           "type": "Object",
 164           "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"
 165         },
 166         "html_filename": "Writer.html"
 167       },
 168       {
 169         "deprecated": null,
 170         "alias": null,
 171         "protected": false,
 172         "tagname": "method",
 173         "href": "Writer.html#Ext-data-writer-Writer-method-write",
 174         "shortDoc": "Prepares a Proxy's Ext.data.Request object ...",
 175         "static": false,
 176         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js",
 177         "private": false,
 178         "params": [
 179           {
 180             "type": "Ext.data.Request",
 181             "optional": false,
 182             "doc": "<p>The request object</p>\n",
 183             "name": "request"
 184           }
 185         ],
 186         "name": "write",
 187         "owner": "Ext.data.writer.Writer",
 188         "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",
 189         "linenr": 70,
 190         "return": {
 191           "type": "Ext.data.Request",
 192           "doc": "<p>The modified request object</p>\n"
 193         },
 194         "html_filename": "Writer.html"
 195       }
 196     ],
 197     "property": [
 198
 199     ],
 200     "cssVar": [
 201
 202     ],
 203     "cssMixin": [
 204
 205     ],
 206     "event": [
 207
 208     ]
 209   },
 210   "singleton": false,
 211   "alias": null,
 212   "superclasses": [
 213     "Ext.data.writer.Writer"
 214   ],
 215   "protected": false,
 216   "tagname": "class",
 217   "mixins": [
 218
 219   ],
 220   "href": "Xml2.html#Ext-data-writer-Xml",
 221   "subclasses": [
 222
 223   ],
 224   "static": false,
 225   "author": "Ed Spencer",
 226   "component": false,
 227   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Xml.js",
 228   "private": false,
 229   "alternateClassNames": [
 230     "Ext.data.XmlWriter"
 231   ],
 232   "name": "Ext.data.writer.Xml",
 233   "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",
 234   "mixedInto": [
 235
 236   ],
 237   "linenr": 1,
 238   "xtypes": [
 239
 240   ],
 241   "html_filename": "Xml2.html",
 242   "extends": "Ext.data.writer.Writer"
 243 });