Autosearch works again for mkwsTermlists.
[mkws-moved-to-github.git] / src / mkws-widgets.js
index 2154f5a..1c37ab7 100644 (file)
@@ -1,9 +1,16 @@
 // Factory function for widget objects.
 function widget($, team, type, node) {
+    // Static register of attributes that do not contribute to config
+    var ignoreAttrs = {
+       id:1, 'class':1, style:1, name:1, action:1, type:1, size:1,
+       value:1, width:1, valign:1
+    };
+
     var that = {
        team: team,
        type: type,
-       node: node
+       node: node,
+       config: Object.create(team.config())
     };
 
     function log(s) {
@@ -13,6 +20,31 @@ function widget($, team, type, node) {
 
     that.toString = function() {
        return '[Widget ' + team.name() + ':' + type + ']';
+    };
+
+    for (var i = 0; i < node.attributes.length; i++) {
+       var a = node.attributes[i];
+       if (a.name === 'data-mkws-config') {
+           // Treat as a JSON fragment configuring just this widget
+           log(node + ": parsing config fragment '" + a.value + "'");
+           var data;
+           try {
+               data = $.parseJSON(a.value);
+               for (var key in data) {
+                   log(node + ": adding config element " + key + "='" + data[key] + "'");
+                   that.config[key] = data[key];
+               }
+           } catch (err) {
+               alert("Can't parse " + node + " data-mkws-config as JSON: " + a.value);
+           }
+       } else if (a.name.match (/^data-mkws-/)) {
+           var name = a.name.replace(/^data-mkws-/, '')
+           that.config[name] = a.value;
+           log(node + ": set data-mkws attribute " + name + "='" + a.value + "'");
+       } else if (!ignoreAttrs[a.name]) {
+           that.config[a.name] = a.value;
+           log(node + ": set regular attribute " + a.name + "='" + a.value + "'");
+       }
     }
 
     var fn = mkws.promotionFunction(type);
@@ -20,18 +52,60 @@ function widget($, team, type, node) {
        fn.call(that);
        log("made " + type + " widget(node=" + node + ")");
     } else {
-       log("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
+       log("made UNPROMOTED widget(type=" + type + ", node=" + node + ")");
     }
 
     return that;
 }
 
 
+// Utility function for use by all widgets that can invoke autosearch.
+widget.maybeAutosearch = function(widget) {
+    var query = widget.config.autosearch;
+    if (query) {
+       if (query.match(/^!param!/)) {
+           var param = query.replace(/^!param!/, '');
+           query = mkws.getParameterByName(param);
+           widget.log("obtained query '" + query + "' from param '" + param + "'");
+           if (!query) {
+               alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
+           }
+       } else if (query.match(/^!path!/)) {
+           var index = query.replace(/^!path!/, '');
+           var path = window.location.pathname.split('/');
+           query = path[path.length - index];
+           widget.log("obtained query '" + query + "' from path-component '" + index + "'");
+           if (!query) {
+               alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
+           }
+       }
+
+       widget.team.queue("ready").subscribe(function() {
+           var sortOrder = widget.config.sort;
+           var perpage = widget.config.perpage;
+           var limit = widget.config.limit;
+           var targets = widget.config.targets;
+           var targetfilter = widget.config.targetfilter;
+           var s = "running auto search: '" + query + "'";
+           if (sortOrder) s += " sorted by '" + sortOrder + "'";
+           if (perpage) s += " with " + perpage + " per page";
+           if (limit) s += " limited by '" + limit + "'";
+           if (targets) s += " in targets '" + targets + "'";
+           if (targetfilter) s += " constrained by targetfilter '" + targetfilter + "'";
+           widget.log(s);
+
+           widget.team.newSearch(query, sortOrder, perpage, limit, targets, targetfilter);
+       });
+    }
+};
+
+
 // Functions follow for promoting the regular widget object into
-// widgets of specific types. These could be moved outside of the
-// widget object, or even into their own source files.
+// widgets of specific types. These could be moved into their own
+// source files.
 
-function promoteToTargets() {
+
+mkws.registerWidgetType('Targets', function() {
     var that = this;
     var M = mkws.M;
 
@@ -56,10 +130,10 @@ function promoteToTargets() {
        var subnode = $(that.node).children('.mkwsBytarget');
        subnode.html(table);
     });
-}
+});
 
 
-function promoteToStat() {
+mkws.registerWidgetType('Stat', function() {
     var that = this;
     var M = mkws.M;
 
@@ -72,10 +146,10 @@ function promoteToStat() {
            ' -- ' +
            '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
     });
-}
+});
 
 
-function promoteToTermlists() {
+mkws.registerWidgetType('Termlists', function() {
     var that = this;
     var M = mkws.M;
 
@@ -86,7 +160,8 @@ function promoteToTermlists() {
        }
 
        // no facets: this should never happen
-       if (!mkws_config.facets || mkws_config.facets.length == 0) {
+       var facets = that.config.facets;
+       if (!facets || facets.length == 0) {
            alert("onTerm called even though we have no facets: " + $.toJSON(data));
            $(that.node).hide();
            return;
@@ -97,7 +172,6 @@ function promoteToTermlists() {
 
        var acc = [];
        acc.push('<div class="title">' + M('Termlists') + '</div>');
-       var facets = mkws_config.facets;
 
        for (var i = 0; i < facets.length; i++) {
            if (facets[i] == "xtargets") {
@@ -137,10 +211,12 @@ function promoteToTermlists() {
            acc.push('</div>');
        }
     });
-}
 
+    widget.maybeAutosearch(that);
+});
 
-function promoteToPager() {
+
+mkws.registerWidgetType('Pager', function() {
     var that = this;
     var M = mkws.M;
 
@@ -201,10 +277,10 @@ function promoteToPager() {
            return s;
        }
     });
-}                           
+});
 
 
-function promoteToRecords() {
+mkws.registerWidgetType('Records', function() {
     var that = this;
     var team = this.team;
 
@@ -224,18 +300,19 @@ function promoteToRecords() {
        }
        $(that.node).html(html.join(''));
 
-       function renderSummary(hit)
-       {
+       function renderSummary(hit) {
            var template = team.loadTemplate("Summary");
            hit._id = team.recordElementId(hit.recid[0]);
            hit._onclick = "mkws.showDetails('" + team.name() + "', '" + hit.recid[0] + "');return false;"
            return template(hit);
        }
     });
-}
 
+    widget.maybeAutosearch(that);
+});
 
-function promoteToNavi() {
+
+mkws.registerWidgetType('Navi', function() {
     var that = this;
     var teamName = this.team.name();
     var M = mkws.M;
@@ -261,42 +338,35 @@ function promoteToNavi() {
 
        $(that.node).html(text);
     });
-}
+});
 
 
-function promoteToSort() {
-    // It seems this and the Perpage widget doen't need to
-    // subscribe to anything, since they produce events rather
-    // than consuming them.
-    $(this.node).change(function () {
-       this.team.set_sortOrder($(node).val());
-       if (this.team.submitted()) {
-           this.team.resetPage();
-           this.team.reShow();
+// It seems this and the Perpage widget doen't need to subscribe to
+// anything, since they produce events rather than consuming them.
+//
+mkws.registerWidgetType('Sort', function() {
+    var that = this;
+
+    $(this.node).change(function() {
+       that.team.set_sortOrder($(that.node).val());
+       if (that.team.submitted()) {
+           that.team.resetPage();
+           that.team.reShow();
        }
        return false;
     });
-}
+});
 
 
-function promoteToPerpage() {
+mkws.registerWidgetType('Perpage', function() {
+    var that = this;
+
     $(this.node).change(function() {
-       this.team.set_perpage($(node).val());
-       if (this.team.submitted()) {
-           this.team.resetPage();
-           this.team.reShow();
+       that.team.set_perpage($(that.node).val());
+       if (that.team.submitted()) {
+           that.team.resetPage();
+           that.team.reShow();
        }
        return false;
     });
-}
-
-mkws.registerWidgetType('Targets', promoteToTargets);
-mkws.registerWidgetType('Stat', promoteToStat);
-mkws.registerWidgetType('Termlists', promoteToTermlists);
-mkws.registerWidgetType('Pager', promoteToPager);
-mkws.registerWidgetType('Records', promoteToRecords);
-mkws.registerWidgetType('Navi', promoteToNavi);
-mkws.registerWidgetType('Sort', promoteToSort);
-mkws.registerWidgetType('Perpage', promoteToPerpage);
-
-
+});