docs/api/Ext.data.writer.Xml.html

   1 <!DOCTYPE html><html><head><title>Ext.data.writer.Xml | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.data.writer.Xml',
  13         docClass: 'Ext.data.writer.Xml',
  14         docReq: 'Ext.data.writer.Xml',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Xml2.html#Ext-data.writer.Xml';
  33     clsInfo = {"methods":["Xml","getRecordData","write"],"cfgs":["defaultDocumentRoot","documentRoot","header","nameProperty","record","writeAllFields"],"properties":[],"events":[],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Xml2.html#Ext-data.writer.Xml" target="_blank">Ext.data.writer.Xml</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.data.writer.Writer.html" rel="Ext.data.writer.Writer" class="cls docClass">Ext.data.writer.Writer</a><div class="subclass"><strong>Ext.data.writer.Xml</strong></div></div></pre><p>Writer that outputs model data in XML format</p>
  38
  39 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-defaultDocumentRoot" class="member f ni"><a href="Ext.data.writer.Xml.html#config-defaultDocumentRoot" rel="config-defaultDocumentRoot" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Xml.html" class="definedIn docClass">Ext.data.writer.Xml</a><br/><a href="../source/Xml2.html#Ext-data.writer.Xml-cfg-defaultDocumentRoot" class="viewSource">view source</a></div><a name="defaultDocumentRoot"></a><a name="config-defaultDocumentRoot"></a><a href="Ext.data.writer.Xml.html#" rel="config-defaultDocumentRoot" class="cls expand">defaultDocumentRoot</a><span> : String</span></div><div class="description"><div class="short"><p>The root to be used if <a href="Ext.data.writer.Xml.html#documentRoot" rel="Ext.data.writer.Xml#documentRoot" class="docClass">documentRoot</a> is empty and a root is required
  40 to form a valid XML document.</p>
  41 </div><div class="long"><p>The root to be used if <a href="Ext.data.writer.Xml.html#documentRoot" rel="Ext.data.writer.Xml#documentRoot" class="docClass">documentRoot</a> is empty and a root is required
  42 to form a valid XML document.</p>
  43 </div></div></div><div id="config-documentRoot" class="member ni"><a href="Ext.data.writer.Xml.html#config-documentRoot" rel="config-documentRoot" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Xml.html" class="definedIn docClass">Ext.data.writer.Xml</a><br/><a href="../source/Xml2.html#Ext-data.writer.Xml-cfg-documentRoot" class="viewSource">view source</a></div><a name="documentRoot"></a><a name="config-documentRoot"></a><a href="Ext.data.writer.Xml.html#" rel="config-documentRoot" class="cls expand">documentRoot</a><span> : String</span></div><div class="description"><div class="short">The name of the root element of the document. Defaults to 'xmlData'.
  44 If there is more than 1 record and the root is n...</div><div class="long"><p>The name of the root element of the document. Defaults to <tt>'xmlData'</tt>.
  45 If there is more than 1 record and the root is not specified, the default document root will still be used
  46 to ensure a valid XML document is created.</p>
  47 </div></div></div><div id="config-header" class="member ni"><a href="Ext.data.writer.Xml.html#config-header" rel="config-header" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Xml.html" class="definedIn docClass">Ext.data.writer.Xml</a><br/><a href="../source/Xml2.html#Ext-data.writer.Xml-cfg-header" class="viewSource">view source</a></div><a name="header"></a><a name="config-header"></a><a href="Ext.data.writer.Xml.html#" rel="config-header" class="cls expand">header</a><span> : String</span></div><div class="description"><div class="short"><p>A header to use in the XML document (such as setting the encoding or version).
  48 Defaults to <tt>''</tt>.</p>
  49 </div><div class="long"><p>A header to use in the XML document (such as setting the encoding or version).
  50 Defaults to <tt>''</tt>.</p>
  51 </div></div></div><div id="config-nameProperty" class="member inherited"><a href="Ext.data.writer.Xml.html#config-nameProperty" rel="config-nameProperty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Writer.html" class="definedIn docClass">Ext.data.writer.Writer</a><br/><a href="../source/Writer.html#Ext-data.writer.Writer-cfg-nameProperty" class="viewSource">view source</a></div><a name="nameProperty"></a><a name="config-nameProperty"></a><a href="Ext.data.writer.Xml.html#" rel="config-nameProperty" class="cls expand">nameProperty</a><span> : String</span></div><div class="description"><div class="short">This property is used to read the key for each value that will be sent to the server.
  52 For example:
  53
  54 Ext.define('Perso...</div><div class="long"><p>This property is used to read the key for each value that will be sent to the server.
  55 For example:</p>
  56
  57 <pre><code>Ext.define('Person', {
  58     extend: 'Ext.data.Model',
  59     fields: [{
  60         name: 'first',
  61         mapping: 'firstName'
  62     }, {
  63         name: 'last',
  64         mapping: 'lastName'
  65     }, {
  66         name: 'age'
  67     }]
  68 });
  69 new Ext.data.writer.Writer({
  70     writeAllFields: true,
  71     nameProperty: 'mapping'
  72 });
  73
  74 // This will be sent to the server
  75 {
  76     firstName: 'first name value',
  77     lastName: 'last name value',
  78     age: 1
  79 }
  80
  81 </code></pre>
  82
  83
  84 <p>Defaults to <tt>name</tt>. If the value is not present, the field name will always be used.</p>
  85 </div></div></div><div id="config-record" class="member ni"><a href="Ext.data.writer.Xml.html#config-record" rel="config-record" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Xml.html" class="definedIn docClass">Ext.data.writer.Xml</a><br/><a href="../source/Xml2.html#Ext-data.writer.Xml-cfg-record" class="viewSource">view source</a></div><a name="record"></a><a name="config-record"></a><a href="Ext.data.writer.Xml.html#" rel="config-record" class="cls expand">record</a><span> : String</span></div><div class="description"><div class="short"><p>The name of the node to use for each record. Defaults to <tt>'record'</tt>.</p>
  86 </div><div class="long"><p>The name of the node to use for each record. Defaults to <tt>'record'</tt>.</p>
  87 </div></div></div><div id="config-writeAllFields" class="member inherited"><a href="Ext.data.writer.Xml.html#config-writeAllFields" rel="config-writeAllFields" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Writer.html" class="definedIn docClass">Ext.data.writer.Writer</a><br/><a href="../source/Writer.html#Ext-data.writer.Writer-cfg-writeAllFields" class="viewSource">view source</a></div><a name="writeAllFields"></a><a name="config-writeAllFields"></a><a href="Ext.data.writer.Xml.html#" rel="config-writeAllFields" class="cls expand">writeAllFields</a><span> : Boolean</span></div><div class="description"><div class="short">True to write all fields from the record to the server. If set to false it
  88 will only send the fields that were modifi...</div><div class="long"><p>True to write all fields from the record to the server. If set to false it
  89 will only send the fields that were modified. Defaults to <tt>true</tt>. Note that any fields that have
  90 <a href="Ext.data.Field.html#persist" rel="Ext.data.Field#persist" class="docClass">Ext.data.Field.persist</a> set to false will still be ignored.</p>
  91 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Xml" class="member f inherited"><a href="Ext.data.writer.Xml.html#method-Xml" rel="method-Xml" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Writer.html" class="definedIn docClass">Ext.data.writer.Writer</a><br/><a href="../source/Writer.html#Ext-data.writer.Writer-method-constructor" class="viewSource">view source</a></div><a name="Xml"></a><a name="method-Xml"></a><a href="Ext.data.writer.Xml.html#" rel="method-Xml" class="cls expand">Xml</a>(
  92 <span class="pre">Object config</span>)
  93  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
  94 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Optional config object</p>
  95 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
  96 </li></ul></div></div></div><div id="method-getRecordData" class="member inherited"><a href="Ext.data.writer.Xml.html#method-getRecordData" rel="method-getRecordData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Writer.html" class="definedIn docClass">Ext.data.writer.Writer</a><br/><a href="../source/Writer.html#Ext-data.writer.Writer-method-getRecordData" class="viewSource">view source</a></div><a name="getRecordData"></a><a name="method-getRecordData"></a><a href="Ext.data.writer.Xml.html#" rel="method-getRecordData" class="cls expand">getRecordData</a>(
  97 <span class="pre">Object record</span>)
  98  : Object</div><div class="description"><div class="short">Formats the data for each record before sending it to the server. This
  99 method should be overridden to format the data...</div><div class="long"><p>Formats the data for each record before sending it to the server. This
 100 method should be overridden to format the data in a way that differs from the default.</p>
 101 <h3 class="pa">Parameters</h3><ul><li><span class="pre">record</span> : Object<div class="sub-desc"><p>The record that we are writing to the server.</p>
 102 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object literal of name/value keys to be written to the server.
 103 By default this method returns the data property on the record.</p>
 104 </li></ul></div></div></div><div id="method-write" class="member inherited"><a href="Ext.data.writer.Xml.html#method-write" rel="method-write" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.writer.Writer.html" class="definedIn docClass">Ext.data.writer.Writer</a><br/><a href="../source/Writer.html#Ext-data.writer.Writer-method-write" class="viewSource">view source</a></div><a name="write"></a><a name="method-write"></a><a href="Ext.data.writer.Xml.html#" rel="method-write" class="cls expand">write</a>(
 105 <span class="pre">Ext.data.Request request</span>)
 106  : Ext.data.Request</div><div class="description"><div class="short"><p>Prepares a Proxy's <a href="Ext.data.Request.html" rel="Ext.data.Request" class="docClass">Ext.data.Request</a> object</p>
 107 </div><div class="long"><p>Prepares a Proxy's <a href="Ext.data.Request.html" rel="Ext.data.Request" class="docClass">Ext.data.Request</a> object</p>
 108 <h3 class="pa">Parameters</h3><ul><li><span class="pre">request</span> : Ext.data.Request<div class="sub-desc"><p>The request object</p>
 109 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Request</span>&nbsp; &nbsp;<p>The modified request object</p>
 110 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>