another refinement of the queryupdater - googlemap - queryupdater trio consistency
authorThierry Parmentelat <thierry.parmentelat@inria.fr>
Fri, 13 Dec 2013 09:33:33 +0000 (10:33 +0100)
committerThierry Parmentelat <thierry.parmentelat@inria.fr>
Fri, 13 Dec 2013 09:33:33 +0000 (10:33 +0100)
this time we do not use flat_id anymore, and suggest to always use selectors like
$(“[my_id=‘some!text:with+any*char’]”)
rather than
$(“#some_id”)
because the latter is very restrictive on the character set and does not accept quoting - at least I haven’t found any

manifold/static/js/plugin.js
plugins/querytable/static/js/querytable.js

index ce5be64..41d8e8b 100644 (file)
@@ -192,21 +192,21 @@ var Plugin = Class.extend({
         return key_field + manifold.separator + this.escape_id(value).replace(/\\/g, '');
     },
 
-    // we do not need to carry around all the nonsense about backslashing dots in hrns
-    // likewise, DOM ids do not like to have dots in them
-    // because "#foo.bar" matches an elem named foo with class bar - not an id that is foo.bar
-    // so this method gives you a valid DOMID but that cannot be 'reversed' back to retrieve an hrn or the like
-    // e.g. 
-    // input=input="ple.aluiple.host147-82-static\\.93-94-b\\.business\\.telecomitalia\\.it"
-    // > "ple.aluiple.host147-82-static\.93-94-b\.business\.telecomitalia\.it"
-    // flat_id(input)
-    // "ple-aluiple-host147-82-static-93-94-b-business-telecomitalia-it"
-    // input="urn:publicid:IDN+ple:nicta+node+planetlab2-research-nicta-com-au"
-    // flat_id(input)
-    // urn-publicid-IDN-ple-nicta-node-planetlab2-research-nicta-com-au
-    flat_id : function (id_in) {
-       return id_in.replace(/\\\./g,"-").replace(/\\/g,"-").replace(/\./g,"-").replace(/:/g,'-').replace(/\+/g,'-');
-    },
+    // NOTE
+    // at some point in time we used to have a helper function named 'flat_id' here
+    // the goals was to sort of normalize id's but it turned out we can get rid of that
+    // in a nutshell, we would have an id (can be urn, hrn, whatever) and 
+    // we want to be able to retrieve a DOM element based on that (e.g. a checkbox)
+    // so we did something like <tag id="some-id-that-comes-from-the-db">
+    // and then $("#some-id-that-comes-from-the-db")
+    // however the syntax for that selector prevents from using some characters in id
+    // and so for some of our ids this won't work
+    // instead of 'flattening' we now do this instead
+    // <tag some_id="then!we:can+use.what$we!want">
+    // and to retrieve it
+    // $("[some_id='then!we:can+use.what$we!want']")
+    // which thanks to the quotes, works; and you can use this with id as well in fact
+    // of course if now we have quotes in the id it's going to squeak, but well..
 
     // escape (read: backslashes) some meta-chars in input
     escape_id: function(id) {
index 410a082..935c087 100644 (file)
         }, // getColIndex
 
        // create a checkbox <input> tag
-       // computes 'id' attribute from canonical_key (using flat_id)
+       // computes 'id' attribute from canonical_key
        // computes 'init_id' from init_key for initialization phase
+       // no need to used convoluted ids with plugin-uuid or others, since
+       // we search using table.$ which looks only in this table
         checkbox_html : function (record) {
             var result="";
             // Prefix id with plugin_uuid
             result += " class='querytable-checkbox'";
         // compute id from canonical_key
            var id = record[this.canonical_key]
-           // normalize using flat_id - see plugin.js
-           id = this.flat_id(id)
 //         if (debug) messages.debug("checkbox_html, id="+id);
-            result += " id='" + id + "'";
-        // compute init_id too
+        // compute init_id form init_key
            var init_id=record[this.init_key];
-           init_id=this.flat_id(init_id);
-        // wrap up
+        // set id - for retrieving from an id, or for posting events upon user's clicks
+           result += " id='"+record[this.canonical_key]+"'";
+        // set init_id
            result += "init_id='" + init_id + "'";
-           // set value for posting events upon user's clicks
-           result += " value='"+record[this.canonical_key]+"'";
+        // wrap up
             result += " type='checkbox'";
             result += " autocomplete='off'";
             result += "></input>";
        // (because the argument record, if it comes from query, might not have canonical_key set
        set_checkbox_from_record: function (record, checked) {
             if (checked === undefined) checked = true;
-           var init_id = this.flat_id(record[this.init_key]);
+           var init_id = record[this.init_key];
            if (debug) messages.debug("set_checkbox_from_record, init_id="+init_id);
+           // using table.$ to search inside elements that are not visible
            var element = this.table.$('[init_id="'+init_id+'"]');
            element.attr('checked',checked);
        },
        // id relates to canonical_key
        set_checkbox_from_data: function (id, checked) {
             if (checked === undefined) checked = true;
-           var id=this.flat_id(id);
            if (debug) messages.debug("set_checkbox_from_data, id="+id);
-           var element = this.table.$('#'+id);
+           // using table.$ to search inside elements that are not visible
+           var element = this.table.$("[id='"+id+"']");
            element.attr('checked',checked);
        },
 
             e.stopPropagation();
 
             var self = e.data;
+           var id=this.id;
 
-            // XXX this.value = key of object to be added... what about multiple keys ?
-           if (debug) messages.debug("querytable click handler checked=" + this.checked + " "+this.canonical_key+"=" + this.value);
-            manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, this.value);
+            // this.id = key of object to be added... what about multiple keys ?
+           if (debug) messages.debug("querytable._check_click key="+this.canonical_key+"->"+id+" checked="+this.checked);
+            manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, id);
             //return false; // prevent checkbox to be checked, waiting response from manifold plugin api
             
         },