Move actual widgets out of mkws-core.js into their own file mkws-widgets.js
authorMike Taylor <mike@indexdata.com>
Wed, 26 Mar 2014 10:37:52 +0000 (10:37 +0000)
committerMike Taylor <mike@indexdata.com>
Wed, 26 Mar 2014 10:37:52 +0000 (10:37 +0000)
src/Makefile
src/mkws-core.js
src/mkws-widgets.js [new file with mode: 0644]

index 8586a3c..ac8ef68 100644 (file)
@@ -9,7 +9,7 @@ HANDLEBARS_URL= http://builds.handlebarsjs.com.s3.amazonaws.com/handlebars-v1.1.
 PP2_URL=       http://git.indexdata.com/?p=pazpar2.git;a=blob_plain;f=js/pz2.js;hb=HEAD
 VERSION = $(shell tr -d '\012' < VERSION)
 
-COMPONENTS = mkws-core.js mkws-handlebars.js
+COMPONENTS = mkws-core.js mkws-widgets.js mkws-handlebars.js 
 
 JQUERY_FILE := $(shell basename ${JQUERY_URL})
 JQUERY_JSON_FILE := $(shell basename ${JQUERY_JSON_URL})
index 3ed81a3..8a8b9cb 100644 (file)
@@ -83,286 +83,6 @@ if (mkws_config == null || typeof mkws_config != 'object') {
 }
 
 
