/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_data_XmlReader({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":[],"extends":"Ext.data.DataReader","uses":[],"html":"
Hierarchy
Ext.data.DataReaderExt.data.XmlReaderFiles
Data reader class to create an Array of Ext.data.Record objects from an XML document\nbased on mappings in a provided Ext.data.Record constructor.
\n\n\nNote: that in order for the browser to parse a returned XML document, the Content-Type\nheader in the HTTP response must be set to \"text/xml\" or \"application/xml\".
\n\n\nExample code:
\n\n\nvar Employee = Ext.data.Record.create([\n {name: 'name', mapping: 'name'}, // \"mapping\" property not needed if it is the same as \"name\"\n {name: 'occupation'} // This field will use \"occupation\" as the mapping.\n]);\nvar myReader = new Ext.data.XmlReader({\n totalProperty: \"results\", // The element which contains the total dataset size (optional)\n record: \"row\", // The repeated element which contains row information\n idProperty: \"id\" // The element within the row that provides an ID for the record (optional)\n messageProperty: \"msg\" // The element within the response that provides a user-feedback message (optional)\n}, Employee);\n
\n\n\n\nThis would consume an XML file like this:\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<dataset>\n <results>2</results>\n <row>\n <id>1</id>\n <name>Bill</name>\n <occupation>Gardener</occupation>\n </row>\n <row>\n <id>2</id>\n <name>Ben</name>\n <occupation>Horticulturalist</occupation>\n </row>\n</dataset>\n
\n\nEither an Array of Field definition objects (which\nwill be passed to Ext.data.Record.create, or a Record\nconstructor created from Ext.data.Record.create.
\n\nThe DomQuery path relative from the record element to the element that contains\na record identifier value.
\nThe DomQuery path relative from the record element to the element that contains\na record identifier value.
\n[undefined] Optional name of a property within a server-response that represents a user-feedback message.
\n[undefined] Optional name of a property within a server-response that represents a user-feedback message.
\nThe DomQuery path to the repeated element which contains record information.
\nThe DomQuery path to the repeated element which contains record information.
\nThe DomQuery path to the success attribute used by forms.
\nThe DomQuery path to the success attribute used by forms.
\nThis DataReader's configured metadata as passed to the constructor.
\nThis DataReader's configured metadata as passed to the constructor.
\nAfter any data loads/reads, the raw XML Document is available for further custom processing.
\nAfter any data loads/reads, the raw XML Document is available for further custom processing.
\nCreate a new XmlReader.
\nMetadata configuration options
\nEither an Array of field definition objects as passed to\nExt.data.Record.create, or a Record constructor object created using Ext.data.Record.create.
\nOverrides: Ext.data.DataReader.constructor
Abstract method, overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
\nreturns extracted, type-cast rows of data. Iterates to call extractValues for each row
\nfrom server response
\n[false] Set true to return instances of Ext.data.Record
\nAbstract method overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
\nAbstract method created in extension's buildExtractors impl.
\nAbstract method created in extension's buildExtractors impl.
\nAbstract method created in extension's buildExtractors impl.
\nAbstract method created in extension's buildExtractors impl.
\nAbstract method created in extension's buildExtractors impl.
\nReturns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key\ncorresponding to idProperty defined in your DataReader config containing non-empty pk.
\nThis method is only used by a DataProxy which has retrieved data from a remote server.
\nThe XHR object which contains the parsed XML document. The response is expected\nto contain a property called responseXML which refers to an XML document object.
\nrecords A data block which is used by an Ext.data.Store as\na cache of Ext.data.Records.
\nCreate a data block containing Ext.data.Records from an XML document.
\nA parsed XML document.
\nrecords A data block which is used by an Ext.data.Store as\na cache of Ext.data.Records.
\nDecode an XML response from server.
\n[Ext.data.Api.actions create|read|update|destroy]
\nHTTP Response object from browser.
\nAn instance of Ext.data.Response
\nUsed for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server.\nYou must return at least the database pk using the idProperty defined in your DataReader configuration. The incoming\ndata from server will be merged with the data in the local record.\nIn addition, you must return record-data from the server in the same order received.\nWill perform a commit as well, un-marking dirty-fields. Store's \"update\" event will be suppressed.
\nThe phantom record to be realized.
\nThe new record data to apply. Must include the primary-key from database defined in idProperty field.
\nUsed for updating a non-phantom or \"real\" record's data with fresh data from server after remote-save.\nIf returning data from multiple-records after a batch-update, you must return record-data from the server in\nthe same order received. Will perform a commit as well, un-marking dirty-fields. Store's \"update\" event will be\nsuppressed as the record receives fresh new data-hash
\n