[Commits] r1394 - core/trunk/geoext/lib/GeoExt/adapter

[commits at geoext.org]

Author: tschaub
Date: 2009-10-08 20:44:19 +0200 (Thu, 08 Oct 2009)
New Revision: 1394

Added:
   core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.jst
Modified:
   core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.js
Log:
Adding docs for override-ext-ajax.js.  The api labeled comment triggers template parsing.  If there is a (.jst) template with the same as the file, the template is parsed.  In this case, we don't do any substitution based on things defined in the source file.  The toc entry will come in a docsrc change  (see #97).

Modified: core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.js	2009-10-08 18:09:30 UTC (rev 1393)
+++ core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.js	2009-10-08 18:44:19 UTC (rev 1394)
@@ -6,10 +6,7 @@
  * of the license.
  */
 
-/** api: (define)
- *  module = Ext.lib.Ajax
- */
-
+/** api: override = Ext.Ajax */
 (function() {
 
     /** private: function[createComplete]

Added: core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.jst
===================================================================
--- core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.jst	                        (rev 0)
+++ core/trunk/geoext/lib/GeoExt/adapter/override-ext-ajax.jst	2009-10-08 18:44:19 UTC (rev 1394)
@@ -0,0 +1,42 @@
+.. _overrides.ext.ajax:
+
+Ext.Ajax Overrides
+==================
+
+GeoExt provides an override for the functionality in
+`Ext.Ajax <http://extjs.com/deploy/dev/docs/?class=Ext.Ajax>`_.  If you include
+the :file:`override-ext-ajax.js` file in your build, any calls to ``Ext.Ajax``
+methods will be routed through ``OpenLayers.Request`` methods.  The practical
+implication of this is that you can set the ``OpenLayers.ProxyHost`` property
+in your application and have this proxy used by Ext components that call
+``Ext.Ajax`` methods.
+
+To include :file:`override-ext-ajax.js` in your build, the GeoExt section in
+your build config should look like one of the following:
+
+.. code-block:: ini
+
+    # include everything (including override-ext-ajax.js)
+    [GeoExt.js]
+    root = ../lib
+    license = geoext-license.js
+    exclude =
+        GeoExt.js
+        GeoExt/SingleFile.js
+
+
+or
+
+.. code-block:: ini
+
+    # custom build
+    [GeoExt.js]
+    root = ../lib
+    license = geoext-license.js
+    include =
+        GeoExt/adapter/override-ext-ajax.js
+        # other files listed here ...
+    exclude =
+        GeoExt.js
+        GeoExt/SingleFile.js
+