-// Factory function for widget objects.
-function widget($, team, type, node) {
-    var that = {
-       team: team,
-       type: type,
-       node: node
-    };
-
-    var M = mkws.M;
-
-    var type2fn = {
-       Targets: promoteTargets,
-       Stat: promoteStat,
-       Termlists: promoteTermlists,
-       Pager: promotePager,
-       Records: promoteRecords,
-       Navi: promoteNavi,
-       Sort: promoteSort,
-       Perpage: promotePerpage
-    };
-
-    var promote = type2fn[type];
-    if (promote) {
-       promote();
-       log("made " + type + " widget(node=" + node + ")");
-    } else {
-       log("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
-    }
-
-    return that;
-
-
-    function log(s) {
-       team.log(s);
-    }
-
-    // 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.
-
-    function promoteTargets() {
-       team.queue("targets").subscribe(function(data) {
-           var table ='<table><thead><tr>' +
-               '<td>' + M('Target ID') + '</td>' +
-               '<td>' + M('Hits') + '</td>' +
-               '<td>' + M('Diags') + '</td>' +
-               '<td>' + M('Records') + '</td>' +
-               '<td>' + M('State') + '</td>' +
-               '</tr></thead><tbody>';
-
-           for (var i = 0; i < data.length; i++) {
-               table += "<tr><td>" + data[i].id +
-                   "</td><td>" + data[i].hits +
-                   "</td><td>" + data[i].diagnostic +
-                   "</td><td>" + data[i].records +
-                   "</td><td>" + data[i].state + "</td></tr>";
-           }
-           
-           table += '</tbody></table>';
-           var subnode = $(node).children('.mkwsBytarget');
-           subnode.html(table);
-       });
-    }
-
-
-    function promoteStat() {
-       team.queue("stat").subscribe(function(data) {
-           if (node.length === 0)  alert("huh?!");
-
-           $(node).html('<span class="head">' + M('Status info') + '</span>' +
-               ' -- ' +
-               '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
-               ' -- ' +
-               '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
-       });
-    }
-
-
-    function promoteTermlists() {
-       team.queue("termlists").subscribe(function(data) {
-           if (!node) {
-               alert("termlists event when there are no termlists");
-               return;
-           }
-
-           // no facets: this should never happen
-           if (!mkws_config.facets || mkws_config.facets.length == 0) {
-               alert("onTerm called even though we have no facets: " + $.toJSON(data));
-               $(node).hide();
-               return;
-           }
-
-           // display if we first got results
-           $(node).show();
-
-           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") {
-                   addSingleFacet(acc, "Sources",  data.xtargets, 16, null);
-               } else if (facets[i] == "subject") {
-                   addSingleFacet(acc, "Subjects", data.subject,  10, "subject");
-               } else if (facets[i] == "author") {
-                   addSingleFacet(acc, "Authors",  data.author,   10, "author");
-               } else {
-                   alert("bad facet configuration: '" + facets[i] + "'");
-               }
-           }
-
-           $(node).html(acc.join(''));
-
-           function addSingleFacet(acc, caption, data, max, pzIndex) {
-               acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
-               acc.push('<div class="termtitle">' + M(caption) + '</div>');
-               for (var i = 0; i < data.length && i < max; i++) {
-                   acc.push('<div class="term">');
-                   acc.push('<a href="#" ');
-                   var action = '';
-                   if (!pzIndex) {
-                       // Special case: target selection
-                       acc.push('target_id='+data[i].id+' ');
-                       if (!team.targetFiltered(data[i].id)) {
-                           action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
-                       }
-                   } else {
-                       action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
-                   }
-                   acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
-                            + ' <span>' + data[i].freq + '</span>');
-                   acc.push('</div>');
-               }
-               acc.push('</div>');
-           }
-       });
-    }
-
-
-    function promotePager() {
-       team.queue("pager").subscribe(function(data) {
-           $(node).html(drawPager(data))
-
-           function drawPager(data) {
-               var s = '<div style="float: right">' + M('Displaying') + ': '
-                   + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
-                   ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
-                   + data.total + ')</div>';
-
-               //client indexes pages from 1 but pz2 from 0
-               var onsides = 6;
-               var pages = Math.ceil(team.totalRecordCount() / team.perpage());
-               var currentPage = team.currentPage();
-
-               var firstClkbl = (currentPage - onsides > 0)
-                   ? currentPage - onsides
-                   : 1;
-
-               var lastClkbl = firstClkbl + 2*onsides < pages
-                   ? firstClkbl + 2*onsides
-                   : pages;
-
-               var prev = '<span class="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
-               if (currentPage > 1)
-                   prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
-                   +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
-
-               var middle = '';
-               for(var i = firstClkbl; i <= lastClkbl; i++) {
-                   var numLabel = i;
-                   if(i == currentPage)
-                       numLabel = '<b>' + i + '</b>';
-
-                   middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
-                       + numLabel + ' </a>';
-               }
-
-               var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
-               if (pages - currentPage > 0)
-                   next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
-                   + M('Next') + ' &#62;&#62;</a>';
-
-               var predots = '';
-               if (firstClkbl > 1)
-                   predots = '...';
-
-               var postdots = '';
-               if (lastClkbl < pages)
-                   postdots = '...';
-
-               s += '<div style="float: clear">'
-                   + prev + predots + middle + postdots + next + '</div>';
-
-               return s;
-           }
-       });
-    }                       
-
-
-    function promoteRecords() {
-       team.queue("records").subscribe(function(data) {
-           var html = [];
-           for (var i = 0; i < data.hits.length; i++) {
-               var hit = data.hits[i];
-               var divId = team.recordElementId(hit.recid[0]);
-               html.push('<div class="record mkwsTeam_' + team.name() + ' ' + divId + '">', renderSummary(hit), '</div>');
-               // ### At some point, we may be able to move the
-               // m_currentRecordId and m_currentRecordData members
-               // from the team object into this widget.
-               if (hit.recid == team.currentRecordId()) {
-                   if (team.currentRecordData())
-                       html.push(team.renderDetails(team.currentRecordData()));
-               }
-           }
-           $(node).html(html.join(''));
-
-           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);
-           }
-       });
-    }
-
-
-    function promoteNavi() {
-       team.queue("navi").subscribe(function() {
-           var filters = team.filters();
-           var text = "";
-
-           for (var i in filters) {
-               if (text) {
-                   text += " | ";
-               }
-               var filter = filters[i];
-               if (filter.id) {
-                   text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + team.name() +
-                       "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
-               } else {
-                   text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + team.name() +
-                       "', '" + filter.field + "', '" + filter.value + "'" +
-                       ');return false;">' + filter.value + '</a>';
-               }
-           }
-
-           $(node).html(text);
-       });
-    }
-
-
-    function promoteSort() {
-       // It seems this and the Perpage widget doen't need to
-       // subscribe to anything, since they produce events rather
-       // than consuming them.
-       $(node).change(function () {
-           team.set_sortOrder($(node).val());
-           if (team.submitted()) {
-               team.resetPage();
-               team.reShow();
-           }
-           return false;
-       });
-    }
-
-
-    function promotePerpage() {
-       $(node).change(function() {
-           team.set_perpage($(node).val());
-           if (team.submitted()) {
-               team.resetPage();
-               team.reShow();
-           }
-           return false;
-       });
-    }
-}
-
-
 // Factory function for team objects. As much as possible, this uses
 // only member variables (prefixed "m_") and inner functions with
 // private scope. Some functions are visibl as member-functions to be
