X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.data.reader.Xml.js diff --git a/docs/output/Ext.data.reader.Xml.js b/docs/output/Ext.data.reader.Xml.js index 7f3af626..f16a0051 100644 --- a/docs/output/Ext.data.reader.Xml.js +++ b/docs/output/Ext.data.reader.Xml.js @@ -1,349 +1 @@ -Ext.data.JsonP.Ext_data_reader_Xml({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Reader.html#Ext-data-reader-Reader-cfg-idProperty", - "shortDoc": "Name of the property within a row object\nthat contains a record identifier value. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "idProperty", - "owner": "Ext.data.reader.Reader", - "doc": "

Name of the property within a row object\nthat contains a record identifier value. Defaults to The id of the model.\nIf an idProperty is explicitly specified it will override that of the one specified\non the model

\n", - "linenr": 151, - "html_filename": "Reader.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Reader.html#Ext-data-reader-Reader-cfg-implicitIncludes", - "shortDoc": "True to automatically parse models nested within other models in a response\nobject. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "implicitIncludes", - "owner": "Ext.data.reader.Reader", - "doc": "

True to automatically parse models nested within other models in a response\nobject. See the Ext.data.reader.Reader intro docs for full explanation. Defaults to true.

\n", - "linenr": 188, - "html_filename": "Reader.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Reader.html#Ext-data-reader-Reader-cfg-messageProperty", - "shortDoc": "The name of the property which contains a response message. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "messageProperty", - "owner": "Ext.data.reader.Reader", - "doc": "

The name of the property which contains a response message.\nThis property is optional.

\n", - "linenr": 183, - "html_filename": "Reader.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Xml.html#Ext-data-reader-Xml-cfg-record", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Xml.js", - "private": false, - "name": "record", - "owner": "Ext.data.reader.Xml", - "doc": "

The DomQuery path to the repeated element which contains record information.

\n", - "linenr": 171, - "html_filename": "Xml.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Reader.html#Ext-data-reader-Reader-cfg-root", - "shortDoc": "Required. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "root", - "owner": "Ext.data.reader.Reader", - "doc": "

Required. The name of the property\nwhich contains the Array of row objects. Defaults to undefined.\nAn exception will be thrown if the root property is undefined. The data\npacket value for this property should be an empty array to clear the data\nor show no data.

\n", - "linenr": 174, - "html_filename": "Reader.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Reader.html#Ext-data-reader-Reader-cfg-successProperty", - "shortDoc": "Name of the property from which to\nretrieve the success attribute. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "successProperty", - "owner": "Ext.data.reader.Reader", - "doc": "

Name of the property from which to\nretrieve the success attribute. Defaults to success. See\nExt.data.proxy.Proxy.exception\nfor additional information.

\n", - "linenr": 166, - "html_filename": "Reader.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Reader.html#Ext-data-reader-Reader-cfg-totalProperty", - "shortDoc": "Name of the property from which to\nretrieve the total number of records in the dataset. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "totalProperty", - "owner": "Ext.data.reader.Reader", - "doc": "

Name of the property from which to\nretrieve the total number of records in the dataset. This is only needed\nif the whole dataset is not passed in one go, but is being paged from\nthe remote server. Defaults to total.

\n", - "linenr": 158, - "html_filename": "Reader.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "Reader.html#Ext-data-reader-Reader-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates new Reader. ...", - "static": false, - "params": [ - { - "type": "Object", - "optional": true, - "doc": "

(optional) Config object.

\n", - "name": "config" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "doc": "

Creates new Reader.

\n", - "owner": "Ext.data.reader.Reader", - "name": "Xml", - "html_filename": "Reader.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 196 - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Xml.html#Ext-data-reader-Xml-method-getData", - "shortDoc": "Normalizes the data object ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Xml.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The raw data object

\n", - "name": "data" - } - ], - "name": "getData", - "owner": "Ext.data.reader.Xml", - "doc": "

Normalizes the data object

\n", - "linenr": 221, - "return": { - "type": "Object", - "doc": "

Returns the documentElement property of the data object if present, or the same object if not

\n" - }, - "html_filename": "Xml.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Reader.html#Ext-data-reader-Reader-method-getResponseData", - "shortDoc": "Takes a raw response object (as passed to this.read) and returns the useful data segment of it. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The responce object

\n", - "name": "response" - } - ], - "name": "getResponseData", - "owner": "Ext.data.reader.Reader", - "doc": "

Takes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be implemented by each subclass

\n", - "linenr": 460, - "return": { - "type": "Object", - "doc": "

The useful data from the response

\n" - }, - "html_filename": "Reader.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Reader.html#Ext-data-reader-Reader-method-read", - "shortDoc": "Reads the given response object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The response object. This may be either an XMLHttpRequest object or a plain JS object

\n", - "name": "response" - } - ], - "name": "read", - "owner": "Ext.data.reader.Reader", - "doc": "

Reads the given response object. This method normalizes the different types of response object that may be passed\nto it, before handing off the reading of records to the readRecords function.

\n", - "linenr": 228, - "return": { - "type": "Ext.data.ResultSet", - "doc": "

The parsed ResultSet object

\n" - }, - "html_filename": "Reader.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Xml.html#Ext-data-reader-Xml-method-readRecords", - "shortDoc": "Parses an XML document and returns a ResultSet containing the model instances ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Xml.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

Parsed XML document

\n", - "name": "doc" - } - ], - "name": "readRecords", - "owner": "Ext.data.reader.Xml", - "doc": "

Parses an XML document and returns a ResultSet containing the model instances

\n", - "linenr": 284, - "return": { - "type": "Ext.data.ResultSet", - "doc": "

The parsed result set

\n" - }, - "html_filename": "Xml.html" - } - ], - "property": [ - { - "type": "Mixed", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Reader.html#Ext-data-reader-Reader-property-rawData", - "shortDoc": "The raw data object that was last passed to readRecords. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Reader.js", - "private": false, - "name": "rawData", - "owner": "Ext.data.reader.Reader", - "doc": "

The raw data object that was last passed to readRecords. Stored for further processing if needed

\n", - "linenr": 268, - "html_filename": "Reader.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Xml.html#Ext-data-reader-Xml-property-xmlData", - "shortDoc": "DEPRECATED - will be removed in Ext JS 5.0. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Xml.js", - "private": false, - "name": "xmlData", - "owner": "Ext.data.reader.Xml", - "doc": "

DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead

\n", - "linenr": 295, - "html_filename": "Xml.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.data.reader.Reader" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Xml.html#Ext-data-reader-Xml", - "subclasses": [ - - ], - "static": false, - "author": "Ed Spencer", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/reader/Xml.js", - "private": false, - "alternateClassNames": [ - "Ext.data.XmlReader" - ], - "name": "Ext.data.reader.Xml", - "doc": "

The XML Reader is used by a Proxy to read a server response that is sent back in XML format. This usually\nhappens as a result of loading a Store - for example we might create something like this:

\n\n\n\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['id', 'name', 'email']\n});\n\nvar store = new Ext.data.Store({\n    model: 'User',\n    proxy: {\n        type: 'ajax',\n        url : 'users.xml',\n        reader: {\n            type: 'xml',\n            record: 'user'\n        }\n    }\n});\n
\n\n\n\n\n

The example above creates a 'User' model. Models are explained in the Model docs if you're\nnot already familiar with them.

\n\n\n\n\n

We created the simplest type of XML Reader possible by simply telling our Store's \nProxy that we want a XML Reader. The Store automatically passes the configured model to the\nStore, so it is as if we passed this instead:\n\n

reader: {\n    type : 'xml',\n    model: 'User',\n    record: 'user'\n}\n
\n\n

The reader we set up is ready to read data from our server - at the moment it will accept a response like this:

\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n    <id>1</id>\n    <name>Ed Spencer</name>\n    <email>ed@sencha.com</email>\n</user>\n<user>\n    <id>2</id>\n    <name>Abe Elias</name>\n    <email>abe@sencha.com</email>\n</user>\n
\n\n

The XML Reader uses the configured record option to pull out the data for each record - in this case we\nset record to 'user', so each <user> above will be converted into a User model.

\n\n

Reading other XML formats

\n\n

If you already have your XML format defined and it doesn't look quite like what we have above, you can usually\npass XmlReader a couple of configuration options to make it parse your format. For example, we can use the \nroot configuration to parse data that comes back like this:

\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<users>\n    <user>\n        <id>1</id>\n        <name>Ed Spencer</name>\n        <email>ed@sencha.com</email>\n    </user>\n    <user>\n        <id>2</id>\n        <name>Abe Elias</name>\n        <email>abe@sencha.com</email>\n    </user>\n</users>\n
\n\n

To parse this we just pass in a root configuration that matches the 'users' above:

\n\n
reader: {\n    type  : 'xml',\n    root  : 'users',\n    record: 'user'\n}\n
\n\n

Note that XmlReader doesn't care whether your root and record elements are nested deep inside\na larger structure, so a response like this will still work:\n\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<deeply>\n    <nested>\n        <xml>\n            <users>\n                <user>\n                    <id>1</id>\n                    <name>Ed Spencer</name>\n                    <email>ed@sencha.com</email>\n                </user>\n                <user>\n                    <id>2</id>\n                    <name>Abe Elias</name>\n                    <email>abe@sencha.com</email>\n                </user>\n            </users>\n        </xml>\n    </nested>\n</deeply>\n
\n\n

Response metadata

\n\n

The server can return additional data in its response, such as the total number of records \nand the success status of the response. These are typically included in the XML response\nlike this:

\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<total>100</total>\n<success>true</success>\n<users>\n    <user>\n        <id>1</id>\n        <name>Ed Spencer</name>\n        <email>ed@sencha.com</email>\n    </user>\n    <user>\n        <id>2</id>\n        <name>Abe Elias</name>\n        <email>abe@sencha.com</email>\n    </user>\n</users>\n
\n\n

If these properties are present in the XML response they can be parsed out by the XmlReader and used by the\nStore that loaded it. We can set up the names of these properties by specifying a final pair of configuration \noptions:

\n\n
reader: {\n    type: 'xml',\n    root: 'users',\n    totalProperty  : 'total',\n    successProperty: 'success'\n}\n
\n\n

These final options are not necessary to make the Reader work, but can be useful when the server needs to report\nan error or if it needs to indicate that there is a lot of data available of which only a subset is currently being\nreturned.

\n\n

Response format

\n\n

Note: in order for the browser to parse a returned XML document, the Content-Type header in the HTTP \nresponse must be set to \"text/xml\" or \"application/xml\". This is very important - the XmlReader will not\nwork correctly otherwise.

\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Xml.html", - "extends": "Ext.data.reader.Reader" -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_reader_Xml({"tagname":"class","html":"

Alternate names

Ext.data.XmlReader

Hierarchy

Files

The XML Reader is used by a Proxy to read a server response that is sent back in XML format. This usually\nhappens as a result of loading a Store - for example we might create something like this:

\n\n\n\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['id', 'name', 'email']\n});\n\nvar store = Ext.create('Ext.data.Store', {\n    model: 'User',\n    proxy: {\n        type: 'ajax',\n        url : 'users.xml',\n        reader: {\n            type: 'xml',\n            record: 'user'\n        }\n    }\n});\n
\n\n\n\n\n

