X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..92c2b89db26be16707f4a805d3303ab2531006e1:/docs/output/Ext.data.XmlReader.html?ds=inline diff --git a/docs/output/Ext.data.XmlReader.html b/docs/output/Ext.data.XmlReader.html index f4330917..1d16059b 100644 --- a/docs/output/Ext.data.XmlReader.html +++ b/docs/output/Ext.data.XmlReader.html @@ -1,38 +1,17 @@ -
-
- Properties - Methods - Events - Config Options - Direct Link -
-
-
DataReader
-  XmlReader
-

Class Ext.data.XmlReader

- - - - - -
Package:Ext.data
Defined In:XmlReader.js
Class:XmlReader
Extends:DataReader
-
- * -Data reader class to create an Array of Ext.data.Record objects from an XML document -based on mappings in a provided Ext.data.Record constructor.

-

-Note that in order for the browser to parse a returned XML document, the Content-Type -header in the HTTP response must be set to "text/xml" or "application/xml". -

-Example code: -

var Employee = Ext.data.Record.create([
-   {name: 'name', mapping: 'name'},     // "mapping" property not needed if it's the same as "name"
+
DataReader
  XmlReader
Class Ext.data.XmlReader
Package:Ext.data
Defined In:XmlReader.js
Class:XmlReader
Extends:DataReader
Data reader class to create an Array of Ext.data.Record objects from an XML document
+based on mappings in a provided Ext.data.Record constructor.

+
Note: that in order for the browser to parse a returned XML document, the Content-Type
+header in the HTTP response must be set to "text/xml" or "application/xml".

+
Example code:

+
var Employee = Ext.data.Record.create([
+   {name: 'name', mapping: 'name'},     // "mapping" property not needed if it is the same as "name"
    {name: 'occupation'}                 // This field will use "occupation" as the mapping.
 ]);
 var myReader = new Ext.data.XmlReader({
-   totalRecords: "results", // The element which contains the total dataset size (optional)
+   totalProperty: "results", // The element which contains the total dataset size (optional)
    record: "row",           // The repeated element which contains row information
-   id: "id"                 // The element within the row that provides an ID for the record (optional)
+   idProperty: "id"         // The element within the row that provides an ID for the record (optional)
+   messageProperty: "msg"   // The element within the response that provides a user-feedback message (optional)
 }, Employee);

 

 This would consume an XML file like this:
@@ -49,153 +28,39 @@ This would consume an XML file like this:
    <name>Ben</name>
    <occupation>Horticulturalist</occupation>
  </row>
-</dataset>
- -
- -

Config Options

- - - - - - - - - - - - - - - - - - - - - - - - - -
Config OptionsDefined By
  - - id : String
- The DomQuery path relative from the record element to the element that contains a record identifier value.
- 		XmlReader
  - - record : String
- The DomQuery path to the repeated element which contains record information.
- 		XmlReader
  - - success : String
- The DomQuery path to the success attribute used by forms.
- 		XmlReader
- -

Public Properties

- - - - - - - - - - - - - - - -
PropertyDefined By
  - - meta : Mixed
- This DataReader's configured metadata as passed to the constructor.
- 		DataReader
  - - xmlData : XMLDocument
- After any data loads/reads, the raw XML Document is available for further custom processing.
- 		XmlReader
- -

Public Methods

- - - - - - - - - - - - - - - - - - - - -
MethodDefined By
- -

Public Events

-
This class has no public events.
-
\ No newline at end of file +</dataset>

Config Options

Config OptionsDefined By
 idPath : String
The DomQuery path relative from the record element to the element that contains +a record identifier value.
XmlReader
 messageProperty : String
[undefined] Optional name of a property within a server-response that represents a user-feedback message.
DataReader
 record : String
The DomQuery path to the repeated element which contains record information.
XmlReader
 record : String
The DomQuery path to the repeated element which contains record information.
XmlReader
 successProperty : String
The DomQuery path to the success attribute used by forms.
XmlReader

Public Properties

PropertyDefined By
 buildExtractors : Object
Abstract method, overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
DataReader
 extractData : Object
Abstract method overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
DataReader
 extractValues : Object
Abstract method overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
DataReader
 getId : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getMessage : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getRoot : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getSuccess : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getTotal : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 meta : Mixed
This DataReader's configured metadata as passed to the constructor.
DataReader
 xmlData : XMLDocument
After any data loads/reads, the raw XML Document is available for further custom processing.
XmlReader

Public Methods

MethodDefined By

Public Events

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