diff --git a/src/mkws-widgets.js b/src/mkws-widgets.js
new file mode 100644 (file)
index 0000000..ff6bba1
--- /dev/null
@@ -0,0 +1,278 @@
+// Factory function for widget objects.
+function widget($, team, type, node) {
+    var that = {
+       team: team,
+       type: type,
+       node: node
+    };
+
+    var M = mkws.M;
+
+    var type2fn = {
+       Targets: promoteTargets,
+       Stat: promoteStat,
+       Termlists: promoteTermlists,
+       Pager: promotePager,
+       Records: promoteRecords,
+       Navi: promoteNavi,
+       Sort: promoteSort,
+       Perpage: promotePerpage
+    };
+
+    var promote = type2fn[type];
+    if (promote) {
+       promote();
+       log("made " + type + " widget(node=" + node + ")");
+    } else {
+       log("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
+    }
+
+    return that;
+
+
+    function log(s) {
+       team.log(s);
+    }
+
+    // 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.
+
+    function promoteTargets() {
+       team.queue("targets").subscribe(function(data) {
+           var table ='<table><thead><tr>' +
+               '<td>' + M('Target ID') + '</td>' +
+               '<td>' + M('Hits') + '</td>' +
+               '<td>' + M('Diags') + '</td>' +
+               '<td>' + M('Records') + '</td>' +
+               '<td>' + M('State') + '</td>' +
+               '</tr></thead><tbody>';
+
+           for (var i = 0; i < data.length; i++) {
+               table += "<tr><td>" + data[i].id +
+                   "</td><td>" + data[i].hits +
+                   "</td><td>" + data[i].diagnostic +
+                   "</td><td>" + data[i].records +
+                   "</td><td>" + data[i].state + "</td></tr>";
+           }
+           
+           table += '</tbody></table>';
+           var subnode = $(node).children('.mkwsBytarget');
+           subnode.html(table);
+       });
+    }
+
+
+    function promoteStat() {
+       team.queue("stat").subscribe(function(data) {
+           if (node.length === 0)  alert("huh?!");
+
+           $(node).html('<span class="head">' + M('Status info') + '</span>' +
+               ' -- ' +
+               '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
+               ' -- ' +
+               '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
+       });
+    }
+
+
+    function promoteTermlists() {
+       team.queue("termlists").subscribe(function(data) {
+           if (!node) {
+               alert("termlists event when there are no termlists");
+               return;
+           }
+
+           // no facets: this should never happen
+           if (!mkws_config.facets || mkws_config.facets.length == 0) {
+               alert("onTerm called even though we have no facets: " + $.toJSON(data));
+               $(node).hide();
+               return;
+           }
+
+           // display if we first got results
+           $(node).show();
+
+           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") {
+                   addSingleFacet(acc, "Sources",  data.xtargets, 16, null);
+               } else if (facets[i] == "subject") {
+                   addSingleFacet(acc, "Subjects", data.subject,  10, "subject");
+               } else if (facets[i] == "author") {
+                   addSingleFacet(acc, "Authors",  data.author,   10, "author");
+               } else {
+                   alert("bad facet configuration: '" + facets[i] + "'");
+               }
+           }
+
+           $(node).html(acc.join(''));
+
+           function addSingleFacet(acc, caption, data, max, pzIndex) {
+               acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
+               acc.push('<div class="termtitle">' + M(caption) + '</div>');
+               for (var i = 0; i < data.length && i < max; i++) {
+                   acc.push('<div class="term">');
+                   acc.push('<a href="#" ');
+                   var action = '';
+                   if (!pzIndex) {
+                       // Special case: target selection
+                       acc.push('target_id='+data[i].id+' ');
+                       if (!team.targetFiltered(data[i].id)) {
+                           action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
+                       }
+                   } else {
+                       action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
+                   }
+                   acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
+                            + ' <span>' + data[i].freq + '</span>');
+                   acc.push('</div>');
+               }
+               acc.push('</div>');
+           }
+       });
+    }
+
+
+    function promotePager() {
+       team.queue("pager").subscribe(function(data) {
+           $(node).html(drawPager(data))
+
+           function drawPager(data) {
+               var s = '<div style="float: right">' + M('Displaying') + ': '
+                   + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
+                   ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
+                   + data.total + ')</div>';
+
+               //client indexes pages from 1 but pz2 from 0
+               var onsides = 6;
+               var pages = Math.ceil(team.totalRecordCount() / team.perpage());
+               var currentPage = team.currentPage();
+
+               var firstClkbl = (currentPage - onsides > 0)
+                   ? currentPage - onsides
+                   : 1;
+
+               var lastClkbl = firstClkbl + 2*onsides < pages
+                   ? firstClkbl + 2*onsides
+                   : pages;
+
+               var prev = '<span class="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
+               if (currentPage > 1)
+                   prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
+                   +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
+
+               var middle = '';
+               for(var i = firstClkbl; i <= lastClkbl; i++) {
+                   var numLabel = i;
+                   if(i == currentPage)
+                       numLabel = '<b>' + i + '</b>';
+
+                   middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
+                       + numLabel + ' </a>';
+               }
+
+               var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
+               if (pages - currentPage > 0)
+                   next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
+                   + M('Next') + ' &#62;&#62;</a>';
+
+               var predots = '';
+               if (firstClkbl > 1)
+                   predots = '...';
+
+               var postdots = '';
+               if (lastClkbl < pages)
+                   postdots = '...';
+
+               s += '<div style="float: clear">'
+                   + prev + predots + middle + postdots + next + '</div>';
+
+               return s;
+           }
+       });
+    }                       
+
+
+    function promoteRecords() {
+       team.queue("records").subscribe(function(data) {
+           var html = [];
+           for (var i = 0; i < data.hits.length; i++) {
+               var hit = data.hits[i];
+               var divId = team.recordElementId(hit.recid[0]);
+               html.push('<div class="record mkwsTeam_' + team.name() + ' ' + divId + '">', renderSummary(hit), '</div>');
+               // ### At some point, we may be able to move the
+               // m_currentRecordId and m_currentRecordData members
+               // from the team object into this widget.
+               if (hit.recid == team.currentRecordId()) {
+                   if (team.currentRecordData())
+                       html.push(team.renderDetails(team.currentRecordData()));
+               }
+           }
+           $(node).html(html.join(''));
+
+           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);
+           }
+       });
+    }
+
+
+    function promoteNavi() {
+       team.queue("navi").subscribe(function() {
+           var filters = team.filters();
+           var text = "";
+
+           for (var i in filters) {
+               if (text) {
+                   text += " | ";
+               }
+               var filter = filters[i];
+               if (filter.id) {
+                   text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + team.name() +
+                       "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
+               } else {
+                   text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + team.name() +
+                       "', '" + filter.field + "', '" + filter.value + "'" +
+                       ');return false;">' + filter.value + '</a>';
+               }
+           }
+
+           $(node).html(text);
+       });
+    }
+
+
+    function promoteSort() {
+       // It seems this and the Perpage widget doen't need to
+       // subscribe to anything, since they produce events rather
+       // than consuming them.
+       $(node).change(function () {
+           team.set_sortOrder($(node).val());
+           if (team.submitted()) {
+               team.resetPage();
+               team.reShow();
+           }
+           return false;
+       });
+    }
+
+
+    function promotePerpage() {
+       $(node).change(function() {
+           team.set_perpage($(node).val());
+           if (team.submitted()) {
+               team.resetPage();
+               team.reShow();
+           }
+           return false;
+       });
+    }
+}