The example above creates a 'User' model. Models are explained in the Model docs if you're\nnot already familiar with them.

\n\n\n\n\n

We created the simplest type of XML Reader possible by simply telling our Store's\nProxy that we want a XML Reader. The Store automatically passes the configured model to the\nStore, so it is as if we passed this instead:\n\n

reader: {\n    type : 'xml',\n    model: 'User',\n    record: 'user'\n}\n
\n\n

The reader we set up is ready to read data from our server - at the moment it will accept a response like this:

\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n    <id>1</id>\n    <name>Ed Spencer</name>\n    <email>ed@sencha.com</email>\n</user>\n<user>\n    <id>2</id>\n    <name>Abe Elias</name>\n    <email>abe@sencha.com</email>\n</user>\n
\n\n

The XML Reader uses the configured record option to pull out the data for each record - in this case we\nset record to 'user', so each <user> above will be converted into a User model.

\n\n

Reading other XML formats

\n\n

If you already have your XML format defined and it doesn't look quite like what we have above, you can usually\npass XmlReader a couple of configuration options to make it parse your format. For example, we can use the\nroot configuration to parse data that comes back like this:

\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<users>\n    <user>\n        <id>1</id>\n        <name>Ed Spencer</name>\n        <email>ed@sencha.com</email>\n    </user>\n    <user>\n        <id>2</id>\n        <name>Abe Elias</name>\n        <email>abe@sencha.com</email>\n    </user>\n</users>\n
\n\n

