Changeset 1950 for trunk

Timestamp:

2011-09-14 12:14:34 (8 months ago)

Author:

mpo

Message:

Allow checking for required dependencies before doing remote options-refreshes.
This avoids needless error-calls to backend-uris that don't exist.
It also fixes #278

Location:

trunk

Files:

• modules/kauri-forms/kauri-forms-framework/src/main/kauri/static-{build}.key/kauri.forms/control.js (modified) (1 diff)
• modules/kauri-forms/kauri-forms-framework/src/main/kauri/static-{build}.key/kauri.forms/field.js (modified) (3 diffs)
• samples/kauri-forms-sample/src/main/kauri/pages/selection-control.html.xml (modified) (2 diffs)

trunk/modules/kauri-forms/kauri-forms-framework/src/main/kauri/static-{build}.key/kauri.forms/control.js

@@ -1203 +1203 @@
         
         if (opts) {
-            var options = kf.Options.create(opts, this.getType());
+            var options = kf.Options.create(opts, this.getType(), this);
             if (options.toShare()) { 
                 options = this.getType().share("options", options);

trunk/modules/kauri-forms/kauri-forms-framework/src/main/kauri/static-{build}.key/kauri.forms/field.js

@@ -46 +46 @@
      * @static
      */
-    Options.create = function(config, type) {
+    Options.create = function(config, type, control) {
         var opts = new Options();
         $.extend(opts, config);
@@ -63 +63 @@
         }
         
+        //translate opt.requires into an array.
+        if (opts.requires === undefined || opts.requires === null || opts.requires === false) {
+            opts.requires = [];
+        } else if (opts.requires === true || opts.requires === "all") {
+            opts.requires = [];
+            if (control && control.depends) {
+                var depname;
+                for(depname in control.depends) {
+                    opts.requires.push(depname);
+                }
+            }
+        } 
         return opts;
     }
@@ -222 +234 @@
     Options.prototype.refresh = function() {
 
-        if (this.refreshable()) {
-            this.uriContext = this.uriContext || {};
-            var uri = this.uri.expand(this.uriContext);
-            var me = this;
-            var onSuccess = function( data, status, xhr) {
-                if (xhr && me.lastXhr === xhr) { //ignore responses that are not linked to the last request 
-                    me.parseOptions(data);
-                    me.lastXhr = null;
-                }
-            };
-            var onError = function( xhr, status, err) {
-                if (xhr && me.lastXhr === xhr) { 
-                    me.clearOptions();
-                    me.lastXhr = null;
-                }
-            };
-
-            // assign lastXhr to make sure only the return of this last one is accepted 
-            $.ajax( {
-                // take async setting from setup
-                type       : "GET",
-                cache      : false,
-                url        : uri,
-                processData: false,
-                dataType   : "json",
-                success    : onSuccess,
-                error      : onError,
-                beforeSend : function(xhr) {
-                    // setting datatype to json should be enough, unfortunately
-                    // the restlet content negotiation chokes on the resulting
-                    // accept header: application/json, text/javascript, */*
-                    // and doesn't prefer the json variant.
-                    // see issue #95
-                    xhr.setRequestHeader("Accept", "application/json");
-                    me.lastXhr = xhr;
-                }
-            });
-        }
-    };
-
+        if (! this.refreshable() ){
+            return;
+        }
+        
+        if (! this.uriContextComplete() ) {
+            return;
+        }
+        
+        var uri = this.uri.expand(this.uriContext);
+        var me = this;
+        var onSuccess = function( data, status, xhr) {
+            if (xhr && me.lastXhr === xhr) { //ignore responses that are not linked to the last request 
+                me.parseOptions(data);
+                me.lastXhr = null;
+            }
+        };
+        var onError = function( xhr, status, err) {
+            if (xhr && me.lastXhr === xhr) { 
+                me.clearOptions();
+                me.lastXhr = null;
+            }
+        };
+
+        // assign lastXhr to make sure only the return of this last one is accepted 
+        $.ajax( {
+            // take async setting from setup
+            type       : "GET",
+            cache      : false,
+            url        : uri,
+            processData: false,
+            dataType   : "json",
+            success    : onSuccess,
+            error      : onError,
+            beforeSend : function(xhr) {
+                // setting datatype to json should be enough, unfortunately
+                // the restlet content negotiation chokes on the resulting
+                // accept header: application/json, text/javascript, */*
+                // and doesn't prefer the json variant.
+                // see issue #95
+                xhr.setRequestHeader("Accept", "application/json");
+                me.lastXhr = xhr;
+            }
+        });
+    };
+
+    /**
+     * Checks if all required members in the uri-context are present.
+     */
+    Options.prototype.uriContextComplete = function() {
+        this.uriContext = this.uriContext || {};
+
+        var i = 0, last = this.requires.length;
+        for (i = 0; i<last ; i++) {
+            var requiredContext = this.uriContext[this.requires[i]] 
+            if (requiredContext === undefined || requiredContext === null) {
+                return false;
+            }
+        }
+        
+        return true;
+    }
 
     /**

trunk/samples/kauri-forms-sample/src/main/kauri/pages/selection-control.html.xml

@@ -90 +90 @@
                       "depends": {"carMake": "/carMake"},
                       "options": {
+                          "requires": "all",
                           "uri": "${publicUri('service:/data/carmake/{carMake}/models')}",
                           "valueTemplate": "{name}",
@@ -151 +152 @@
               }
           }
-      }
+      };