X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..6e39d509471fe9b4e2660e0d1631b350d0c66f40:/docs/output/Ext.data.XmlWriter.html diff --git a/docs/output/Ext.data.XmlWriter.html b/docs/output/Ext.data.XmlWriter.html index 0a66a9f0..bdfd71e9 100644 --- a/docs/output/Ext.data.XmlWriter.html +++ b/docs/output/Ext.data.XmlWriter.html @@ -1,9 +1,18 @@ -
Properties Methods Events Config Options Direct Link 
DataWriter
  XmlWriter

Class Ext.data.XmlWriter

Package:Ext.data
Defined In:XmlWriter.js
Class:XmlWriter
Extends:DataWriter
DataWriter extension for writing an array or single Ext.data.Record object(s) in preparation for executing a remote CRUD action via XML.

Config Options

Config OptionsDefined By
 createRecord : Function
Abstract method that should be implemented in all subclasses +
DataWriter
  XmlWriter

Class Ext.data.XmlWriter

Package:Ext.data
Defined In:XmlWriter.js
Class:XmlWriter
Extends:DataWriter
DataWriter extension for writing an array or single Ext.data.Record object(s) in preparation for executing a remote CRUD action via XML. +XmlWriter uses an instance of Ext.XTemplate for maximum flexibility in defining your own custom XML schema if the default schema is not appropriate for your needs. +See the tpl configuration-property.

Config Options

Config OptionsDefined By
 createRecord : Function
Abstract method that should be implemented in all subclasses (e.g.: JsonWriter.createRecord)
DataWriter
 destroyRecord : Function
Abstract method that should be implemented in all subclasses -(e.g.: JsonWriter.destroyRecord)
DataWriter
 updateRecord : Function
Abstract method that should be implemented in all subclasses + <tpl if="records.length > 1"></{root}></tpl> + <tpl if="documentRoot"></{documentRoot}></tpl> + +

Templates will be called with the following API

+
    +
  • {String} version [1.0] The xml version.
    • +
  • {String} encoding [ISO-8859-15] The xml encoding.
    • +
  • {String/false} documentRoot The XML document root-node name or false if not required. See documentRoot and forceDocumentRoot.
    • +
  • {String} record The meta-data parameter defined on your Ext.data.XmlReader.record configuration represents the name of the xml-tag containing each record.
    • +
  • {String} root The meta-data parameter defined by Ext.data.XmlWriter.root configuration-parameter. Represents the name of the xml root-tag when sending multiple records to the server.
    • +
  • {Array} records The records being sent to the server, ie: the subject of the write-action being performed. The records parameter will be always be an array, even when only a single record is being acted upon. +Each item within the records array will contain an array of field objects having the following properties: +
      +
    • {String} name The field-name of the record as defined by your Ext.data.Record definition. The "mapping" property will be used, otherwise it will match the "name" property. Use this parameter to define the XML tag-name of the property.
      • +
    • {Mixed} value The record value of the field enclosed within XML tags specified by name property above.
      • +
    • +
  • {Array} baseParams. The baseParams as defined upon Ext.data.Store.baseParams. Note that the baseParams have been converted into an array of [{name : "foo", value: "bar"}, ...] pairs in the same manner as the records parameter above. See documentRoot and forceDocumentRoot.
    • +
XmlWriter
 updateRecord : Function
Abstract method that should be implemented in all subclasses (e.g.: JsonWriter.updateRecord
DataWriter
 xmlEncoding : String
[ISO-8859-15] The encoding written to header of xml documents. 
<?xml version="1.0" encoding="ISO-8859-15"?>
XmlWriter
 xmlVersion : String
[1.0] The version written to header of xml documents. -
<?xml version="1.0" encoding="ISO-8859-15"?>
XmlWriter

Public Properties

This class has no public properties.

Public Methods

MethodDefined By

Public Properties

This class has no public properties.

Public Methods

MethodDefined By

Public Events

This class has no public events.
\ No newline at end of file + Array
updateRecord
updateRecord
Parameters:
  • rec : Ext.data.Record
Returns:
  • Array
    Array of {name:value} pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}.
XmlWriter

Public Events

This class has no public events.
\ No newline at end of file