To parse this we just pass in a root configuration that matches the 'users' above:

\n\n
reader: {\n    type  : 'xml',\n    root  : 'users',\n    record: 'user'\n}\n
\n\n

Note that XmlReader doesn't care whether your root and record elements are nested deep inside\na larger structure, so a response like this will still work:\n\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<deeply>\n    <nested>\n        <xml>\n            <users>\n                <user>\n                    <id>1</id>\n                    <name>Ed Spencer</name>\n                    <email>ed@sencha.com</email>\n                </user>\n                <user>\n                    <id>2</id>\n                    <name>Abe Elias</name>\n                    <email>abe@sencha.com</email>\n                </user>\n            </users>\n        </xml>\n    </nested>\n</deeply>\n
\n\n

Response metadata

\n\n

The server can return additional data in its response, such as the total number of records\nand the success status of the response. These are typically included in the XML response\nlike this:

\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<total>100</total>\n<success>true</success>\n<users>\n    <user>\n        <id>1</id>\n        <name>Ed Spencer</name>\n        <email>ed@sencha.com</email>\n    </user>\n    <user>\n        <id>2</id>\n        <name>Abe Elias</name>\n        <email>abe@sencha.com</email>\n    </user>\n</users>\n
\n\n

If these properties are present in the XML response they can be parsed out by the XmlReader and used by the\nStore that loaded it. We can set up the names of these properties by specifying a final pair of configuration\noptions:

