X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/source/XmlStore.html diff --git a/docs/source/XmlStore.html b/docs/source/XmlStore.html index 29b6dd53..3d4f3480 100644 --- a/docs/source/XmlStore.html +++ b/docs/source/XmlStore.html @@ -1,78 +1,102 @@ - - - The source code - - - - - 
/**
- * @class Ext.data.XmlStore
- * @extends Ext.data.Store
- * 
Small helper class to make creating {@link Ext.data.Store}s from XML data easier.
- * A XmlStore will be automatically configured with a {@link Ext.data.XmlReader}.

- * 
A store configuration would be something like:

-var store = new Ext.data.XmlStore({
-    // store configs
-    autoDestroy: true,
-    storeId: 'myStore',
-    url: 'sheldon.xml', // automatically configures a HttpProxy
-    // reader configs
-    record: 'Item', // records will have an "Item" tag
-    idPath: 'ASIN',
-    totalRecords: '@TotalResults'
-    fields: [
-        // set up the fields mapping into the xml doc
-        // The first needs mapping, the others are very basic
-        {name: 'Author', mapping: 'ItemAttributes > Author'},
-        'Title', 'Manufacturer', 'ProductGroup'
-    ]
-});
- * 

- * 
This store is configured to consume a returned object of the form:

-<?xml version="1.0" encoding="UTF-8"?>
-<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
-    <Items>
-        <Request>
-            <IsValid>True</IsValid>
-            <ItemSearchRequest>
-                <Author>Sidney Sheldon</Author>
-                <SearchIndex>Books</SearchIndex>
-            </ItemSearchRequest>
-        </Request>
-        <TotalResults>203</TotalResults>
-        <TotalPages>21</TotalPages>
-        <Item>
-            <ASIN>0446355453</ASIN>
-            <DetailPageURL>
-                http://www.amazon.com/
-            </DetailPageURL>
-            <ItemAttributes>
-                <Author>Sidney Sheldon</Author>
-                <Manufacturer>Warner Books</Manufacturer>
-                <ProductGroup>Book</ProductGroup>
-                <Title>Master of the Game</Title>
-            </ItemAttributes>
-        </Item>
-    </Items>
-</ItemSearchResponse>
- * 

- * An object literal of this form could also be used as the {@link #data} config option.

- * 
Note: Although not listed here, this class accepts all of the configuration options of 
- * {@link Ext.data.XmlReader XmlReader}.

- * @constructor
- * @param {Object} config
- * @xtype xmlstore
- */
-Ext.data.XmlStore = Ext.extend(Ext.data.Store, {
-    
/**
-     * @cfg {Ext.data.DataReader} reader @hide
-     */
-    constructor: function(config){
-        Ext.data.XmlStore.superclass.constructor.call(this, Ext.apply(config, {
-            reader: new Ext.data.XmlReader(config)
-        }));
-    }
-});
-Ext.reg('xmlstore', Ext.data.XmlStore);
- - \ No newline at end of file + + + + + The source code + + + + + + + 
/**
+ * @author Ed Spencer
+ * @class Ext.data.XmlStore
+ * @extends Ext.data.Store
+ * @private
+ * @ignore
+ * <p>Small helper class to make creating {@link Ext.data.Store}s from XML data easier.
+ * A XmlStore will be automatically configured with a {@link Ext.data.reader.Xml}.</p>
+ * <p>A store configuration would be something like:<pre><code>
+var store = new Ext.data.XmlStore({
+    // store configs
+    autoDestroy: true,
+    storeId: 'myStore',
+    url: 'sheldon.xml', // automatically configures a HttpProxy
+    // reader configs
+    record: 'Item', // records will have an "Item" tag
+    idPath: 'ASIN',
+    totalRecords: '@TotalResults'
+    fields: [
+        // set up the fields mapping into the xml doc
+        // The first needs mapping, the others are very basic
+        {name: 'Author', mapping: 'ItemAttributes > Author'},
+        'Title', 'Manufacturer', 'ProductGroup'
+    ]
+});
+ * </code></pre></p>
+ * <p>This store is configured to consume a returned object of the form:<pre><code>
+&#60?xml version="1.0" encoding="UTF-8"?>
+&#60ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
+    &#60Items>
+        &#60Request>
+            &#60IsValid>True&#60/IsValid>
+            &#60ItemSearchRequest>
+                &#60Author>Sidney Sheldon&#60/Author>
+                &#60SearchIndex>Books&#60/SearchIndex>
+            &#60/ItemSearchRequest>
+        &#60/Request>
+        &#60TotalResults>203&#60/TotalResults>
+        &#60TotalPages>21&#60/TotalPages>
+        &#60Item>
+            &#60ASIN>0446355453&#60/ASIN>
+            &#60DetailPageURL>
+                http://www.amazon.com/
+            &#60/DetailPageURL>
+            &#60ItemAttributes>
+                &#60Author>Sidney Sheldon&#60/Author>
+                &#60Manufacturer>Warner Books&#60/Manufacturer>
+                &#60ProductGroup>Book&#60/ProductGroup>
+                &#60Title>Master of the Game&#60/Title>
+            &#60/ItemAttributes>
+        &#60/Item>
+    &#60/Items>
+&#60/ItemSearchResponse>
+ * </code></pre>
+ * An object literal of this form could also be used as the {@link #data} config option.</p>
+ * <p><b>Note:</b> Although not listed here, this class accepts all of the configuration options of
+ * <b>{@link Ext.data.reader.Xml XmlReader}</b>.</p>
+ * @xtype xmlstore
+ */
+Ext.define('Ext.data.XmlStore', {
+    extend: 'Ext.data.Store',
+    alternateClassName: 'Ext.data.XmlStore',
+    alias: 'store.xml',
+
+    /**
+     * @cfg {Ext.data.DataReader} reader @hide
+     */
+    constructor: function(config){
+        config = config || {};
+        config = config || {};
+
+        Ext.applyIf(config, {
+            proxy: {
+                type: 'ajax',
+                reader: 'xml',
+                writer: 'xml'
+            }
+        });
+
+        this.callParent([config]);
+    }
+});
+
+ +