\n\n
reader: {\n    type: 'xml',\n    root: 'users',\n    totalProperty  : 'total',\n    successProperty: 'success'\n}\n
\n\n

These final options are not necessary to make the Reader work, but can be useful when the server needs to report\nan error or if it needs to indicate that there is a lot of data available of which only a subset is currently being\nreturned.

\n\n

Response format

\n\n

Note: in order for the browser to parse a returned XML document, the Content-Type header in the HTTP\nresponse must be set to \"text/xml\" or \"application/xml\". This is very important - the XmlReader will not\nwork correctly otherwise.

\n\n
Defined By

Config options

Name of the property within a row object that contains a record identifier value. ...

Name of the property within a row object that contains a record identifier value. Defaults to The id of the\nmodel. If an idProperty is explicitly specified it will override that of the one specified on the model

\n
True to automatically parse models nested within other models in a response object. ...

True to automatically parse models nested within other models in a response object. See the\nExt.data.reader.Reader intro docs for full explanation. Defaults to true.

\n

Defaults to: true

The name of the property which contains a response message. ...

The name of the property which contains a response message. This property is optional.

\n
 

The DomQuery path to the repeated element which contains record information.

\n

The DomQuery path to the repeated element which contains record information.

\n
The name of the property which contains the Array of row objects. ...

The name of the property which contains the Array of row objects. For JSON reader it's dot-separated list\nof property names. For XML reader it's a CSS selector. For array reader it's not applicable.

\n\n

By default the natural root of the data will be used. The root Json array, the root XML element, or the array.

\n\n

The data packet value for this property should be an empty array to clear the data or show no data.

\n

Defaults to: ""

Name of the property from which to retrieve the success attribute. ...

Name of the property from which to retrieve the success attribute. Defaults to success. See\nExt.data.proxy.Server.exception for additional information.

\n

Defaults to: "success"

Name of the property from which to retrieve the total number of records in the dataset. ...

Name of the property from which to retrieve the total number of records in the dataset. This is only needed if\nthe whole dataset is not passed in one go, but is being paged from the remote server. Defaults to total.

\n

Defaults to: "total"

Defined By

Properties

The raw data object that was last passed to readRecords. ...

The raw data object that was last passed to readRecords. Stored for further processing if needed

\n
Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n
...
\n

This property has been deprecated

will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead

\n

Methods

Defined By

Instance Methods

Creates new Reader. ...

Creates new Reader.

\n

Parameters

  • config : Object (optional)

    Config object.

    \n

Returns

( Array/Arguments args ) : Objectprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

    \n

Returns

  • Object

    Returns the result from the superclass' method

    \n
Normalizes the data object ...

Normalizes the data object

\n

Parameters

  • data : Object

    The raw data object

    \n

Returns

  • Object

    Returns the documentElement property of the data object if present, or the same object if not

    \n
Takes a raw response object (as passed to this.read) and returns the useful data segment of it. ...

Takes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be\nimplemented by each subclass

\n

Parameters

  • response : Object

    The responce object

    \n

Returns

  • Object

    The useful data from the response

    \n
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
Reads the given response object. ...

Reads the given response object. This method normalizes the different types of response object that may be passed\nto it, before handing off the reading of records to the readRecords function.

\n

Parameters

  • response : Object

    The response object. This may be either an XMLHttpRequest object or a plain JS object

    \n

Returns

Parses an XML document and returns a ResultSet containing the model instances ...

Parses an XML document and returns a ResultSet containing the model instances

\n

Parameters

  • doc : Object

    Parsed XML document

    \n

Returns

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
\n

Returns

Defined By

Static Methods

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n
\n

Parameters

Returns

( Ext.Base fromClass, String/String[] members ) : Ext.Basestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n
Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : String/String[]

    The names of the members to borrow

    \n

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n

Returns

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n
Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n
Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n

Returns

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n
Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n

Parameters

Override prototype members of this class. ...

Override prototype members of this class. Overridden methods can be invoked via\ncallOverridden

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n

Parameters

Returns

","allMixins":[],"meta":{"author":["Ed Spencer"]},"requires":[],"deprecated":null,"extends":"Ext.data.reader.Reader","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.data.reader.Reader","Ext.data.reader.Xml"],"singleton":false,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"borrow","id":"static-method-borrow"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"create","id":"static-method-create"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"getName","id":"static-method-getName"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"implement","id":"static-method-implement"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"override","id":"static-method-override"}],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":null,"protected":false,"name":"rawData","id":"property-rawData"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"},{"tagname":"property","deprecated":{"doc":null,"tagname":"deprecated","text":"

will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead

\n","version":null},"static":false,"owner":"Ext.data.reader.Xml","template":null,"required":null,"protected":false,"name":"xmlData","id":"property-xmlData"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":false,"protected":false,"name":"idProperty","id":"cfg-idProperty"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":false,"protected":false,"name":"implicitIncludes","id":"cfg-implicitIncludes"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":false,"protected":false,"name":"messageProperty","id":"cfg-messageProperty"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Xml","template":null,"required":true,"protected":false,"name":"record","id":"cfg-record"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":false,"protected":false,"name":"root","id":"cfg-root"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":false,"protected":false,"name":"successProperty","id":"cfg-successProperty"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":null,"required":false,"protected":false,"name":"totalProperty","id":"cfg-totalProperty"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.reader.Xml","template":false,"required":null,"protected":false,"name":"getData","id":"method-getData"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":false,"required":null,"protected":false,"name":"getResponseData","id":"method-getResponseData"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.reader.Reader","template":false,"required":null,"protected":false,"name":"read","id":"method-read"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.reader.Xml","template":false,"required":null,"protected":false,"name":"readRecords","id":"method-readRecords"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"}],"event":[]},"private":false,"component":false,"name":"Ext.data.reader.Xml","alternateClassNames":["Ext.data.XmlReader"],"id":"class-Ext.data.reader.Xml","mixedInto":[],"xtypes":{"reader":["xml"]},"files":[{"href":"Xml.html#Ext-data-reader-Xml","filename":"Xml.js"}]}); \ No newline at end of file